Reference
Campaigns Read campaigns and their stats, enroll leads, and pause or resume a campaign.
Campaigns are built and launched in the app, where the sequence is validated. The API reads them, adds leads, and pauses or resumes them. Enrollment goes through the same checks as the app: suppressed leads and leads active in another campaign are skipped and counted.
GET /api/v1/campaignsScope campaigns:read
Campaigns newest first, each with enrollment counts. Filter with status.
Name In Type Description cursorquery string Opaque cursor from the previous page's nextCursor. limitquery integer Page size. 1 to 100. Default 50. statusquery string Current status. One of draft, scheduled, active, paused, completed, archived.
curl -s "https://app.graphkit.com/api/v1/campaigns" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY "
Field Type Description dataarray of object The page of results, newest first. data[].idstring (uuid) UUID. data[].namestring data[].descriptionstring or null data[].statusstring Current status. One of draft, scheduled, active, paused, completed, archived. data[].channelsarray of string Channels the sequence uses. data[].dryRunboolean Dry-run campaigns record actions without sending. data[].stopOnReplyboolean A reply on any channel stops the lead. data[].isDemoboolean True for demo data in a demo workspace. data[].launchedAtstring (date-time) or null data[].pausedAtstring (date-time) or null data[].completedAtstring (date-time) or null data[].createdAtstring (date-time) When it was created (RFC 3339, UTC). data[].enrollmentsobject Enrollment counts. data[].enrollments.totalinteger data[].enrollments.activeinteger data[].enrollments.completedinteger data[].enrollments.stoppedinteger nextCursorstring or null Pass back as cursor for the next page; null on the last page.
{
"data" : [
{
"id" : "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" ,
"name" : "Q1 founders, UK" ,
"description" : null ,
"status" : "active" ,
"channels" : [
"string"
],
"dryRun" : false ,
"stopOnReply" : true ,
"isDemo" : false ,
"launchedAt" : "2026-11-15T10:04:05Z" ,
"pausedAt" : null ,
"completedAt" : null ,
"createdAt" : "2026-11-15T10:04:05Z" ,
"enrollments" : {
"total" : 12 ,
"active" : 12 ,
"completed" : 12 ,
"stopped" : 12
}
}
],
"nextCursor" : null
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.
GET /api/v1/campaigns/{id}Scope campaigns:read
One campaign with its enrollment counts.
Name In Type Description idpath string (uuid) The resource id.
curl -s "https://app.graphkit.com/api/v1/campaigns/0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY "
Field Type Description idstring (uuid) UUID. namestring descriptionstring or null statusstring Current status. One of draft, scheduled, active, paused, completed, archived. channelsarray of string Channels the sequence uses. dryRunboolean Dry-run campaigns record actions without sending. stopOnReplyboolean A reply on any channel stops the lead. isDemoboolean True for demo data in a demo workspace. launchedAtstring (date-time) or null pausedAtstring (date-time) or null completedAtstring (date-time) or null createdAtstring (date-time) When it was created (RFC 3339, UTC). enrollmentsobject Enrollment counts. enrollments.totalinteger enrollments.activeinteger enrollments.completedinteger enrollments.stoppedinteger
{
"id" : "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" ,
"name" : "Q1 founders, UK" ,
"description" : null ,
"status" : "active" ,
"channels" : [
"string"
],
"dryRun" : false ,
"stopOnReply" : true ,
"isDemo" : false ,
"launchedAt" : "2026-11-15T10:04:05Z" ,
"pausedAt" : null ,
"completedAt" : null ,
"createdAt" : "2026-11-15T10:04:05Z" ,
"enrollments" : {
"total" : 12 ,
"active" : 12 ,
"completed" : 12 ,
"stopped" : 12
}
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.404 not_found: no such resource in this key's workspace.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.
GET /api/v1/campaigns/{id}/statsScope campaigns:read
The same metrics as the app's analytics page for this campaign: totals for the range, totals for the previous range of the same length, and one row per day. Days are local to the workspace time zone.
Pass from and to (YYYY-MM-DD, inclusive), or days for the last N days. The default is the last 30 days. Metric definitions are in Analytics . Rates are null when their denominator is 0.
Name In Type Description idpath string (uuid) The resource id. fromquery string (date) First day (inclusive, local to the workspace). Send with to. toquery string (date) Last day (inclusive). daysquery integer Last N days ending today, when from/to are absent. 1 to 366.
curl -s "https://app.graphkit.com/api/v1/campaigns/0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99/stats?days=30" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY "
Field Type Description campaignIdstring (uuid) Campaign id. rangeobject The range the totals cover. range.fromstring (date) range.tostring (date) range.daysinteger One row per local day. range.timezonestring totalsobject Totals for the range. totals.invitesSentinteger LinkedIn invitations sent. totals.invitesAcceptedinteger Invites sent in the range whose lead later connected with the same account. totals.acceptanceRatenumber or null invitesAccepted / invitesSent, or null with no invites.totals.messagesSentinteger campaignMessages + manualMessages.totals.campaignMessagesinteger Message and voice-note steps that succeeded. totals.manualMessagesinteger Messages sent by teammates or the API. totals.inmailsSentinteger InMails sent. totals.profileVisitsinteger LinkedIn profile visits. totals.followsinteger Follows. totals.likesinteger Post reactions. totals.contactedinteger Conversations with an outbound message in the range. totals.repliesinteger Conversations whose first inbound message in the range follows an outbound one. totals.replyRatenumber or null replies / contacted, or null.totals.positiveRepliesinteger Replies in conversations labelled Interested, Positive, Meeting booked, Hot lead, Qualified or similar. totals.positiveRatenumber or null positiveReplies / replies, or null.totals.messagesReceivedinteger Inbound messages. totals.newConnectionsinteger New LinkedIn connections. totals.failedActionsinteger Steps that ended failed. totals.emailHandoffsinteger Leads handed to a connected email platform (succeeded email_handoff steps). totals.emailRepliesinteger First email reply per lead, connection and platform campaign, as reported by the email platform (source = platform). Not included in replies. previousTotalsobject Totals for the previous range of the same length. Same fields as totals. daysarray of object One row per local day. days[].invitesSentinteger LinkedIn invitations sent. days[].invitesAcceptedinteger Invites sent in the range whose lead later connected with the same account. days[].acceptanceRatenumber or null invitesAccepted / invitesSent, or null with no invites.days[].messagesSentinteger campaignMessages + manualMessages.days[].campaignMessagesinteger Message and voice-note steps that succeeded. days[].manualMessagesinteger Messages sent by teammates or the API. days[].inmailsSentinteger InMails sent. days[].profileVisitsinteger LinkedIn profile visits. days[].followsinteger Follows. days[].likesinteger Post reactions. days[].contactedinteger Conversations with an outbound message in the range. days[].repliesinteger Conversations whose first inbound message in the range follows an outbound one. days[].replyRatenumber or null replies / contacted, or null.days[].positiveRepliesinteger Replies in conversations labelled Interested, Positive, Meeting booked, Hot lead, Qualified or similar. days[].positiveRatenumber or null positiveReplies / replies, or null.days[].messagesReceivedinteger Inbound messages. days[].newConnectionsinteger New LinkedIn connections. days[].failedActionsinteger Steps that ended failed. days[].emailHandoffsinteger Leads handed to a connected email platform (succeeded email_handoff steps). days[].emailRepliesinteger First email reply per lead, connection and platform campaign, as reported by the email platform (source = platform). Not included in replies. days[].datestring (date) Local day.
{
"campaignId" : "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" ,
"range" : {
"from" : "2026-11-15" ,
"to" : "2026-11-15" ,
"days" : 12 ,
"timezone" : "Europe/London"
},
"totals" : {
"invitesSent" : 12 ,
"invitesAccepted" : 12 ,
"acceptanceRate" : 0.25 ,
"messagesSent" : 12 ,
"campaignMessages" : 12 ,
"manualMessages" : 12 ,
"inmailsSent" : 12 ,
"profileVisits" : 12 ,
"follows" : 12 ,
"likes" : 12 ,
"contacted" : 12 ,
"replies" : 12 ,
"replyRate" : 0.25 ,
"positiveReplies" : 12 ,
"positiveRate" : 0.25 ,
"messagesReceived" : 12 ,
"newConnections" : 12 ,
"failedActions" : 12 ,
"emailHandoffs" : 12 ,
"emailReplies" : 12
},
"previousTotals" : {
"invitesSent" : 12 ,
"invitesAccepted" : 12 ,
"acceptanceRate" : 0.25 ,
"messagesSent" : 12 ,
"campaignMessages" : 12 ,
"manualMessages" : 12 ,
"inmailsSent" : 12 ,
"profileVisits" : 12 ,
"follows" : 12 ,
"likes" : 12 ,
"contacted" : 12 ,
"replies" : 12 ,
"replyRate" : 0.25 ,
"positiveReplies" : 12 ,
"positiveRate" : 0.25 ,
"messagesReceived" : 12 ,
"newConnections" : 12 ,
"failedActions" : 12 ,
"emailHandoffs" : 12 ,
"emailReplies" : 12
},
"days" : [
{
"invitesSent" : 12 ,
"invitesAccepted" : 12 ,
"acceptanceRate" : 0.25 ,
"messagesSent" : 12 ,
"campaignMessages" : 12 ,
"manualMessages" : 12 ,
"inmailsSent" : 12 ,
"profileVisits" : 12 ,
"follows" : 12 ,
"likes" : 12 ,
"contacted" : 12 ,
"replies" : 12 ,
"replyRate" : 0.25 ,
"positiveReplies" : 12 ,
"positiveRate" : 0.25 ,
"messagesReceived" : 12 ,
"newConnections" : 12 ,
"failedActions" : 12 ,
"emailHandoffs" : 12 ,
"emailReplies" : 12 ,
"date" : "2026-11-15"
}
]
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.404 not_found: no such resource in this key's workspace.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.
POST /api/v1/campaigns/{id}/leadsScope campaigns:write
Adds leads as pending enrollments at the entry step, with leadIds (1 to 1000) or every lead of listId. The scheduler starts them inside the campaign's sending windows.
Leads already in the campaign, suppressed leads and leads active in another campaign of the workspace are skipped and counted. Completed and archived campaigns return 409 invalid_state.
Name In Type Description idpath string (uuid) The resource id. Idempotency-Keyheader string Replays the stored response for 24 hours (header Idempotent-Replayed: true). Reusing a key with a different request is 422; while the first request runs, 409. Up to 255 characters.
leadIds (1–1000); campaigns also accept listId instead.
Field Type Required Description leadIdsarray of string (uuid) No Lead ids. Up to 1000 items. listIdstring (uuid) No Only leads in this list.
curl -s -X POST "https://app.graphkit.com/api/v1/campaigns/0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99/leads" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY " \
-H "Idempotency-Key: $( uuidgen )" \
-H "Content-Type: application/json" \
-d '{"listId":"0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99"}'
Field Type Description addedinteger New pending enrollments. alreadyPresentinteger Leads already enrolled in this campaign. suppressedinteger Leads skipped because one of their identities is suppressed (opt-out, blocklist). activeElsewhereinteger Leads skipped because they are active in another campaign of the workspace. unknownLeadIdsarray of string (uuid)
{
"added" : 12 ,
"alreadyPresent" : 12 ,
"suppressed" : 12 ,
"activeElsewhere" : 12 ,
"unknownLeadIds" : []
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.404 not_found: no such resource in this key's workspace.400 invalid_lead_ids: Neither leadIds nor listId, or more than 1000 ids.400 invalid_list_id: listId is not a valid id.409 invalid_state: The campaign is completed or archived.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.
POST /api/v1/campaigns/{id}/pauseScope campaigns:write
Pauses an active or scheduled campaign. Leads keep their place and continue from it on resume.
Name In Type Description idpath string (uuid) The resource id. Idempotency-Keyheader string Replays the stored response for 24 hours (header Idempotent-Replayed: true). Reusing a key with a different request is 422; while the first request runs, 409. Up to 255 characters.
curl -s -X POST "https://app.graphkit.com/api/v1/campaigns/0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99/pause" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY " \
-H "Idempotency-Key: $( uuidgen )"
Field Type Description idstring (uuid) UUID. namestring descriptionstring or null statusstring Current status. One of draft, scheduled, active, paused, completed, archived. channelsarray of string Channels the sequence uses. dryRunboolean Dry-run campaigns record actions without sending. stopOnReplyboolean A reply on any channel stops the lead. isDemoboolean True for demo data in a demo workspace. launchedAtstring (date-time) or null pausedAtstring (date-time) or null completedAtstring (date-time) or null createdAtstring (date-time) When it was created (RFC 3339, UTC). enrollmentsobject Enrollment counts. enrollments.totalinteger enrollments.activeinteger enrollments.completedinteger enrollments.stoppedinteger
{
"id" : "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" ,
"name" : "Q1 founders, UK" ,
"description" : null ,
"status" : "active" ,
"channels" : [
"string"
],
"dryRun" : false ,
"stopOnReply" : true ,
"isDemo" : false ,
"launchedAt" : "2026-11-15T10:04:05Z" ,
"pausedAt" : null ,
"completedAt" : null ,
"createdAt" : "2026-11-15T10:04:05Z" ,
"enrollments" : {
"total" : 12 ,
"active" : 12 ,
"completed" : 12 ,
"stopped" : 12
}
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.404 not_found: no such resource in this key's workspace.409 invalid_state: The campaign is not active or scheduled.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.
POST /api/v1/campaigns/{id}/resumeScope campaigns:write
Resumes a paused campaign and emits campaign.started. Draft campaigns are launched in the app, where the sequence is validated.
Name In Type Description idpath string (uuid) The resource id. Idempotency-Keyheader string Replays the stored response for 24 hours (header Idempotent-Replayed: true). Reusing a key with a different request is 422; while the first request runs, 409. Up to 255 characters.
curl -s -X POST "https://app.graphkit.com/api/v1/campaigns/0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99/resume" \
-H "Authorization: Bearer $GRAPHKIT_API_KEY " \
-H "Idempotency-Key: $( uuidgen )"
Field Type Description idstring (uuid) UUID. namestring descriptionstring or null statusstring Current status. One of draft, scheduled, active, paused, completed, archived. channelsarray of string Channels the sequence uses. dryRunboolean Dry-run campaigns record actions without sending. stopOnReplyboolean A reply on any channel stops the lead. isDemoboolean True for demo data in a demo workspace. launchedAtstring (date-time) or null pausedAtstring (date-time) or null completedAtstring (date-time) or null createdAtstring (date-time) When it was created (RFC 3339, UTC). enrollmentsobject Enrollment counts. enrollments.totalinteger enrollments.activeinteger enrollments.completedinteger enrollments.stoppedinteger
{
"id" : "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99" ,
"name" : "Q1 founders, UK" ,
"description" : null ,
"status" : "active" ,
"channels" : [
"string"
],
"dryRun" : false ,
"stopOnReply" : true ,
"isDemo" : false ,
"launchedAt" : "2026-11-15T10:04:05Z" ,
"pausedAt" : null ,
"completedAt" : null ,
"createdAt" : "2026-11-15T10:04:05Z" ,
"enrollments" : {
"total" : 12 ,
"active" : 12 ,
"completed" : 12 ,
"stopped" : 12
}
}
Status Code and meaning 401 invalid_api_key: the key is missing, unknown or revoked.403 insufficient_scope: the key lacks the scope this endpoint needs.404 not_found: no such resource in this key's workspace.402 payment_overdue: The organization is past the payment grace period, so launches are blocked.409 invalid_state: The campaign is not paused.429 rate_limited: more than 300 requests in a minute; wait for Retry-After.