Skip to content
Moja AI Help

List publishers

GET
/api/v1/publishers
curl --request GET \
  --url 'https://external-api.moja-ai.com/api/v1/publishers?limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 20 >= 1 <= 200
offset
Offset
integer
0

Header Parameters

Section titled “Header Parameters”
X-API-Key
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PublisherListResponse
object
data
required
Data
Array<object>
PublisherResponse
object
id
required
Id
string
org_id
required
Org Id
string
name
required
Name
string
street_address
required
Street Address
string
city
required
City
string
state
required
State
string
zip_code
required
Zip Code
string
country
required
Country
string
phone_number
required
Phone Number
string
email
required
Email
string
website
required
Website
string
timezone
required
Timezone
string
block_calls_if_capped
required
Block Calls If Capped
boolean
access_to_call_recordings
required
Access To Call Recordings
boolean
disable_recordings
Disable Recordings
boolean
is_active
required
Is Active
boolean
hourly
Hourly
integer
0
daily
Daily
integer
0
weekly
Weekly
integer
0
monthly
Monthly
integer
0
yearly
Yearly
integer
0
total
Total
integer
0
everflow_affiliate_id
Any of:
string
external_id
Any of:
string
created_at
Any of:
string format: date-time
updated_at
Any of:
string format: date-time
advanced_caps
Advanced Caps
Array<object>
object
key
additional properties
any
meta
required
PaginatedResponseMeta
object
limit
required
Limit
integer
offset
required
Offset
integer
count
required
Count
integer
total
required
Total
integer
has_more
required
Has More
boolean
next_offset
Any of:
integer
previous_offset
Any of:
integer
Example
{
  "data": [
    {
      "disable_recordings": false,
      "hourly": 0,
      "daily": 0,
      "weekly": 0,
      "monthly": 0,
      "yearly": 0,
      "total": 0
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404”

Not Found

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409”

Conflict

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Section titled “429”

Too Many Requests

Media typeapplication/json
ErrorResponse
object
detail
required
ErrorBody
object
code
required
Code
string
message
required
Message
string
Examplegenerated
{
  "detail": {
    "code": "example",
    "message": "example"
  }
}