Skip to main content

Retrieve a number reservation

GET 
/number_reservations/:number_reservation_id

Gets a single phone number reservation.

Request

Path Parameters

    number_reservation_id stringrequired

    The number reservation ID.

Responses

200: Successful response with details about a number reservation.

default: Unexpected error

Request samples


curl -L 'https://api.telnyx.com/v2/number_reservations/:number_reservation_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"data": {
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"record_type": "number_reservation",
"phone_numbers": [
{
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"record_type": "reserved_phone_number",
"phone_number": "+19705555098",
"status": "pending",
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z",
"expired_at": "2018-01-01T00:00:00.000000Z",
"errors": ""
}
],
"status": "pending",
"customer_reference": "MY REF 001",
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}