Workspaces

Get users in workspace

Get all users inside of given workspace

get/workspaces/{workspace_id}/users

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/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

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4

Query parameters

fieldsstring

Fields to be returned in a comma-separated format may include id, name, created_at, updated_at.

Example:id,email
sortstring

Sort users by id, first_name or email

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

Fetch all users which matches given name (case sensitive)

Example:John
last_namestring

Fetch all users which matches given name (case sensitive)

Example:John
emailstring

Fetch user which matches given email

Example:john.doe@rediffmail.com
idsstring

Filter users by ids, provided as comma separated integer values

Example:1,2,3
offsetinteger

Offset from the beginning of the users list

Example:1
limitinteger

Max number of users to return

Example:10
invitedboolean

Include invited users

Example:true
project_idinteger nullable

Project ID of the workspace

Example:4

Response

List of users in a workspaces

invitesobject[] nullable
limitinteger

Max number of users to return

offsetinteger

Offset from the beginning of the users list

nextstring required

Example response

{
  "users": [
    {
      "user_roles": {
        "summary": "User Roles of the user",
        "value": "{}"
      }
    }
  ],
  "limit": 10,
  "offset": 1
}

Changes

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