FIfish
Phone Numbers

List Phone Numbers

Changed on

List your team's phone numbers, newest first. Released numbers are gone for good and never appear. Look an id up by E.164 with phone_number, or filter with agent_id to see one agent's numbers. Paginate with cursor (follow next_cursor while has_more is true) or with page for offset pagination with a total count — the two are mutually exclusive.

get/v1/agent/phone-numbers

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/v1/agent/phone-numbers
  • Auth
    HTTP bearer

Query parameters

phone_numberstring nullable

Exact E.164 match, e.g. +14155550123.

agent_idstring nullable

Only numbers bound to this agent.

cursorstring nullable
pageinteger nullable

1-based page number; mutually exclusive with cursor.

include_totalboolean
page_sizeinteger

Response

Request fulfilled, document follows

has_moreboolean required
next_cursorstring nullable
totalinteger nullable

Changes