Retrieve a phone number

GET

https://api.jelliu.co/api/phone-numbers/:id

GET

/api/phone-numbers/:id

curl https://api.jelliu.co/api/phone-numbers/7b1e9a3c-2d4f-4a8b-9c6e-1f0a2b3c4d5e \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "7b1e9a3c-2d4f-4a8b-9c6e-1f0a2b3c4d5e",
    "phoneNumber": "+13055550142",
    "label": "Recepción",
    "isActive": true,
    "agentId": "2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11",
    "agentName": "Sofía - Agendamiento",
    "agentProvisioned": true,
    "ivrEnabled": true,
    "ivrGreeting": "Gracias por llamar a Clínica Dental Sonrisas. Para agendar marque 1, para soporte marque 2.",
    "ivrOptions": [
      {
        "digit": "1",
        "label": "Agendar",
        "agentId": "2f2d8b4d-aa6f-41e0-9d3e-4d61e1b07a11",
        "department": null
      },
      {
        "digit": "2",
        "label": "Soporte",
        "agentId": null,
        "department": "soporte"
      }
    ],
    "channels": [
      "voice"
    ],
    "whatsappStatus": null,
    "provider": "twilio",
    "sipHost": null,
    "createdAt": "2026-09-01T14:20:00.000Z",
    "updatedAt": "2026-09-13T11:05:00.000Z"
  }
}

Returns one number of the workspace with its routing configuration (bound agent, IVR menu, channels). Deleted numbers return 404.

Idempotency. Read-only; safe to retry.

Access

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

Returns one number of the workspace with its routing configuration (bound agent, IVR menu, channels). Deleted numbers return 404. **Idempotency.** Read-only; safe to retry. **Access** - **Required scope:** `read` (or `write`). - **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).

Path parameters

idstringRequiredformat: "uuid"

The phone number’s id (not the E.164 number). Must be a UUID (400 otherwise).

Response

The number.

dataobject

One number the workspace holds. channels says what it answers on; provider says where it lives. Field names are camelCase. Returned by every /api/phone-numbers endpoint.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error