Error
A valid request URL is required to generate request examples{
"id": "<string>",
"campaign_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"email": "<string>",
"linkedin_url": "<string>",
"phones": [
{
"number": "+15551234567",
"label": "<string>"
}
],
"primary_number": "<string>",
"status": "not_called",
"call_count": 123,
"last_called_at": "2023-11-07T05:31:56Z",
"last_disposition": {
"id": "<string>",
"name": "Meeting set",
"source": "dialbird",
"system_key": "<string>",
"marks_contact_complete": true
},
"extra_fields": {},
"customer_id": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Campaigns
Fetch a campaign contact
GET
/
campaigns
/
{id}
/
contacts
/
{contactId}
Error
A valid request URL is required to generate request examples{
"id": "<string>",
"campaign_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"title": "<string>",
"email": "<string>",
"linkedin_url": "<string>",
"phones": [
{
"number": "+15551234567",
"label": "<string>"
}
],
"primary_number": "<string>",
"status": "not_called",
"call_count": 123,
"last_called_at": "2023-11-07T05:31:56Z",
"last_disposition": {
"id": "<string>",
"name": "Meeting set",
"source": "dialbird",
"system_key": "<string>",
"marks_contact_complete": true
},
"extra_fields": {},
"customer_id": "<string>",
"due_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"request_id": "<string>",
"field": "<string>"
}
}Authorizations
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.
Response
The campaign contact.
In dial order, E.164.
Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
Show child attributes
Show child attributes
The saved Dialbird contact this campaign contact is linked to, if any.
Was this page helpful?
.png)