> ## Documentation Index > Fetch the complete documentation index at: https://docs.firetone.com.au/llms.txt > Use this file to discover all available pages before exploring further. # List DIDs > Sort keys: created_at, destination_type, e164, enabled, monthly_rental. An unknown sort key is a 400. ## OpenAPI ````yaml /api-reference/openapi-public.json get /dids openapi: 3.0.3 info: description: >- The API your own systems use: place and follow calls, have an AI agent call someone, run campaigns and get their results, keep contacts in step with your CRM, and receive signed webhooks. Authenticate with an integration key (Authorization: Bearer ft_...), used only from the IP addresses it allows. title: FireTone API version: 0.1.0 servers: - description: Your platform's API host url: https://{host}/api/v1 variables: host: default: api.firet.one security: - bearerAuth: [] tags: - name: Auth - description: >- Live calls and what can be done to them: hang up, hold, transfer, park, merge, monitor, whisper; the Desk's own call. name: Calls - description: 'Outbound campaigns: contacts, attempts, outcomes.' name: Campaigns - description: 'Customers: who called, what is known about them, and their memory.' name: Contacts - description: What was said on an AI call, and the review of it. name: Conversations - name: IVR - description: >- Your own systems: HTTP connections an IVR calls mid-call, and webhooks for call events. Tenant URLs must be public https addresses. name: Integrations - name: Live - name: Provisioning - name: Reporting - description: Tickets raised by people, agents and the API. name: Tickets - description: Messages left for an extension or a queue. name: Voicemail paths: /dids: get: tags: - Provisioning summary: List DIDs description: >- Sort keys: created_at, destination_type, e164, enabled, monthly_rental. An unknown sort key is a 400. operationId: getDids parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/organisationId' - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/order' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/filterDestinationType' - $ref: '#/components/parameters/filterTeamId' - $ref: '#/components/parameters/filterTrunkId' - $ref: '#/components/parameters/filterEnabled' - $ref: '#/components/parameters/filterE164' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DIDPage' description: OK '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: limit: in: query name: limit schema: default: 50 maximum: 500 type: integer offset: in: query name: offset schema: default: 0 type: integer organisationId: description: Narrow to one organisation. Outside your scope returns 403. in: query name: organisation_id schema: format: uuid type: string sort: description: >- Sort key. Each list accepts its own allow-list of keys, given in that endpoint's description; anything else is a 400. ORDER BY cannot be parameterised, so the key is looked up rather than interpolated. Every sort carries a tiebreak on the primary key, so paging stays disjoint when the sort column has duplicates. in: query name: sort schema: type: string order: description: >- Sort direction. Defaults to ascending, except the call log, which reads newest first. in: query name: order schema: enum: - asc - desc type: string q: description: >- Free-text search across the list's searchable columns (case-insensitive substring). % and _ in the term match themselves. in: query name: q schema: type: string filterDestinationType: description: Filter on where the number lands. in: query name: destination_type schema: type: string filterTeamId: description: Filter on team. in: query name: team_id schema: format: uuid type: string filterTrunkId: description: Filter on trunk. in: query name: trunk_id schema: format: uuid type: string filterEnabled: description: Only rows with this enabled state. in: query name: enabled schema: type: boolean filterE164: description: Match numbers starting with this. in: query name: e164 schema: type: string schemas: DIDPage: properties: items: items: $ref: '#/components/schemas/DID' type: array limit: type: integer offset: type: integer total: type: integer required: - items - total - limit - offset type: object DID: properties: destination_id: description: >- The id of the extension, queue, IVR flow, process, room or client trunk the number goes to. Must belong to the number's organisation. Not used for `external`. format: uuid nullable: true type: string destination_type: description: >- Where the number's calls go: `extension` (a phone), `queue`, `flow` (an IVR), `process`, `conference` (a room), `external` (forwarded to another number), `client_trunk` (a client's own PBX; only where that module is on) or `recorder`. enum: - extension - queue - external - flow - process - recorder - conference - client_trunk type: string destination_value: description: >- For `external`: the number to forward to, normalised to E.164. For `extension`: the extension number, as an alternative to `destination_id`. nullable: true type: string e164: description: The number, in E.164 form with the plus. example: '+61300000001' type: string enabled: description: >- Whether the number is in service. A disabled number's calls are refused. type: boolean id: description: The number's id. format: uuid type: string monthly_rental: description: >- Exact decimal amount as a string. Never a JSON number: rates are fractions of a cent and binary floating point cannot represent them exactly. example: '12.5000' type: string organisation_id: description: >- The organisation the number belongs to. May be left out by a caller with exactly one organisation. format: uuid type: string team_id: description: >- The team the number belongs to, if any; a team supervisor sees only their teams' numbers. format: uuid nullable: true type: string trunk_id: description: The trunk this number arrives on, when it is pinned to one. format: uuid type: string required: - id - organisation_id - e164 - destination_type - enabled type: object Error: properties: error: properties: code: enum: - invalid_request - invalid_credentials - unauthenticated - forbidden - not_found - conflict - internal type: string message: type: string required: - code - message type: object required: - error type: object responses: BadRequest: content: application/json: schema: $ref: '#/components/schemas/Error' description: The request is not valid. The message names every field that is wrong. Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Missing, invalid or expired token Forbidden: content: application/json: schema: $ref: '#/components/schemas/Error' description: Outside the caller's scope, or insufficient role securitySchemes: bearerAuth: bearerFormat: JWT or API key description: >- Every request sends `Authorization: Bearer `. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key `ft__`. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.