Skip to main content
GET
List terminals

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Query Parameters

storeId
string

Filter by store ID

serialNumber
string

Filter by hardware serial number. Must match exactly. The filter applies after each page is read, so a page can be empty while nextToken is set: follow nextToken until it is absent before concluding no terminal matches.

status
string

Filter by terminal status

limit
string

Maximum number of items to return (1-100). Defaults to 100.

nextToken
string

Token for pagination

Response

Successful response with terminal list

data
object
required

Page of terminals plus the pagination cursor

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$