Workspace Tokens API Reference

#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)

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": "2025-10-29T08:01:37.857Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
  "lastUsedAt": "2025-10-29T08:01:37.857Z",
  "name": "Production token",
  "updatedAt": "2025-10-29T08:01:37.857Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET/v1/workspace-tokensRequires auth

#List workspace tokens

Enumerate all active workspace tokens for auditing and management.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

tokens

array<object>

Tokens scoped to the calling workspace

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

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

Typical response

{
  "tokens": [
    {
      "createdAt": "2025-10-29T08:01:37.857Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
      "lastUsedAt": "2025-10-29T08:01:37.857Z",
      "name": "Production token",
      "updatedAt": "2025-10-29T08:01:37.857Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ]
}

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

stringRequiredpath

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

objectRequired

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": "2025-10-29T08:01:37.857Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastUsedAt": "2025-10-29T08:01:37.857Z",
    "name": "Production token",
    "updatedAt": "2025-10-29T08:01:37.857Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

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

POST/v1/workspace-tokensRequires 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

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

objectRequired

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 '{"name":"string"}'

Sample payload (application/json)

{
  "name": "string"
}

Typical response

{
  "accessToken": "string",
  "token": {
    "createdAt": "2025-10-29T08:01:37.857Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "id": "d22f7bf1-83a9-4f3a-9b37-9a3a21b6ac11",
    "lastUsedAt": "2025-10-29T08:01:37.857Z",
    "name": "Production token",
    "updatedAt": "2025-10-29T08:01:37.857Z",
    "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

stringRequiredpath

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

objectRequired

Wrapped error response.