Workspace Tokens API Reference

#The Workspace Token object

WorkspaceToken represents a token used for workspace authentication

createdAt

string (date-time)

createdBy

string

id

string

lastUsedAt

string (date-time)

name

string

updatedAt

string (date-time)

workspaceId

string

GET/v1/workspace-tokensRequires auth

#List workspace tokens

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

tokens

array<object>

#Error response

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-08T00:57:45.903Z",
      "createdBy": "string",
      "id": "string",
      "lastUsedAt": "2025-10-08T00:57:45.903Z",
      "name": "string",
      "updatedAt": "2025-10-08T00:57:45.903Z",
      "workspaceId": "string"
    }
  ]
}

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

GET/v1/workspace-tokens/{id}Requires auth

#Get a workspace token

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

token

object

#Error response

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-08T00:57:45.903Z",
    "createdBy": "string",
    "id": "string",
    "lastUsedAt": "2025-10-08T00:57:45.903Z",
    "name": "string",
    "updatedAt": "2025-10-08T00:57:45.903Z",
    "workspaceId": "string"
  }
}

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

POST/v1/workspace-tokensRequires auth

#Create a workspace token

#Parameters

This endpoint does not accept any parameters.

#Request body

name

string

#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

#Error response

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-08T00:57:45.903Z",
    "createdBy": "string",
    "id": "string",
    "lastUsedAt": "2025-10-08T00:57:45.903Z",
    "name": "string",
    "updatedAt": "2025-10-08T00:57:45.903Z",
    "workspaceId": "string"
  }
}

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

DELETE/v1/workspace-tokens/{id}Requires auth

#Delete a workspace token

#Parameters

path parameters

id

stringRequiredpath

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

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

error

objectRequired

Wrapped error response.