Stations

Bulk read stations

Retrieves a list of stations. Supports filtering by fields, sorting, and pagination.

get/v1/stations

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/stations
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt' | 'name' | 'sequenceNumber'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByNamestring

Field name to search by (case-insensitive partial match)

searchByDeviceIdstring

Field name to search by (case-insensitive partial match)

searchByDeviceNamestring

Field name to search by (case-insensitive partial match)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

outletIdstring

Filter by outletId

status'IN_USE' | 'AVAILABLE'

Filter by status. Allowed values: IN_USE, AVAILABLE

isVirtualboolean

Filter by isVirtual

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "name": "Super Station",
      "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "status": "AVAILABLE",
      "deviceId": "1234567890",
      "deviceName": "Super Device",
      "stripeTerminalId": "tml_XXXXXXXXXX",
      "serialReaderId": "1234567890",
      "sequenceNumber": 1,
      "isVirtual": true,
      "enrolledBy": "user@example.com",
      "flowRuntime": {
        "webAppId": "507f1f77bcf86cd799439011",
        "version": "1.0.3",
        "appliedAt": "2026-09-18T12:04:00.000Z",
        "pendingVersion": "1.0.4",
        "rolloutState": "scheduled"
      },
      "terminals": [
        {
          "id": "term_123",
          "processor": "stripe"
        }
      ],
      "buildSrcId": "507f1f77bcf86cd799439011",
      "flowSrcId": "507f1f77bcf86cd799439011"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.