Projects

Get list of projects

Returns list of projects in given workspace. Query parameters can be used to optimize the response.

get/workspaces/{workspace_id}/projects

Request

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

limitinteger

Max number of projects to return

Example:10
offsetinteger

Offset from the beginning of the project list

fieldsstring

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

Example:id,name
sortstring

Returned projects are Sort by this parameter. Can be (id, name, owner_workspace_id, updated_at)

Example:(id:asc)
subscribedstring

If true, list only subscribed projects otherwise list all projects

Example:true

Response

List of projects

offsetinteger
limitinteger
nextstring required

URI for next page of data

Example response

{
  "projects": [
    {
      "properties": {
        "value": {
          "color": "#E3E5E8"
        }
      }
    }
  ]
}

Changes

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