/campaigns/{id} Authentication
Send your organization API key as a Bearer credential.
Authorization: Bearer YOUR_API_KEY Path parameters
id string required UUID of campaign to retrieve
237056d1-20b1-41ab-aa0e-17965cecbe14 Response
application/json Campaign retrieved successfully
id string required ID of campaign
237056d1-20b1-41ab-aa0e-17965cecbe14 index number required Index of campaign
43 name string required Name of campaign
1321 sending_priority string required Sending priority
sequence_emails user_id number required User ID who owns the campaign
1 replies_emails number required Number of replies received
0 opened_emails number required Number of emails opened
0 total_sent number required Total number of sent sequence emails across leads in this campaign
42 id_previous_getting_lead number required ID of previous lead retrieved
0 wait_schedule boolean required Whether schedule waiting is active
false is_message_plain_text boolean required Messages in plain text
false is_open_tracking_disabled boolean required Open tracking disabled
false is_stop_sending_on_reply boolean required Stop sending when reply is detected
true is_stop_sending_on_company_reply boolean required Stop sending when company reply is detected
false status string required Campaign status
Draft created_at string required Campaign creation timestamp
2025-09-17T16:51:25.976Z updated_at string required Campaign update timestamp
2025-09-17T16:51:25.976Z sequences object[] required Sequences of campaign
Show child attributes
sequences.id number required ID of sequence
24 sequences.campaign_id string required Campaign ID the sequence belongs to
237056d1-20b1-41ab-aa0e-17965cecbe14 sequences.delay number required Delay before sending (days)
0 sequences.subject string required Email subject
Follow-up Email sequences.body string required Email body
Just checking if you received my last message. sequences.use_previous_subject boolean required Whether to use subject from previous sequence
false sequences.created_at string required Created at timestamp
2025-09-17T16:51:25.992Z sequences.updated_at string required Updated at timestamp
2025-09-17T16:51:25.992Z schedule any required Schedule of campaign
Invalid request body (e.g. missing required fields, or invalid field values)
message string[] required List of detailed validation or business error messages
["Name cannot be empty", "Field must be greater than 0"] error string required Short error description
Bad Request statusCode number required HTTP status code of the error
400 This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
message string[] required List of messages explaining why the request was unauthorized
["User is not authorized", "Invalid API key"] error string required Short error description
Unauthorized statusCode number required HTTP status code of the error
401 You have exceeded the rate limit. Please check the rate limit docs for more information.
message string[] required List of messages explaining the rate limiting issue
["Too many requests, please try again later"] error string required Short error description
Too Many Requests statusCode number required HTTP status code of the error
429