#The Workspace Token object

Describes a long-lived credential Linkbreakers issues so back-end integrations can call workspace APIs without a human session, while keeping auditing metadata for security reviews.

createdAt

string (date-time)

The timestamp when the token was created

createdBy

string

The member who created the token (UUID of creator)

string

The unique identifier of the workspace token (UUID)

keyType

string (enum)

WorkspaceTokenKeyType defines the access level of a workspace token

Allowed values

WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED

Default value (should not be used)

WORKSPACE_TOKEN_KEY_TYPE_SECRET

Secret key with full API access

WORKSPACE_TOKEN_KEY_TYPE_PUBLISHABLE

Publishable key with limited access

lastUsedAt

string (date-time)

The timestamp when the token was last used

name

string

The name of the token

updatedAt

string (date-time)

The timestamp when the token was last updated

workspaceId

string

The workspace ID the token belongs to (UUID)

Example object

{
  "createdAt": "2026-10-05T03:43:34.625Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "keyType": "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED",
  "lastUsedAt": "2026-10-05T03:43:34.625Z",
  "name": "Production token",
  "updatedAt": "2026-10-05T03:43:34.625Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET

/v1/workspace-tokens

Requires auth

#List workspace tokens

Enumerate all active workspace tokens for auditing and management.

#Parameters

query parameters

pageSize

integer (int64)

query

Maximum number to return. Defaults to 100, capped at 1000.

pageToken

string

query

Cursor from a previous response's next_page_token. Empty starts at the first page. Pages are ordered by (created_at, id), which never change, so a record cannot move between pages while a client is walking them.

#Response

200

Everything worked as expected.

nextPageToken

string

Cursor to continue listing tokens. Empty on the last page.

tokens

array<object>

Tokens scoped to the calling workspace

totalCount

string (int64)

How many records exist in total, so a client can tell a complete answer from a page of one. A local-first client reads absence from this list as deletion, and may only do so when the count it was given matches what it received: without that, one page would look like the whole model and everything beyond it would be removed locally.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/workspace-tokens?pageSize={pageSize}&pageToken={pageToken}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "nextPageToken": "string",
  "tokens": [
    {
      "createdAt": "2026-10-05T03:43:34.625Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "keyType": "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED",
      "lastUsedAt": "2026-10-05T03:43:34.625Z",
      "name": "Production token",
      "updatedAt": "2026-10-05T03:43:34.625Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ],
  "totalCount": "string"
}

Base URL: https://api.linkbreakers.com

GET

/v1/workspace-tokens/{id}

Requires auth

#Get a workspace token

Retrieve metadata for a specific workspace token without revealing its secret.

#Parameters

path parameters

string

Required

path

Identifier of the desired token (UUID)

#Response

200

Everything worked as expected.

token

object

Describes a long-lived credential Linkbreakers issues so back-end integrations can call workspace APIs without a human session, while keeping auditing metadata for security reviews.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/workspace-tokens/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "token": {
    "createdAt": "2026-10-05T03:43:34.625Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "keyType": "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED",
    "lastUsedAt": "2026-10-05T03:43:34.625Z",
    "name": "Production token",
    "updatedAt": "2026-10-05T03:43:34.625Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

POST

/v1/workspace-tokens

Requires auth

#Create a workspace token

Generate a new long-lived API token and return the one-time access secret.

#Parameters

This endpoint does not accept any parameters.

#Request body

keyType

string (enum)

Required

WorkspaceTokenKeyType defines the access level of a workspace token

Allowed values

WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED

Default value (should not be used)

WORKSPACE_TOKEN_KEY_TYPE_SECRET

Secret key with full API access

WORKSPACE_TOKEN_KEY_TYPE_PUBLISHABLE

Publishable key with limited access

name

string

The name of the token

#Response

200

Everything worked as expected.

accessToken

string

The actual JWT token to be used for authentication. It is returned only once and cannot be retrieved again.

token

object

Describes a long-lived credential Linkbreakers issues so back-end integrations can call workspace APIs without a human session, while keeping auditing metadata for security reviews.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/workspace-tokens" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"keyType":"WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED","name":"string"}'

Sample payload (application/json)

{
  "keyType": "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED",
  "name": "string"
}

Typical response

{
  "accessToken": "string",
  "token": {
    "createdAt": "2026-10-05T03:43:34.625Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "keyType": "WORKSPACE_TOKEN_KEY_TYPE_UNSPECIFIED",
    "lastUsedAt": "2026-10-05T03:43:34.625Z",
    "name": "Production token",
    "updatedAt": "2026-10-05T03:43:34.625Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

DELETE

/v1/workspace-tokens/{id}

Requires auth

#Delete a workspace token

Revoke a workspace token immediately so it can no longer authenticate.

#Parameters

path parameters

string

Required

path

Identifier of the token to revoke (UUID)

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Workspace Tokens

#The Workspace Token object

Allowed values

#List workspace tokens

#Parameters

query parameters

#Response

#Error response

#Get a workspace token

#Parameters

path parameters

#Response

#Error response

#Create a workspace token

#Parameters

#Request body

Allowed values

#Response

#Error response

#Delete a workspace token

#Parameters

path parameters

#Response

#Error response