list

HTTP Request

GET /api/v1/organizations/:organizationName/members

Path parameters

Parameter	Type	Description
:organizationName	string	The name of the organization

Query parameters

Parameter	Type	Description
status	string	Optional. A comma separated list of statuses; if provided, will only return members of this status. Allowed values are pending, approved, rejected, left.
labels	string	Optional. A comma-separated list of labels to filter on. If multipart labels are present (e.g., school:humanities), you may provide just the prefix to include all entities labeled with that prefix. Labels are administrator-specific information. You must be an administrator of an organization, or listing datasets for your user, in order to filter on labels.
maxResults	integer	Maximum number of results to return. Defaults to 100, may not exceed 1000.
pageToken	string	Page token, returned by a previous call, to request the next page of results. If not provided, the first page will be returned

This endpoint extends the general API structure.

Authorization

You must be an administrator of the requested organization, and your access token must have the following scope:

• organization.read

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of member resources.

{
    "kind": "memberList",
    "nextPageToken": integer,
    "results": [
        object(member.list)
    ]
}

Examples

curl

curl -H "Authorization: Bearer $REDIVIS_ACCESS_TOKEN" \
"https://redivis.com/api/v1/organizations/my_organization/members?hasDataAccessToAll=test_dataset:1,other_dataset:2"