# Sequences

NOTE

The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.

# Retrieve All Sequences

GET https://api.wolfeo.me/sequences

# Example Request

curl --request GET "https://api.wolfeo.me/sequences?api_key=demokey"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls

* denotes a required parameter

# Sample Return

[
    {
        "id": 1,
        "name": "First Sequence",
        "created_at": "2021-01-01 09:00:00",
        "stages_count": 1
    },
    {
        "id": 2,
        "name": "Second Sequence",
        "created_at": "2021-01-01 09:00:00",
        "stages_count": 6
    }
]

# Get An Individual Sequence

GET https://api.wolfeo.me/sequence

# Example Request

curl --request GET "https://api.wolfeo.me/sequence?api_key=demokey&sequence_id=1"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
sequence_id* int A sequence ID

* denotes a required parameter

# Sample Return

{
    "id": 1,
    "name": "First Sequence",
    "created_at": "2021-01-01 09:00:00",
    "stages": [
        {
            "id": 1,
            "step": 1,
            "name": "First Step",
            "stage_type": "send_email",
            "active": false,
            "created_at": "2021-01-01 09:00:00"
        }
    ],
    "stages_count": 1
}

# Get A Contact's Sequences

Returns any sequences a contact is subscribed too.

GET https://api.wolfeo.me/contacts-sequences

# Example Request

curl --request GET "https://api.wolfeo.me/contacts-sequences?api_key=demokey&contact_id=1"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
email** string A contact's email address
contact_id** int A contact's ID

* denotes a required parameter
** at least one of these parameters must be passed

# Sample Return

[
    {
        "id": 1,
        "name": "First Sequence",
        "created_at": "2021-01-01 09:00:00"
    },
    {
        "id": 2,
        "name": "Second Sequence",
        "created_at": "2021-01-01 09:00:00"
    }
]

# Get A Sequence's Contacts

Returns any contacts a sequence has.

GET https://api.wolfeo.me/sequences-contacts

# Example Request

curl --request GET "https://api.wolfeo.me/sequences-contacts?api_key=demokey&sequence_id=1"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
sequence_id* string A sequence's ID

* denotes a required parameter

# Sample Return

[
    {
        "id": 1,
        "email": "first_contact@wolfeo.ie",
        "first_name": "First",
        "last_name": "Contact",
        "GDPR": false,
        "email_marketing": false
    },
    {
        "id": 2,
        "email": "second_contact@wolfeo.ie",
        "first_name": "Second",
        "last_name": "Contact",
        "GDPR": false,
        "email_marketing": false
    }
]

← Orders →