Users
List users
Get a list of users. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.
get/v1/users
Request
- Base URL: https://demo.getcollate.io/api
- URL: https://demo.getcollate.io/api/v1/users
- Auth: HTTP bearer
Query parameters
fieldsstring
Example:profile,roles,teams,follows,owns,domains,personas,defaultPersona,personaPreferences
Fields requested in the returned resource
teamstring
Example:Legal
Filter users by team
limitinteger
Limit the number users returned. (1 to 1000000, default = 10)
beforestring
Returns list of users before this cursor
afterstring
Returns list of users after this cursor
isAdminboolean
Returns list of admin users if set to true
isBotboolean
Returns list of bot users if set to true
ownsEntityTypestring
Example:pipeline
When fields contains owns, only include owned entities of this entity type.
directOwnsOnlyboolean
When fields contains owns, only include entities directly owned by the user.
include'all' | 'deleted' | 'non-deleted'
Include all, deleted, or non-deleted entities.
Response
The user
Changes
No recorded changes to this operation across all 1 revision of this API.