List phone number usage

{
  "campaigns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "October follow-up",
      "status": "draft"
    }
  ],
  "canRelease": false,
  "metaLeadForms": [
    {
      "enabled": true,
      "formId": "1234567890123456",
      "integrationId": "550e8400-e29b-41d4-a716-446655440000",
      "mappingId": "550e8400-e29b-41d4-a716-446655440000",
      "pageConnected": true,
      "pageName": "Talkif",
      "formName": "Spring campaign"
    }
  ],
  "phoneNumberId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "schedules": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Weekly check-in",
      "status": "active"
    }
  ],
  "inboundFlow": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Receptionist"
  }
}

Returns the flow that answers inbound calls to the number, the Meta lead form mappings that use it as caller ID, and the unfinished campaigns and call schedules that dial from it. canRelease is false while a Meta lead form mapping uses the number: delete those mappings or point them at another number before releasing it.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Path parameters

idstringRequiredformat: "uuid"

Phone number ID

Response

What uses the phone number

campaignslist of objects

Campaigns that dial from this number and have not finished

canReleaseboolean

Whether the number can be released now. false while any Meta lead form mapping uses it as caller ID: release answers cannot_delete_has_dependencies until those mappings are deleted or use another number. The inbound flow, campaigns and schedules never block a release; they stop working once the number is gone.

metaLeadFormslist of objects

Meta lead form mappings that call new leads from this number

phoneNumberIdstringformat: "uuid"

Phone number these uses belong to

scheduleslist of objects

Active or paused call schedules that dial from this number

inboundFlowobject or nullOptional

Flow connected to a phone number for inbound calls

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error