Reference

Endpoints

Every endpoint of the GraphKit REST API v1, with the scope it needs.

Paths are relative to https://app.graphkit.com/api/v1. Every request needs an API key (see Authentication), and the conventions for errors, pagination and idempotency are in Conventions. The machine-readable spec for these endpoints is openapi.json.

EndpointMethodPathScope
Get the current keyGET/meworkspace:read
List accountsGET/accountssenders:read
Get an accountGET/accounts/{id}senders:read
List leadsGET/leadsleads:read
Create or merge a leadPOST/leadsleads:write
Get a leadGET/leads/{id}leads:read
List listsGET/listsleads:read
Create a listPOST/listsleads:write
Add leads to a listPOST/lists/{id}/leadsleads:write
List campaignsGET/campaignscampaigns:read
Get a campaignGET/campaigns/{id}campaigns:read
Get campaign statsGET/campaigns/{id}/statscampaigns:read
Add leads to a campaignPOST/campaigns/{id}/leadscampaigns:write
Pause a campaignPOST/campaigns/{id}/pausecampaigns:write
Resume a campaignPOST/campaigns/{id}/resumecampaigns:write
List conversationsGET/conversationsinbox:read
List messagesGET/conversations/{id}/messagesinbox:read
Send a replyPOST/conversations/{id}/messagesinbox:write
List webhook endpointsGET/webhookswebhooks:manage
Create a webhook endpointPOST/webhookswebhooks:manage
Delete a webhook endpointDELETE/webhooks/{id}webhooks:manage
List event typesGET/webhook-eventsworkspace:read