Get a target

GET

/api/v1/targets/{target_id}

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

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

target_id

required

Target Id

string

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

TargetResponse

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

name

required

Name

string

org_id

required

Org Id

string

buyer_id

Any of:

string

string

null

null

buyer_name

Any of:

string

string

null

null

type

Any of:

string

string

null

null

number

Any of:

string

string

null

null

sip_endpoint

Any of:

string

string

null

null

sip_username

Any of:

string

string

null

null

sip_password

Any of:

string

string

null

null

sip_headers

Any of:

object

object

key

additional properties

any

null

null

connection_timeout

Any of:

integer

integer

null

null

timezone

Timezone

string

default: America/New_York

is_active

required

Is Active

boolean

max_concurrency

Any of:

integer

integer

null

null

revenue

Any of:

number

number

null

null

payout

Any of:

number

number

null

null

payout_condition

Any of:

string

string

null

null

payout_condition_duration

Any of:

integer

integer

null

null

conversion_scope

required

Conversion Scope

integer

duplicate_conversion_action

Duplicate Conversion Action

string

default: decline

Allowed values: decline route_no_pay route_no_revenue route_no_revenue_no_pay

consider_duplicate

Consider Duplicate

boolean

consider_duplicate_on

Any of:

string

string

null

null

consider_duplicate_length

Any of:

integer

integer

null

null

consider_duplicate_interval

Consider Duplicate Interval

integer

default: 30

disable_recordings

Disable Recordings

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

filters

Any of:

object

object

key

additional properties

any

null

null

hours_of_operation

Any of:

object

object

key

additional properties

any

null

null

external_id

Any of:

string

string

null

null

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

paused_until

Any of:

string

string format: date-time

null

null

paused_at

Any of:

string

string format: date-time

null

null

paused_by

Any of:

string

string

null

null

is_paused

Is Paused

boolean

Example

{
  "sip_headers": {
    "X-Campaign": "sales",
    "X-Trace-Id": "trace-123"
  },
  "timezone": "America/New_York",
  "duplicate_conversion_action": "decline",
  "consider_duplicate": false,
  "consider_duplicate_interval": 30,
  "disable_recordings": false,
  "filters": {
    "enabled": true,
    "groups": [
      {
        "conditions": [
          {
            "field": "state",
            "operator": "in",
            "values": [
              "CA",
              "TX"
            ]
          }
        ]
      }
    ]
  },
  "hours_of_operation": {
    "always_open": false,
    "days": [
      {
        "day": "monday",
        "hours": "custom",
        "isOpen": true,
        "timeRanges": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ]
      }
    ]
  },
  "is_paused": 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"
  }
}