v55

latestOpenAPI 3.1.0CC-BY-NC-SA-4.0raw.githubusercontent.com2026-08-011243791.8 MB

Terminals API

List terminal pairing codes

ℹ️ Test mode

This endpoint currently does not support test mode yet.

Returns all pairing codes: active, expired, and revoked. Results are paginated.

get/v2/terminals/pairing-codes

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable

Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'

Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

profileIdstring

Example:pfl_QkEhN94Ba

The identifier referring to the profile you wish to retrieve pairing codes for.

Headers

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of terminal pairing code objects. For a complete reference of the terminal pairing code object, refer to the Get terminal pairing code endpoint documentation.