Skip to content

Own configuration snapshot

GET
/v1/tenant
curl https://api.pacepayments.ai/v1/tenant \
--header 'Authorization: Bearer <token>'

Successful Response

Media typeapplication/json
TenantInfo

Your own configuration - read-only.

Capacity limits start deliberately conservative and are raised after the first supervised campaign. Read them here at RUNTIME rather than hard-coding them in your own system.

object
tenant_id
required
Tenant Id
string
name
Any of:
string
environment
required
Environment

Check this against event.environment BEFORE processing a webhook - never mix the two streams.

string
default_locale
Any of:
string
verification_mode
Any of:
string
calling_hours
Any of:
object
key
additional properties
any
quotas
TenantQuotas
object
max_concurrent_calls
Any of:
integer
max_dials_per_day
Any of:
integer
max_contacts_per_subject_per_day
Any of:
integer
retention
required
TenantRetention
object
transcript_mode
required
Transcript Mode
string
transcript_retention
Any of:
string
recording_retention
Any of:
string
result_months
required
Result Months
integer
>= 1
features
TenantFeatures
object
recording_enabled
Any of:
boolean
sequences_enabled
Any of:
boolean
webhook_egress_ips
Any of:
Array<string>
Examplegenerated
{
"tenant_id": "example",
"name": "example",
"environment": "example",
"default_locale": "example",
"verification_mode": "example",
"calling_hours": {},
"quotas": {
"max_concurrent_calls": 1,
"max_dials_per_day": 1,
"max_contacts_per_subject_per_day": 1
},
"retention": {
"transcript_mode": "example",
"transcript_retention": "example",
"recording_retention": "example",
"result_months": 1
},
"features": {
"recording_enabled": true,
"sequences_enabled": true
},
"webhook_egress_ips": [
"example"
]
}

No valid access token. Client action: request a new token from the token endpoint and retry once. Repeated 401 with a fresh token means the client registration is disabled - contact Pace, do not retry in a loop.

Media typeapplication/problem+json
Problem
object
type
required
Type
string
title
required
Title
string
status
required
Status
integer
code
required
Code
string
detail
Any of:
string
instance
Any of:
string
trace_id
Any of:
string
errors
Any of:
Array<object>
FieldError
object
pointer
required
Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string
code
required
Code

Stable field error code (open registry).

string
message
Any of:
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"instance": "example",
"trace_id": "example",
"errors": [
{
"pointer": "example",
"code": "example",
"message": "example"
}
]
}

Authenticated but not permitted. insufficient_scope names the missing scope in detail; feature_not_enabled means the tenant lacks the feature; ip_not_allowlisted means the source IP is not on the client registration’s allowlist; simulate_not_allowed means a sandbox-only simulate block was sent to the live host. None of these are retryable.

Media typeapplication/problem+json
Problem
object
type
required
Type
string
title
required
Title
string
status
required
Status
integer
code
required
Code
string
detail
Any of:
string
instance
Any of:
string
trace_id
Any of:
string
errors
Any of:
Array<object>
FieldError
object
pointer
required
Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string
code
required
Code

Stable field error code (open registry).

string
message
Any of:
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"instance": "example",
"trace_id": "example",
"errors": [
{
"pointer": "example",
"code": "example",
"message": "example"
}
]
}

HTTP rate limit (rate_limited) or execution capacity refusal (quota_exceeded, backlog_full) - two distinct layers. Wait for Retry-After, then retry the identical request with the same Idempotency-Key. backlog_full will not clear in seconds; back off to minutes.

Media typeapplication/problem+json
Problem
object
type
required
Type
string
title
required
Title
string
status
required
Status
integer
code
required
Code
string
detail
Any of:
string
instance
Any of:
string
trace_id
Any of:
string
errors
Any of:
Array<object>
FieldError
object
pointer
required
Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string
code
required
Code

Stable field error code (open registry).

string
message
Any of:
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"instance": "example",
"trace_id": "example",
"errors": [
{
"pointer": "example",
"code": "example",
"message": "example"
}
]
}
Retry-After
integer

Seconds until the next attempt is permitted.

RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer

Error (RFC 9457). Branch on code, never on title or detail.

Media typeapplication/problem+json
Problem
object
type
required
Type
string
title
required
Title
string
status
required
Status
integer
code
required
Code
string
detail
Any of:
string
instance
Any of:
string
trace_id
Any of:
string
errors
Any of:
Array<object>
FieldError
object
pointer
required
Pointer

RFC 6901 pointer to the offending field in the request body. Errors outside the body carry their source as the first segment (e.g. /query/limit).

string
code
required
Code

Stable field error code (open registry).

string
message
Any of:
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"code": "example",
"detail": "example",
"instance": "example",
"trace_id": "example",
"errors": [
{
"pointer": "example",
"code": "example",
"message": "example"
}
]
}