Jelliu API documentation

{
  "data": [
    {
      "phoneNumber": "+13055550142",
      "friendlyName": "(305) 555-0142",
      "locality": "Miami",
      "region": "FL",
      "isoCountry": "US",
      "type": "local",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "addressRequired": false
    },
    {
      "phoneNumber": "+13055550187",
      "friendlyName": "(305) 555-0187",
      "locality": "Miami",
      "region": "FL",
      "isoCountry": "US",
      "type": "local",
      "capabilities": {
        "voice": true,
        "sms": true
      },
      "addressRequired": false
    }
  ]
}

Searches the telephony carrier’s voice-capable inventory for a country, so you can pick an exact number before POST /api/phone-numbers/provision. Nothing is bought and nothing is reserved: a number listed here can be sold to someone else before you provision it.

Without type, local, mobile and toll-free inventory are all searched and concatenated in that order, so up to 3 × limit numbers can come back. A country with no inventory of the requested types returns an empty array. Note that provision only buys US/CA numbers directly; other countries are sold as add-ons under Settings → Plan.

Idempotency. Read-only; safe to retry (inventory changes between calls).

Access

Required scope: read (or write). Any role, including viewer.
Rate limit: General API — per plan: 120 to 600 requests/min per workspace. See Rate limits.
Plan: Available on every plan.

Searches the telephony carrier's voice-capable inventory for a country, so you can pick an exact number before `POST /api/phone-numbers/provision`. Nothing is bought and nothing is reserved: a number listed here can be sold to someone else before you provision it. Without `type`, local, mobile and toll-free inventory are all searched and concatenated in that order, so up to 3 × `limit` numbers can come back. A country with no inventory of the requested types returns an empty array. Note that `provision` only buys US/CA numbers directly; other countries are sold as add-ons under Settings → Plan. **Idempotency.** Read-only; safe to retry (inventory changes between calls). **Access** - **Required scope:** `read` (or `write`). Any role, including viewer. - **Rate limit:** General API — per plan: 120 to 600 requests/min per workspace. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

Scope	GET / HEAD	POST / PUT / PATCH / DELETE	Admin-only routes
`read`	Yes	No	No
`write`	Yes	Yes	No
`full`	Yes	Yes	Yes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

Query parameters

countryenumRequired

ISO-3166 alpha-2 code (case-insensitive, trimmed). Only serviceable markets are accepted; any other code is a 400 naming the available ones.

typeenumOptional

Inventory type to search. Omit to search local, mobile and toll-free.

Allowed values:

areaCodestringOptionalformat: "^\d{3}$"

3-digit area code (NPA). Only applied for US and CA; ignored elsewhere. A value that is not exactly 3 digits is a 400.

containsstringOptionalformat: "^[0-9a-zA-Z*]{1,15}$"

1 to 15 digits or letters the number must contain (carrier search pattern; * is a single-character wildcard). Anything else is a 400.

limitintegerOptional1-30Defaults to 10

Maximum results per inventory type, 1 to 30 (400 outside the range).

Response

Available numbers.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

502

Bad Gateway Error

Idempotency. Read-only; safe to retry (inventory changes between calls).

Access

Required scope: read (or write). Any role, including viewer.
Rate limit: General API — per plan: 120 to 600 requests/min per workspace. See Rate limits.
Plan: Available on every plan.