Sign in

v2

latestOpenAPI 3.0.02026-08-013312111.4 MB
Workspaces

List users in a workspace

Returns all members of the requested workspace.

This endpoint additionally supports filtering by email address, if called by a workspace administrator, integration or workspace access token. This is done by adding the following query string parameter:

  • q=user.email IN ("user1@org.com","user2@org.com")

When filtering by email, you can query up to 90 addresses at a time. Note that the query parameter values need to be URL escaped, so the final query string should be:

  • q=user.email%20IN%20(%22user1@org.com%22,%22user2@org.com%22)

Email addresses that you filter by (and only these email addresses) can be included in the response using the fields query parameter:

  • &fields=+values.user.email - add the email field to the default user response object
  • &fields=values.user.email,values.user.account_id - only return user email addresses and account IDs

Once again, all query parameter values must be URL escaped.

get/workspaces/{workspace}/members

Response

The list of users that are part of a workspace.

sizeinteger

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

pageinteger

Page number of the current results. This is an optional element that is not provided in all responses.

pageleninteger

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

nextstring uri

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

previousstring uri

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.