Workspace memberships

The Workspace Memberships API gives businesses full visibility into who has access to each workspace, including both directly assigned members and inherited access from organization admins.

List workspace memberships

get

List all memberships for a workspace. Requires can_view_workspace permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

workspaceIdstring · uuidRequired

Identifier of the workspace

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

get

/workspaces/{workspaceId}/memberships

GET /workspaces/{workspaceId}/memberships HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

[
  {
    "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "role": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Editor",
      "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdDateTime": "2025-01-01T10:00:00Z",
      "type": "WORKSPACE"
    }
  }
]

List workspace memberships including organization admins

get

List all direct and inherited (organization admin) memberships for a workspace. Requires can_view_workspace permission.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

workspaceIdstring · uuidRequired

Identifier of the workspace

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

get

/organizations/workspaces/{workspaceId}/memberships

GET /organizations/workspaces/{workspaceId}/memberships HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

{
  "directMemberships": [
    {
      "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "role": {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "name": "Editor",
        "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "createdDateTime": "2025-01-01T10:00:00Z",
        "type": "WORKSPACE"
      }
    }
  ],
  "inheritedMemberships": [
    {
      "organizationId": "f1e2d3c4-b5a6-7890-fedc-ba9876543210",
      "userId": "d4e5f6a7-b8c9-0123-def0-123456789012",
      "roleId": "e5f6a7b8-c9d0-1234-ef01-234567890123",
      "status": "ACTIVE"
    }
  ]
}

Remove workspace membership

delete

Remove a user's membership from a workspace. Requires can_manage_workspace_access permission on the workspace.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

workspaceIdstring · uuidRequired

Identifier of the workspace

userIdstring · uuidRequired

Identifier of the user to remove

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

delete

/workspaces/{workspaceId}/memberships/{userId}

DELETE /workspaces/{workspaceId}/memberships/{userId} HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

No content

Add or update workspace membership

put

Add or update workspace membership for a user. Requires can_manage_workspace_access permission on the workspace.

Authorizations

AuthorizationstringRequired

Organization API token (tot_) — preferred authentication method. Pass the token directly without Bearer prefix.

Path parameters

workspaceIdstring · uuidRequired

Identifier of the workspace

userIdstring · uuidRequired

Identifier of the user

Header parameters

AuthorizationstringRequired

Organization token (tot_). Pass the token directly without Bearer prefix.

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Body

userIdstring · uuidRequired

Identifier of the user to add to the workspace

roleIdstring · uuidRequired

Identifier of the role to assign to the user

Responses

200

application/json;charset=UTF-8

400

Bad Request – invalid request parameters

application/json

401

Unauthorized – JWT token missing or invalid

application/json

403

Forbidden – insufficient permissions

application/json

404

Not Found – resource does not exist

application/json

500

Internal Server Error – unexpected server error

application/json

put

/workspaces/{workspaceId}/memberships/{userId}

PUT /workspaces/{workspaceId}/memberships/{userId} HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "roleId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

{
  "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "role": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Editor",
    "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdDateTime": "2025-01-01T10:00:00Z",
    "type": "WORKSPACE"
  }
}

PreviousEnrollments NextOrganization

Last updated 1 month ago