Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
DocumentationAPI Reference
Campaigns

List Campaign Recipients

GET
/v1/campaigns/{campaign_id}/recipients

Returns a paginated list of campaign Recipients.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

campaign_id*string

Unique identifier of the related campaign.

Formatuuid

Query Parameters

id?string

Unique identifier for the resource.

Formatuuid
id[in]?array<>

Filters by any of the supplied id values.

Itemsitems <= 10
contact?string

Filters resources by contact.

Formatuuid
contact[in]?array<>

Filters by any of the supplied contact values.

Itemsitems <= 10
channel?string

Filters resources by channel.

Formatuuid
channel[in]?array<>

Filters by any of the supplied channel values.

Itemsitems <= 10
channel_type?"email" | "facebook" | "instagram" | "live_chat" | "postal" | "sms" | "whatsapp"

Filters resources by channel type.

channel_type[in]?array<"email" | "facebook" | "instagram" | "live_chat" | "postal" | "sms" | "whatsapp">

Filters by any of the supplied channel type values.

status?"sent" | "read" | "interacted" | "answered" | "submission_error" | "sending_error" | "bounce_error"

Current status of the resource.

status[in]?array<"sent" | "read" | "interacted" | "answered" | "submission_error" | "sending_error" | "bounce_error">

Filters by any of the supplied status values.

send_after[gte]?string

Only returns resources whose send after is at or after this timestamp (inclusive). See Filtering for timestamp precision.

Formatdate-time
send_after[lte]?string

Only returns resources whose send after is at or before this timestamp (inclusive). See Filtering for timestamp precision.

Formatdate-time
limit?integer

Maximum number of resources to return.

Default10
Range0 <= value <= 100
page_token?string

Opaque token returned by a previous page request.

Length1 <= length
include?array<"contact" | "channel">

Additional fields to include in the response. Use repeated query syntax: include=foo&include=bar.

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/recipients"
{  "object": "list",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",      "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",      "status": "sent",      "error_code": "string",      "channel_id": "bbe8aa76-a4bb-46f6-a785-df8e831cc459",      "channel_type": "email",      "send_after": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "contact": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "display_name": "string",        "full_name": "string",        "salutation": "string",        "birthday": "2019-08-24",        "description": "string",        "external_id": "string",        "secondary_external_id": "string",        "address_line1": "string",        "address_line2": "string",        "city": "string",        "zipcode": "string",        "country": "string",        "is_blocked": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      },      "channel": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",        "name": "string",        "handle": "string",        "type": "email",        "status": "active",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      }    }  ],  "next_page_url": "string",  "previous_page_url": "string"}

Get Campaign Recipient by Locator GET

Returns the requested campaign Recipient by Locator.

List Campaigns GET

Returns a paginated list of campaigns.