Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization Code flow against Dialbird's OIDC provider. The issued access token is a JWT with aud: "public-api", verified against the issuer JWKS.

FlowAuthorization Code
Authorization URL
https://app-staging.dialbird.io/oidc/auth
Token URL
https://app-staging.dialbird.io/oidc/token
Refresh URL
https://app-staging.dialbird.io/oidc/token
Scopes1
api:campaigns:read
Read campaigns, their contacts, and dispositions.

Path Parameters

id
string
required

The campaign id.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's next_cursor.

status
enum<string>

completed once a disposition that completes the contact is picked; do_not_call contacts are never dialed.

Available options:
not_called,
in_progress,
called,
completed,
do_not_call
disposition_id
string

Response

One page of campaign contacts.

data
object[]
required
next_cursor
string | null
required