Get a number

GET

/api/v1/numbers/{number_id}

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

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

number_id

required

Number Id

string

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

NumberResponse

object

id

required

Id

string

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

number_id

Any of:

string

string

null

null

org_id

required

Org Id

string

number

required

Number

string

name

Any of:

string

string

null

null

labels

Labels

Array<object>

NumberLabelRef

object

id

required

Id

string

name

required

Name

string

display_name

required

Display Name

string

status

Any of:

string

string

null

null

site_id

Any of:

string

string

null

null

order_status

Any of:

string

string

null

null

final_destination_uri

Any of:

string

string

null

null

campaign_id

Any of:

string

string

null

null

campaign

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

publisher_id

Any of:

string

string

null

null

publisher

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

phone_type

Any of:

string

string

null

null

hourly

Hourly

integer

0

daily

Daily

integer

0

weekly

Weekly

integer

0

monthly

Monthly

integer

0

yearly

Yearly

integer

0

total

Total

integer

0

payout

Any of:

number

number

null

null

payout_condition

Any of:

string

string

null

null

payout_condition_duration

Any of:

integer

integer

null

null

provider

Any of:

string

string

null

null

is_active

Is Active

boolean

default: true

order_date

Any of:

string

string format: date-time

null

null

external_id

Any of:

string

string

null

null

imported

Imported

boolean

imported_replaced_number

Any of:

string

string

null

null

Example

{
  "hourly": 0,
  "daily": 0,
  "weekly": 0,
  "monthly": 0,
  "yearly": 0,
  "total": 0,
  "is_active": true,
  "imported": 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"
  }
}