GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caja 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Kiosco Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
API
List store terminals
List the POS registers, kiosks and kitchen displays registered in a store, with their current status.
GET
/
api
/
v1
/
fire
/
external
/
stores
/
{storeId}
/
terminals
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caja 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Kiosco Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
Returns the terminals registered in one store: POS registers, self-service kiosks and
KDS kitchen displays. By default you get what the store has enabled today, which means active
and suspended terminals. Revoked terminals are only returned when you ask for them with
status.
If the store does not exist, or belongs to another tenant, the response is 404 (existence is
never leaked across tenants).
Authentication
string
required
Your Fire API key with the
store:read scope. The key must be vendor-scoped. Keys without a
vendorId are rejected with 403.Path parameters
string
required
Store UUID (
stores.id).Query parameters
string
Comma-separated terminal types:
POS, KIOSK, KDS. Omit to return all three.string
default:"ACTIVE,SUSPENDED"
Comma-separated statuses:
ACTIVE, SUSPENDED, REVOKED.string
Comma-separated list of fields to return (projection). See
Field projection. Omit to return every field.
Request
GET https://api.fire.rest/api/v1/fire/external/stores/550e8400-e29b-41d4-a716-446655440000/terminals?type=KIOSK,POS
x-api-key: <your_api_key>
Response
object[]
Show terminal
Show terminal
string
Terminal UUID.
string
Store UUID.
string
Display name of the terminal.
string
POS, KIOSK or KDS.string
ACTIVE operating, SUSPENDED paused by an administrator, REVOKED decommissioned.string | null
External identifier of the device. For kiosks, the device ID shown on the QR screen.
null for POS and KDS.string | null
Last time the terminal contacted Fire (ISO 8601).
null if it never connected.string
When the terminal was registered (ISO 8601).
number
Number of terminals returned.
{
"terminals": [
{
"id": "8d0f6b1e-3c2a-4f57-9a61-0e2d4b7c9a10",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Caja 1",
"type": "POS",
"status": "ACTIVE",
"externalId": null,
"lastSeenAt": "2026-10-06T15:02:11Z",
"createdAt": "2026-09-01T10:00:00Z"
},
{
"id": "2b7e4a90-61d3-4c0e-8f2b-7a5c1d9e3f44",
"storeId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Kiosco Entrada",
"type": "KIOSK",
"status": "ACTIVE",
"externalId": "K082-94",
"lastSeenAt": "2026-10-06T14:58:40Z",
"createdAt": "2026-09-03T12:30:00Z"
}
],
"total": 2
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{ "code": "custom", "path": ["status"], "message": "Invalid status: BROKEN. Allowed: ACTIVE, SUSPENDED, REVOKED" }
]
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found with ID 550e8400-e29b-41d4-a716-446655440000"
}
Related
Get store
Read the full configuration of this store.
Terminal administration
Suspend, reactivate or revoke terminals from the backoffice.