Station

Get a station by ID

Retrieves a single station by its unique identifier.

get/v1/station/{id}

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/station/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Station ID

Response

The station has been successfully retrieved.

idstring

Unique identifier for the Station.

createdAtstring date-time

Timestamp when the Station was created.

updatedAtstring date-time

Timestamp when the Station was last updated.

companyIdstring

Company ID associated with the Station.

namestring

Name of the station.

outletIdstring

ID of the outlet this station belongs to.

status'IN_USE' | 'AVAILABLE'

Status of the station.

deviceIdstring

Device ID of the station.

deviceNamestring

Name of the device.

stripeTerminalIdstring

Stripe terminal ID of the station.

serialReaderIdstring

Serial reader ID of the station.

sequenceNumbernumber

Sequence number of the station.

isVirtualboolean

Whether the station is virtual.

enrolledBystring

User who enrolled the station.

flowRuntimeobject

Flow build this station is running, reported by station-home after an auto-publish rollout applies or arms: the live version, and any newer version it is holding with where it is in that rollout. Observational — absent until the station first reports.

terminalsobject[]

Terminal configurations for the station.

buildSrcIdstring

Source build ID of the station.

flowSrcIdstring

Source flow ID of the station.

Example response

{
  "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"
}

Changes

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