Skip to main content
GET
https://app.famulor.de/api/
/
user
/
campaigns
List campaigns
curl --request GET \
  --url https://app.famulor.de/api/user/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "id": 1,
      "name": "Q1 2024 New Customer Acquisition",
      "status": "active",
      "max_calls_in_parallel": 5,
      "mark_complete_when_no_leads": true,
      "allowed_hours_start_time": "09:00",
      "allowed_hours_end_time": "18:00",
      "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
      "max_retries": 3,
      "retry_interval": 300,
      "created_at": "2024-01-10T08:00:00Z",
      "updated_at": "2024-01-15T14:30:00Z"
    },
    {
      "id": 2,
      "name": "Existing Customer Follow-up Campaign",
      "status": "paused",
      "max_calls_in_parallel": 3,
      "mark_complete_when_no_leads": false,
      "allowed_hours_start_time": "10:00",
      "allowed_hours_end_time": "17:00",
      "allowed_days": ["monday", "wednesday", "friday"],
      "max_retries": 2,
      "retry_interval": 600,
      "created_at": "2024-01-08T12:00:00Z",
      "updated_at": "2024-01-12T16:45:00Z"
    },
    {
      "id": 3,
      "name": "2024 Product Launch",
      "status": "completed",
      "max_calls_in_parallel": 10,
      "mark_complete_when_no_leads": true,
      "allowed_hours_start_time": "08:00",
      "allowed_hours_end_time": "20:00",
      "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday"],
      "max_retries": 5,
      "retry_interval": 180,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-20T23:59:00Z"
    }
  ]
}
Fetch a complete list of all campaigns you’ve created in your account.

​
Response Fields

​
campaigns
array
Array of campaign objects
{
  "campaigns": [
    {
      "id": 1,
      "name": "Q1 2024 New Customer Acquisition",
      "status": "active",
      "max_calls_in_parallel": 5,
      "mark_complete_when_no_leads": true,
      "allowed_hours_start_time": "09:00",
      "allowed_hours_end_time": "18:00",
      "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday"],
      "max_retries": 3,
      "retry_interval": 300,
      "created_at": "2024-01-10T08:00:00Z",
      "updated_at": "2024-01-15T14:30:00Z"
    },
    {
      "id": 2,
      "name": "Existing Customer Follow-up Campaign",
      "status": "paused",
      "max_calls_in_parallel": 3,
      "mark_complete_when_no_leads": false,
      "allowed_hours_start_time": "10:00",
      "allowed_hours_end_time": "17:00",
      "allowed_days": ["monday", "wednesday", "friday"],
      "max_retries": 2,
      "retry_interval": 600,
      "created_at": "2024-01-08T12:00:00Z",
      "updated_at": "2024-01-12T16:45:00Z"
    },
    {
      "id": 3,
      "name": "2024 Product Launch",
      "status": "completed",
      "max_calls_in_parallel": 10,
      "mark_complete_when_no_leads": true,
      "allowed_hours_start_time": "08:00",
      "allowed_hours_end_time": "20:00",
      "allowed_days": ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday"],
      "max_retries": 5,
      "retry_interval": 180,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-20T23:59:00Z"
    }
  ]
}