Skip to Content
OpenRoam Docs
Airtime

Airtime catalog

Returns the operator directory, page by page, for partner inventory.

GET
/v1/airtime/catalog

Returns the operator directory, page by page, for partner inventory.

Returns { items: [{ id, name, countryCode, category, logoUrl }], nextCursor }, ordered by operator ID. Pass nextCursor back as cursor with the same countryCode until it is null; a page can hold fewer items than limit, and the cursor does not expire. A cursor reused with another countryCode, or a blank or invalid countryCode, gives 400 / 10001. Offers are not exported: they depend on whether the operator is detected or chosen, so read them with operators/{id}?phoneNumber=.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

countryCode?string

Optional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank or invalid value gives 400 / 10001.

cursor?string

The nextCursor of the previous page; omit it for the first page. Reuse it only with the same countryCode.

limit?integer

Page size, 1 to 100; default 100.

Formatint32

Response Body

OK

  1. response

A page of the operator directory, ordered by operator ID. Continue with nextCursor and the same filters until it is null; a page may hold fewer items than the limit.

items*array<>
nextCursor?string|null
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/airtime/catalog?countryCode=AZ&limit=10'
Example Response
{  "items": [    {      "id": "string",      "name": "string",      "countryCode": "string",      "category": "string",      "logoUrl": "string"    }  ],  "nextCursor": "string"}