Skip to main content
GET
/
drip_campaigns
Fetch drip campaigns
curl --request GET \
  --url https://api.paubox.net/v1/orca/{username}/drip_campaigns \
  --header 'authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "type": "drip_campaign",
      "attributes": {
        "name": "<string>",
        "subscription_list_id": "<string>",
        "subscription_list_name": "<string>",
        "state": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "start_trigger": "<string>",
        "subscriber_count": 123,
        "subscriber_completed_count": 123
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
authorization
string
header
required

Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key

Query Parameters

​
search
string

Regex string to search on. Compares against drip campaign name

​
order_by
string
default:created_at

Attribute to sort on. Default value is created_at

​
order
enum<string>
default:desc

Direction to sort. Default value is descending

Available options:
asc,
desc

Response

Drip campaigns data

​
data
object[]