Skip to main content

OpenApiTokenInfoDTO

Everything about the calling token, returned by GET /v1/open-api/token/info.

application object

The Open API application the token was issued from.

idint32

Application ID

Example: 4
namestring

Application name

Example: Telegram bot integration
typeOpenApiApplicationType

Application type.

Possible values: [PRIVATE, PUBLIC]

descriptionstringnullable

Free-text description of the application; null when not set.

Example: Creates leads from Telegram
company object

The company the token belongs to.

idint32

Company ID

Example: 12
namestring

Company name

Example: Golden House
timeZonestringnullable

IANA time zone of the company; null when it is not configured. Render *Timestamp values (epoch seconds) in this zone.

Example: Asia/Tashkent
installationIdint32nullable

This token's connection (installation) ID — same value as installation_id in POST /oauth/token's response.

Example: 501
kindOpenApiCredentialKind

Credential kind.

Possible values: [PAT, ACCESS]

expiresAtint64nullable

Expiry, epoch seconds. Null means the token never expires and dies only when revoked.

Example: 1767225600
expiresInDaysint64nullable

Whole days left until expiry; null when expiresAt is null.

Example: 128
permissions object[]

Permissions granted to this token in this company, sorted by permission then scope. An endpoint requiring PERMISSION_OPEN_API_CONTRACT:READ is callable when this array contains that pair.

  • Array [
  • permissionOpenApiPermission

    The resource the grant applies to.

    Possible values: [PERMISSION_OPEN_API_LEAD, PERMISSION_OPEN_API_LEAD_NOTE, PERMISSION_OPEN_API_LEAD_TASK, PERMISSION_OPEN_API_CONTRACT, PERMISSION_OPEN_API_CONTRACT_PAYMENT, PERMISSION_OPEN_API_BOOKING, PERMISSION_OPEN_API_CALL, PERMISSION_OPEN_API_MCP]

    scopeOpenApiScope

    The action allowed on that resource.

    Possible values: [READ, SAVE, DELETE]

  • ]
  • webhook object

    The application's webhook status.

    enabledboolean

    Whether the application has a webhook configuration and it is enabled.

    Example: true
    eventsWebhookEvent[]

    Events the application is subscribed to. Empty when enabled is false or no webhook configuration exists at all.

    Possible values: [LEAD_CREATED, LEAD_ASSIGNED, LEAD_STAGE_CHANGED, LEAD_MERGED, LEAD_DELETED, LEAD_PROPERTIES_UPDATED, CALL_COMPLETED]

    OpenApiTokenInfoDTO
    {
    "application": {
    "id": 4,
    "name": "Telegram bot integration",
    "type": "PRIVATE",
    "description": "Creates leads from Telegram"
    },
    "company": {
    "id": 12,
    "name": "Golden House",
    "timeZone": "Asia/Tashkent"
    },
    "installationId": 501,
    "kind": "PAT",
    "expiresAt": 1767225600,
    "expiresInDays": 128,
    "permissions": [
    {
    "permission": "PERMISSION_OPEN_API_LEAD",
    "scope": "READ"
    }
    ],
    "webhook": {
    "enabled": true,
    "events": [
    "LEAD_CREATED"
    ]
    }
    }