Get members who belong to an organization
List organization members. This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.
Use the
fieldsparameter to optionally define the specific member details retrieved. Iffieldsis left blank, all fields (except roles) are returned.Member roles are not sent by default. Use
fields=rolesto retrieve the roles assigned to each listed member. To use this parameter, you must include theread:organization_member_rolesscope in the token.
This endpoint supports two types of pagination:
- Offset pagination
- Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.
Checkpoint Pagination
To search by checkpoint, use the following parameters: - from: Optional id from which to start selection. - take: The total amount of entries to retrieve when using the from parameter. Defaults to 50. Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.
Autorisations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Paramètres de chemin
Organization identifier.
50Paramètres de requête
Page index of the results to return. First page is 0.
0 <= x <= 1000Number of results per page. Defaults to 50.
1 <= x <= 100Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
Optional Id from which to start selection.
Number of results per page. Defaults to 50.
1 <= x <= 100Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
^((user_id)|(email)|(picture)|(name)|(roles))(,((user_id)|(email)|(picture)|(name)|(roles)))*$Whether specified fields are to be included (true) or excluded (false).