# Tags

NOTE

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

# Retrieve All Tags

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

# Example Request

curl --request GET "https://api.wolfeo.me/tags?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 Tag",
        "created_at": "2021-01-01 09:00:00"
    },
    {
        "id": 2,
        "name": "Second Tag",
        "created_at": "2021-01-01 09:00:00"
    }
]

# Get A Contact's Tags

Returns any tags a contact has.

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

# Example Request

curl --request GET "https://api.wolfeo.me/contacts-tags?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 Tag",
        "created_at": "2021-01-01 09:00:00"
    },
    {
        "id": 2,
        "name": "Second Tag",
        "created_at": "2021-01-01 09:00:00"
    }
]

# Get A Tags Contacts

Returns any contacts a tag has.

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

# Example Request

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

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
tag_id* string A tag'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
    }
]

← Sequences →