Users Support

Get users list

Retrieve a list of users within a workspace.

get/support/workspaces/{workspace_id}/users

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/support/workspaces/{workspace_id}/users
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Id of the workspace to work with

Example:4

Query parameters

limitinteger

Max number of result to return

Example:10
offsetinteger

Distance from the beginning of the list of results

fieldsstring

Fields to return. Can be (id, email)

Example:id,email
sortstring nullable

Returned users from a workspaces based on this parameter, User format '(field:asc)' for ascending and '(field:desc)' for descending order.

Example:(email:asc),(id:desc)

Response

List of users

offsetinteger
limitinteger
nextstring required

URI for next page of data

Example response

{
  "users": [
    {
      "user_roles": {
        "summary": "Sample User Roles",
        "value": "{}"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.