Skip to content

List terminals

Request

List all terminals (POS devices) from your account.

Required scope: terminal:read

Security
accountId and apiKey
Query
cursorstring

The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.

limitnumber

The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.

namestring

Filter by terminal name

statusstring

Filter by terminal status

Enum:"ACTIVE""INACTIVE"
modelstring

Filter by terminal model

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/terminal?cursor=string&limit=0&name=string&status=ACTIVE&model=string' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
metadataobject(Metadata)required

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

dataArray of objects(terminal)read-onlyrequired
Response
Success
{
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 2
  },
  "data": [
    { … },
    { … }
  ]
}