Getting started

The API connects your backend to a workspace’s contacts, audiences, events and email. It uses the same permission, consent and capacity checks as the dashboard.

Prepare the connection

1. Get the workspace identifier from Settings → Workspace.
2. An owner or administrator creates an integration and issues a key in Developers.
3. Store the secret on your server and grant only the permissions you need.
4. Obtain your environment’s API service base URL from the operator.

In examples, SENDIRO_API_BASE is that base URL without /v1 or a trailing slash; SENDIRO_WORKSPACE_ID and SENDIRO_API_KEY hold your environment values. Integration routes start with /v1/workspaces/{workspaceId}.

Check access

With contacts:read, request the first page:

curl "$SENDIRO_API_BASE/v1/workspaces/$SENDIRO_WORKSPACE_ID/contacts?limit=10" \
  -H "Authorization: Bearer $SENDIRO_API_KEY"

The response includes data, nextCursor and requestId. Continue with the returned cursor until it is null. Read API conventions before implementing writes.

Choose an operation

• Contacts: create profiles, synchronize by email, import and manage consent.
• Custom fields and audiences: define data and groups.
• Sending email: accept a message and inspect progress.
• Events, analytics and webhooks: trigger journeys and observe results.

Keys cannot administer designs, broadcasts, automations, members or billing. Prepare those resources in the dashboard. Valid permissions also require configured transport and available product capacity.