List app users across apps

Returns app users across all of the organization’s apps: one row per app account, so a person with two accounts in one app (two workspaces, say) has two rows. Key a row by idUser, idApp, idAppAccount and idExternalUser. resources.apps names each idApp in the page.

  • Paging: pass size (max 1000) and the previous response’s nextCursor as cursor. total is the full count.
  • Status: all statuses are returned unless status is given. Use status=active for current access.
  • Fields: all fields are returned unless fields is given. Request only what you need: a full page of every field can be too large to return (413). Sending Accept-Encoding: gzip also helps.
  • Full sync: sort by a field that does not change, so rows do not move between pages while you page: sort=originEmail:asc.
  • Filters and aggregations: same format as /users.


Example, a full sync of current access:

GET /appUsers?status=active&sort=originEmail:asc&size=1000&fields=idUser,idApp,idAppAccount,idExternalUser,email,status,lastVisitTime,licenses

  • Rate limit: 200 requests per minute

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A base64 string indicating the offset from which to start.
Pass the value of nextCursor returned from the previous call to get the next set of results

string
Defaults to score:desc

A comma-separated list of fields to sort by, with a postfix with either ':asc' or ':desc'. Fields can either be general, or custom to your organization

string

A query to search by

string

A comma-separated list of fields the query to search applies to. Fields can either be general, or custom to your organization

string
enum

The user status to filter by

Allowed:
string
enum

Only users with a license in this status

Allowed:
string

A comma-separated list of fields to return for each user. When omitted, all fields are returned. Allowed fields include the standard application-user fields and all fields from /apps/fields.

integer
≥ 1

Only users with this license. Applies only together with calculatedStatus.

integer
≥ 1

Only users of this app account

string

Filters expression — accepts either shape: (1) Flat array of filter objects, AND-combined. Each item is {key, op, value}. (2) Array of filter groups, OR-combined. Each item is {id, filters} where filters is a flat array. See *_fields_metadata for valid keys and per-filterType operators. Omit value for isSet/isNotSet/relativeDateToday/exists/notExists. Use an array value for anyOf/allOf/noneOf/isExactly. Sent on the wire as a JSON-encoded string.

string

JSON string representing aggregation configuration. Structure: '{"field":"string","aggregationType":"metric|groupBy|date_range|date_histogram","options":{"size":"integer","sort":{"field":"string","order":"desc|asc","aggFunc":"total|sum|avg|max|min"},"metricFunction":"total|sum|avg|max|min","dateHistogramOptions":{"datePeriod":"hourly|daily|weekly|monthly|quarterly|yearly","hardBounds":{"min":"string","max":"string"},"extendedBounds":{"min":"string","max":"string"},"filterEmptyBuckets":"boolean"}},"aggs":{"field":"string","aggregationType":"metric|groupBy|date_range|date_histogram","options":{"metricFunction":"total|sum|avg|max|min"}}}'. metricFunction is REQUIRED when aggregationType is "metric". For aggregationType "date_histogram", options.dateHistogramOptions is REQUIRED and datePeriod, hardBounds, extendedBounds and filterEmptyBuckets all live INSIDE it — putting them directly on options is rejected with 400 "options.dateHistogramOptions" is required. The nested "aggs" is OPTIONAL and, when present, must be a JSON OBJECT with this same structure — never a JSON-encoded string.

integer
1 to 1000
Defaults to 1000

The max amount of results to return

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json