Get a number pool

GET

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

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

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

number_pool_id

required

Number Pool Id

string

Query Parameters

include_numbers

Include Numbers

Whether to include phone numbers in the response

boolean

Whether to include phone numbers in the response

Responses

200

Successful Response

Media typeapplication/json

NumberPoolResponse

object

number_pool_id

required

Number Pool Id

Unique identifier for the number pool

string

org_id

required

Org Id

Unique identifier for the organization

string

name

required

Name

Name of the number pool

string

country

required

Country

Country for the number pool

string

Allowed values: US

closed_browser_delay

required

Closed Browser Delay

Delay in minutes before releasing number after browser close

number

browser_idle_limit

required

Browser Idle Limit

Delay in minutes before releasing number after browser idle

number

size

required

Size

Number of phone numbers to allocate to this number pool

integer

number_type

required

NumberType

Type of numbers (toll_free or local)

string

Allowed values: local toll_free

prefix

Any of:

string

string

null

null

city

Any of:

string

string

null

null

state

Any of:

string

string

null

null

zip

Any of:

string

string

null

null

is_active

required

Is Active

Whether the number pool is active

boolean

provisioning_status

Provisioning Status

Overall pool provisioning status

string

default: complete

has_pending_orders

Has Pending Orders

Whether pool has pending expansion orders

boolean

provisioning_error

Any of:

string

string

null

null

created_at

required

Created At

Time when the number pool was created

string format: date-time

updated_at

required

Updated At

Time when the number pool was last updated

string format: date-time

deleted_at

Any of:

string

string format: date-time

null

null

statistics

Any of:

NumberPoolStatisticsResponse

NumberPoolStatisticsResponse

object

total_numbers

required

Total Numbers

Total number of numbers in the number pool

integer

allocated_numbers

required

Allocated Numbers

Number of allocated numbers in the number pool

integer

available_numbers

required

Available Numbers

Number of available numbers in the number pool

integer

impressions_per_day

required

Impressions Per Day

Number of impressions per day

integer

misses_per_day

required

Misses Per Day

Number of misses per day

integer

impressions_per_month

required

Impressions Per Month

Number of impressions per month

integer

misses_per_month

required

Misses Per Month

Number of misses per month

integer

utilization_rate

required

Utilization Rate

Utilization rate of the number pool

number

null

null

numbers

Any of:

Array<object>

Array<object>

NumberPoolNumberResponse

object

id

required

Id

Unique identifier for the entry in the number pool numbers table

integer

number_pool_id

required

Number Pool Id

Unique identifier for the number pool this number belongs to

string

number_id

required

Number Id

Unique identifier for the number

string

phone_number

required

Phone Number

Phone number

string

is_allocated

required

Is Allocated

Whether the number is allocated

boolean

allocated_to_snippet_id

Any of:

string

string

null

null

allocated_to_visitor_id

Any of:

string

string

null

null

allocated_at

Any of:

string

string format: date-time

null

null

expires_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

Time when the number was created

string format: date-time

null

null

Example

{
  "country": "US",
  "number_type": "local",
  "provisioning_status": "complete",
  "has_pending_orders": false
}

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