Workspaces

Get workspaces

Get all workspaces

get/workspaces

Request

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

Query parameters

fieldsstring

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

Example:id,name
namestring

Fetch all workspaces which matches given name (case sensitive)

Example:My Workspace
created_atstring

Fetch all workspaces which matches given filter criterion

Example:(from:'2023-12-16T09:39:17.628Z',to:'2023-12-16T09:42:43.152Z')
updated_atstring

Fetch all workspaces which matches given filter criterion

Example:(from:'2023-12-16T09:39:17.628Z',to:'2023-12-16T09:42:43.152Z')
sortstring

Sort workspace by id or name

Example:(name:desc), (id:asc)
offsetinteger

Offset from the beginning of the workspace list

Example:1
limitinteger

Max number of workspaces to return

Example:10

Response

List of workspaces

limitinteger
offsetinteger
nextstring required

Example response

{
  "workspaces": [
    {
      "workspace_metadata": {
        "value": {
          "workspace_metadata": {}
        }
      },
      "subscription": {
        "value": {
          "subscription": {}
        }
      }
    }
  ]
}

Changes

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