API Documentation

Programmatic access to your platform

Authentication

All requests require a Bearer token in the Authorization header. Generate an API key from your Settings page.

Authorization: Bearer sk_your_api_key_here

Base URL

Your API base URL is https://api.{your-subdomain}

Endpoints

POST/people

Create a new person in your database.

Parameter	Type	Description
name required	string	Full name
email	string	Email address
mobile	string	Mobile phone number
address_line1	string	Street address
address_line2	string	Apt, suite, etc.
address_city	string	City
address_state	string	State or province
address_zip	string	Postal code
address_country	string	Country

Example request:

curl -X POST https://api.{your-subdomain}/people \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Jane Smith", "email": "jane@example.com"}'

Example response:

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Jane Smith",
  "email": "jane@example.com",
  "mobile": null
}

POST/sequences/:sequence_id/enrollments

Enroll a person in a sequence.

Parameter	Type	Description
sequence_id required	string	UUID of the sequence (in URL)
person_id required	string	UUID of the person to enroll

Example request:

curl -X POST https://api.{your-subdomain}/sequences/SEQ_ID/enrollments \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"person_id": "PERSON_ID"}'

Example response:

{
  "id": "enrollment-uuid",
  "sequence_id": "sequence-uuid",
  "person_id": "person-uuid",
  "status": "active"
}

Errors

Status	Meaning
201	Created successfully
401	Missing or invalid API key
404	Resource not found
422	Validation error (check response body)
500	Server error