Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

workspaces

Returns the workspace based on the specified workspaceId.

User has to be a member of the Workspace or have permision workspaces.workspace.listAll

get/workspaces/{workspace_id}

Path parameters

workspace_idstring required

Workspace identifier

Query parameters

include'members' | 'invites' | 'members,invites'

Include full resource objects in response for related entities, or not. Possible values: members and/or invites

Response

OK

metaobject required

Example response

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "links": {
      "self": "/v2/workspaces/5b4f337bff4304610483ba67"
    },
    "attributes": {
      "name": "Workspace Name",
      "flow_stats_enabled_default": true
    },
    "relationships": {
      "contract": {
        "data": {
          "id": "5b4f337bff4304610483ba67"
        },
        "links": {
          "self": "/v2/contracts/5b4f337bff4304610483ba67"
        }
      },
      "members": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ],
        "links": {
          "self": "/v2/workspaces/5b4f337bff4304610483ba67/members"
        }
      }
    }
  },
  "included": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/members/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "first_name": "John",
        "last_name": "Smith",
        "roles": [
          "integrator"
        ],
        "email": "test@example.com"
      }
    }
  ],
  "links": {
    "self": "/v2/workspaces/5b4f337bff4304610483ba67"
  }
}