v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.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.

🔑 Access with

API key

OAuth access with terminals.read

get/terminals/pairing-codes

Query parameters

fromstring

Example:termpc_R7gX5Ea9bC4DkFj3G

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.

sortstring

Example:desc

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

Possible values: asc desc

profileIdstring

Example:pfl_QkEhN94Ba

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

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.