API reference/Stations

Get a station

Try it

Read one station owned by this workspace.

GET/api/v1/stations/{stationId}

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

stations:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

stationIdRequired: integerRange: any to 2147483647

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "stationId": 1
}

Input schema

{
  "type": "object",
  "properties": {
    "stationId": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483647
    }
  },
  "required": [
    "stationId"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "station": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "calls": {
          "type": "string"
        },
        "format": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "calls",
        "format"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "station"
  ],
  "additionalProperties": false
}