Get a list of all TXT programmes.

Required permissions: Messages and Reports

get

Query parameters

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

programmeIDstringOptional

namestringOptional

shortCodestringOptional

keywordstringOptional

capturesKeywordlessbooleanOptional

statusstringOptional

createdstring · date-timeOptional

lastModifiedstring · date-timeOptional

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/txt/programmes

GET /txt/programmes?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

[
  {
    "programmeID": "text",
    "name": "text",
    "shortCode": "text",
    "keyword": "text",
    "capturesKeywordless": true,
    "status": "text",
    "created": "2026-01-01T00:00:00.000Z",
    "lastModified": "2026-01-01T00:00:00.000Z"
  }
]