Skip to main content
GET
/
api
/
users
/
service
/
{userId}
/
personal-access-tokens
List tokens
curl --request GET \
  --url https://api.example.com/api/users/service/{userId}/personal-access-tokens \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "note": "<string>",
    "permissions": [],
    "allProjects": true,
    "projects": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "version": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "key": "<string>",
        "protected": true
      }
    ],
    "user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "type": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "isService": true
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "expiresAt": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
userId
string<uuid> | null
required

Service user ID to list tokens for (admin only)

Response

200 - application/json

List of personal access tokens

​
id
string<uuid>
required

Unique identifier of the personal access token

​
note
string
required

Description or note for the token

​
permissions
enum<string>[]
required

List of permissions granted to this token

Available options:
owner,
documents,
releases,
releases:manage,
releases:deploy,
releases:delete,
integrations:manage,
documents:full,
documents:view-content,
documents:edit-content,
documents:edit-view,
branches,
branches:create,
branches:merge,
branches:delete,
project:manage,
environments,
environments:manage,
environments:delete
​
allProjects
boolean
required

Whether the token has access to all projects

​
projects
object[]
required

List of projects the token has access to

​
user
object
required

User who owns the token

​
createdAt
string
required

Timestamp when the token was created

​
updatedAt
string
required

Timestamp when the token was last updated

​
expiresAt
string | null

Timestamp when the token expires, null if indefinite