Skip to content

List number requests

GET
/v1/organizations/{org}/number-requests
curl --request GET \
--url https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/number-requests \
--header 'Authorization: Bearer <token>'

Lists requests for new phone numbers and port-ins, newest first, including completed and cancelled ones.

org
required
string format: uuid

Organization ID (UUID). Must be the organization that owns the API key.

Number requests.

Media typeapplication/json
object
number_requests
required
Array<object>
object
guid
string
organization_guid
string
requested_by

ID of the user who submitted the request.

string
kind
string
Allowed values: new port
status
string
Allowed values: pending completed cancelled
details

Free-form request details (JSON-serialized size limit 8000 characters). Fields recognized by support depend on kind. For new: cityRateCenter, numberType, vanityPreference, notes. For port: numbersToPort, country, currentCarrier, accountNumber, accountPin, billingPhoneNumber, accountHolderName, authorizedContactName, serviceStreet, serviceCity, serviceRegion, servicePostalCode, desiredPortDate, notes.

object
cityRateCenter
string
numberType
string
vanityPreference
string
numbersToPort
string
country
string
currentCarrier
string
accountNumber
string
accountPin
string
billingPhoneNumber
string
accountHolderName
string
authorizedContactName
string
serviceStreet
string
serviceCity
string
serviceRegion
string
servicePostalCode
string
desiredPortDate
string
notes
string
key
additional properties
any
admin_notes

Notes from Caller 9 support.

string
resolved_by
string | null
resolved_at
string | null format: date-time
created_at
string format: date-time
updated_at
string format: date-time

Example

{
"number_requests": [
{
"kind": "new",
"status": "pending"
}
]
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.