API Docs

List users

Get a list of users for a given workspace or team.

GET
/ v1 / users

Authorization

  • X-API-Key
    string
    required

    Header with the name X-API-Key where the value is your API key.

Query parameters

  • cursor
    string

    Use if a previous request returned a cursor. Will page through results.

  • teamId
    string

    The ID of the team for which all members will be returned.

  • workspaceId
    string

    The ID of the workspace for which all members will be returned.

Response

200 - application/json - object

  • meta
    object
    required

    Contains the nextCursor, if one exists, along with the pageSize.

  • users
    array<object>
    required

    An array of user objects.