Organization

The Organization API allows businesses to programmatically manage their organisational structure by retrieving available roles and listing workspaces — both live and sandbox environments

List available roles in organization

get

Returns all available roles for the organization (owner, admin, member). Requires can_manage_users permission.

Authorizations

AuthorizationstringRequired

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

Header parameters

AuthorizationstringRequired

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

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

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

500

Internal Server Error – unexpected server error

application/json

get/organizations/roles

GET /organizations/roles HTTP/1.1
Host: api.transactionlink.io
Authorization: text
Accept: */*

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "admin",
    "organizationId": "f1e2d3c4-b5a6-7890-fedc-ba0987654321"
  },
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "member",
    "organizationId": "f1e2d3c4-b5a6-7890-fedc-ba0987654321"
  },
  {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "name": "owner",
    "organizationId": "f1e2d3c4-b5a6-7890-fedc-ba0987654321"
  }
]

List workspaces for the organization

get

Returns all workspaces belonging to the organization. Filters results to workspaces the token has can_view_workspace permission on.

Authorizations

AuthorizationstringRequired

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

Header parameters

AuthorizationstringRequired

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

Example: tot_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Responses

200

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

500

Internal Server Error – unexpected server error

application/json

get/organizations/workspaces

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

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "My Workspace",
    "description": "Main production workspace",
    "workspaceType": "LIVE"
  }
]

List available roles for a workspace

get

List all available roles 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

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}/roles

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

[
  {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "Editor",
    "workspaceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "description": "Can edit records and workflows",
    "permissions": [
      {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "resourceType": "table",
        "relation": "can_edit_data",
        "resourceId": "d4e5f6a7-b8c9-0123-def0-123456789012"
      }
    ],
    "createdDateTime": "2025-01-01T10:00:00Z",
    "type": "CUSTOM"
  }
]