Qodex.ai

Get DIDs

GET https://{{host}}/v3/dids

Returns a list of DIDs owned by your account.

Request Params

KeyDatatypeRequiredDescription
includenullComma-separated values of include parameter.
The response will include a top-level object relationships with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

order - Order Object

voice_in_trunk - Voice In Trunk Object

voice_in_trunk.voice_in_trunk_group - Voice In Trunk Group Object

voice_in_trunk.pop - POP Object

voice_in_trunk_group - Voice In Trunk Group Object

capacity_pool - Capacity Pool Object

shared_capacity_group - Shared Capacity Group Object

did_group - DID Group Object

did_group.country - Country Object

did_group.city - City Object

did_group.region - Region Object

did_group.did_group_type - DID Group Type Object

did_group.stock_keeping_units - Stock Keeping Unit Object *** | | filter[number] | null | | string - Filters by the description field

  • Allow blank - Yes.
  • Allow array - Yes | | filter[description] | null | | string - Filters by the description field
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[terminated] | null | | boolean - Filters by the terminated field.

Allow blank - No. Allow array - No. | | filter[awaiting_registration] | null | | boolean - Filters by the awaiting_registration field.

  • Allow blank - No.
  • Allow array - No. | | filter[pending_removal] | null | | boolean - Filters by the pending_removal field.
  • Allow blank - No.
  • Allow array - No. | | filter[did_group.features] | null | | string - Filters by the did_group.features field.
    Can be one/several/all of voice_in, voice_out, t38, sms_in, sms_out (example: “voice_in,sms_in”).
  • Allow blank - No.
  • Allow array - Yes. | | filter[did_group.id] | null | | string - Filters by the id field of did_group.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[country.id] | null | | string - Filters by the id field of country.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[region.id] | null | | string - Filters by the id field of region.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[city.id] | null | | string - Filters by the id field of city.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[order.id] | null | | string - Filters by the id field of order.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[voice_in_trunk.id] | null | | string - Filters by the id field of voice_in_trunk.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[voice_in_trunk_group.id] | null | | string - Filters by the id field of voice_in_trunk_group.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[shared_capacity_group.id] | null | | string - Filters by the id field of shared_capacity_group.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[capacity_pool.id] | null | | string - Filters by the id field of capacity_pool.id relationship.
  • Allow blank - Yes.
  • Allow array - Yes. | | filter[order.reference] | null | | string - Filters by the reference field of order relationship.
  • Allow blank - No.
  • Allow array - Yes. | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

blocked - Sort by the blocked field.

pending - The pending field.

awaiting_registration - Sort by the awaiting_registration field.

capacity_limit - Sort by the capacity_limit field.

description - Sort by the description field.

terminated - Sort by the terminated field.

number - Sort by the number field.

expires_at - The expires_at field.

channels_included_count - Sort by the channels_included_count field.

dedicated_channels_count - Sort by the dedicated_channels_count field.

created_at - Sort by the created_at field. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"data":{"id":"2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d","type":"dids","attributes":{"blocked":false,"capacity_limit":1,"description":"string","terminated":false,"awaiting_registration":false,"number":"437xxxxxxxxx","expires_at":"2017-06-25T08:21:41.795Z","channels_included_count":2,"created_at":"2017-06-25T08:21:41.795Z","pending_removal":false,"dedicated_channels_count":0},"relationships":{"did_group":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group"},"data":{"type":"did_groups","id":"d04b6466-3d98-4be1-aac5-93ee241f57ca"}},"order":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order"}},"voice_in_trunk":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk"}},"voice_in_trunk_group":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group"}},"capacity_pool":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool"}},"shared_capacity_group":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group"}},"address_verification":{"links":{"self":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/address_verification","related":"https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/address_verification"}}}},"included":[{"id":"d04b6466-3d98-4be1-aac5-93ee241f57ca","type":"did_groups","links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca"},"attributes":{"prefix":"721","local_prefix":"","features":["voice_in"],"is_metered":false,"area_name":"National","allow_additional_channels":true},"relationships":{"country":{"links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/country","related":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/country"}},"city":{"links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/city","related":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/city"}},"did_group_type":{"links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/did_group_type","related":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/did_group_type"}},"region":{"links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/region","related":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/region"}},"stock_keeping_units":{"links":{"self":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/stock_keeping_units","related":"https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/stock_keeping_units"}}}}],"meta":{"total_records":1,"api_version":"2021-12-15"},"links":{"first":"https://api.didww.com/v3/dids?include=did_group\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/dids?include=did_group\u0026page%5Bnumber%5D=34\u0026page%5Bsize%5D=50"}}