curl -X GET "https://api.guayaba.ai/campaigns?status=active" \
-H "X-API-Key: gua_a1b2c3d4_your-api-key-here"
const response = await fetch('https://api.guayaba.ai/campaigns?status=active', {
headers: {
'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'
}
});
const data = await response.json();
import requests
response = requests.get(
'https://api.guayaba.ai/campaigns',
params={'status': 'active'},
headers={'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'}
)
data = response.json()
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Q1 Outreach",
"status": "active"
},
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Follow-up Campaign",
"status": "paused"
}
],
"pagination": {
"total": 5,
"totalPages": 1,
"currentPage": 1,
"limit": 10
}
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key"
}
Campaigns
List Campaigns
Retrieve a paginated list of your campaigns.
GET
/
campaigns
curl -X GET "https://api.guayaba.ai/campaigns?status=active" \
-H "X-API-Key: gua_a1b2c3d4_your-api-key-here"
const response = await fetch('https://api.guayaba.ai/campaigns?status=active', {
headers: {
'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'
}
});
const data = await response.json();
import requests
response = requests.get(
'https://api.guayaba.ai/campaigns',
params={'status': 'active'},
headers={'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'}
)
data = response.json()
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Q1 Outreach",
"status": "active"
},
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Follow-up Campaign",
"status": "paused"
}
],
"pagination": {
"total": 5,
"totalPages": 1,
"currentPage": 1,
"limit": 10
}
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key"
}
Returns simplified campaign data —
id, name, and status — for all campaigns belonging to your team. Use the id values when creating or updating contacts.
Query Parameters
number
default:"1"
Page number for pagination.
number
default:"10"
Number of campaigns to return per page.
string
Filter by campaign status. Accepted values:
active, paused.string
Search campaigns by name. Case-insensitive partial match.
Response
array
object
curl -X GET "https://api.guayaba.ai/campaigns?status=active" \
-H "X-API-Key: gua_a1b2c3d4_your-api-key-here"
const response = await fetch('https://api.guayaba.ai/campaigns?status=active', {
headers: {
'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'
}
});
const data = await response.json();
import requests
response = requests.get(
'https://api.guayaba.ai/campaigns',
params={'status': 'active'},
headers={'X-API-Key': 'gua_a1b2c3d4_your-api-key-here'}
)
data = response.json()
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Q1 Outreach",
"status": "active"
},
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Follow-up Campaign",
"status": "paused"
}
],
"pagination": {
"total": 5,
"totalPages": 1,
"currentPage": 1,
"limit": 10
}
}
{
"error": "Unauthorized",
"message": "Invalid or missing API key"
}