Skip to Content
OpenRoam Docs
Airtime

List airtime operators

Lists the operators of a country that the customer can choose manually (manual flow, step 1).

GET
/v1/airtime/operators

Lists the operators of a country that the customer can choose manually (manual flow, step 1).

Returns the complete list, without paging or prices, as { items: [{ id, name, countryCode, category, logoUrl }] }, ordered by name. Only operators with an offer that can be sold for a chosen operator are listed. An invalid countryCode gives 400 / 10001. Continue with operators/{id}?phoneNumber=.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

countryCode*string

Required ISO 3166-1 alpha-2 country code, in either case, for example the details.phoneLookup.countryCode of a search.

Response Body

OK

  1. response

The complete operator list of one country for manual selection; it is small, so it is not paged.

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