List number pool orders

GET

/api/v1/number-pools/{number_pool_id}/orders

curl --request GET \
  --url https://external-api.moja-ai.com/api/v1/number-pools/example/orders \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

number_pool_id

required

Number Pool Id

string

Responses

200

Successful Response

Media typeapplication/json

NumberPoolOrdersResponse

object

number_pool_id

required

Number Pool Id

Unique identifier for the number pool

string

orders

required

Orders

List of orders for this pool

Array<object>

NumberPoolOrder

object

id

required

Id

Unique identifier for the order record

integer

number_pool_id

required

Number Pool Id

Pool this order belongs to

string

bandwidth_order_id

required

Bandwidth Order Id

Bandwidth order ID

string

order_type

required

Order Type

Order type

string

order_status

required

Order Status

Order status

string

numbers_requested

required

Numbers Requested

Number of numbers requested

integer

numbers_provisioned

required

Numbers Provisioned

Number of numbers successfully provisioned

integer

numbers_failed

required

Numbers Failed

Number of numbers that failed

integer

error_description

Any of:

string

string

null

null

created_at

required

Created At

When the order was created

string format: date-time

completed_at

Any of:

string

string format: date-time

null

null

total

required

Total

Total number of orders

integer

Example^generated

{
  "number_pool_id": "example",
  "orders": [
    {
      "id": 1,
      "number_pool_id": "example",
      "bandwidth_order_id": "example",
      "order_type": "example",
      "order_status": "example",
      "numbers_requested": 1,
      "numbers_provisioned": 1,
      "numbers_failed": 1,
      "error_description": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "completed_at": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

500

Internal server error