Overview
Auth
- POSTCreate a new API key for the authenticated tenant.
- GETList all API keys for the authenticated tenant.
- GETGet details of a specific API key.
- POSTRotate an API key. Creates a new key and revokes the old one.
- DELRevoke an API key. The key is immediately invalidated.
- GETGet information about the authenticated tenant.
- PATCHUpdate tenant information (name).
- GETList audit log entries for the authenticated tenant.
- POSTCreate a Stripe Checkout session for tenant provisioning.
- GETRetrieve a provisioned API key after Stripe Checkout. The claim token (checkout session ID) acts as the access credential. One-time retrieval only — the key cannot be shown again.
Contacts
- GETList contacts with optional filtering by kind, search query, and pagination.
- POSTCreate a new contact.
- GETGet a contact by ID with all related data (channels, addresses, dates, tags, affiliations).
- PUTUpdate a contact.
- DELSoft-delete a contact.
- GETFind a contact by communication channel (type + value).
- POSTAdd a communication channel to a contact.
- DELRemove a communication channel from a contact.
- POSTAdd a postal address to a contact.
- PUTUpdate a postal address.
- DELRemove a postal address from a contact.
- POSTAdd a significant date to a contact (birthday, anniversary, etc.).
- PUTUpdate a significant date.
- DELRemove a significant date from a contact.
- GETList relationships for a contact.
- POSTAdd a relationship between two contacts.
- DELRemove a relationship.
- GETList organizational affiliations for a contact.
- POSTAdd an organizational affiliation to a contact.
- DELRemove an organizational affiliation.
- GETList interactions for a contact.
- POSTLog an interaction with a contact.
- POSTAdd a tag to a contact.
- DELRemove a tag from a contact.
- GETList all contact tag definitions for the tenant.
- POSTCreate a new contact tag definition.
- GETList all contact groups for the tenant.
- POSTCreate a new contact group.
- DELDelete a contact group.
- GETList members of a contact group.
- POSTAdd a contact to a group.
- DELRemove a contact from a group.
- GETList all relationship types for the tenant.
CRM
- GETList all CRM pipelines with their stages.
- POSTCreate a new pipeline, optionally with initial stages.
- GETGet a pipeline by ID with its stages.
- PUTUpdate a pipeline.
- DELDelete a pipeline (soft delete).
- POSTSet a pipeline as the default.
- GETList stages in a pipeline.
- POSTCreate a new stage in a pipeline.
- PUTReorder stages in a pipeline.
- PUTUpdate a stage.
- DELDelete a stage from a pipeline.
- GETGet a pipeline summary with deal counts and values per stage.
- GETList deals with optional filtering.
- POSTCreate a new deal.
- GETGet a deal by ID with pipeline, stage, and contact details.
- PUTUpdate a deal.
- DELDelete a deal (soft delete).
- POSTMove a deal to a different stage. Records a stage change audit entry.
- GETGet stage change history for a deal.
- GETList contacts associated with a deal.
- POSTAssociate a contact with a deal.
- DELRemove a contact from a deal.
- POSTAdd a tag to a deal.
- DELRemove a tag from a deal.
- GETList all CRM tag definitions.
- POSTCreate a new CRM tag definition.
Tasks
- GETList projects with optional filtering.
- POSTCreate a new project.
- GETGet a project by ID with statuses, sections, milestones, and counts.
- PUTUpdate a project.
- DELDelete a project (soft delete).
- GETList custom statuses for a project.
- POSTAdd a custom status to a project.
- PUTUpdate a project status.
- DELRemove a status from a project.
- GETList sections in a project.
- POSTAdd a section to a project.
- PUTUpdate a project section.
- DELRemove a section from a project.
- GETList milestones in a project.
- POSTAdd a milestone to a project.
- PUTUpdate a milestone.
- DELRemove a milestone.
- GETList members of a project.
- POSTAdd a member to a project.
- DELRemove a member from a project.
- GETList tasks with optional filtering.
- POSTCreate a new task.
- GETGet a task by ID with labels, dependency/link/comment counts.
- PUTUpdate a task.
- DELDelete a task (soft delete).
- GETGet a task by its human-readable identifier (e.g., PROJ-42).
- GETList overdue tasks.
- POSTMark a task as complete.
- POSTCancel a task.
- GETList subtasks of a task.
- GETList dependencies of a task.
- POSTAdd a dependency to a task.
- DELRemove a dependency from a task.
- GETList comments on a task.
- POSTAdd a comment to a task.
- PUTUpdate a task comment.
- POSTAdd a label to a task.
- DELRemove a label from a task.
- GETList cross-domain links for a task.
- POSTAdd a cross-domain link to a task.
- DELRemove a cross-domain link from a task.
- GETList all task label definitions for the tenant.
- POSTCreate a new task label definition.
Calendar
- GETList calendars for the authenticated tenant.
- POSTCreate a new calendar.
- GETGet a calendar by ID.
- PUTUpdate a calendar.
- DELDelete a calendar (soft delete).
- GETList events with optional filtering by date range, calendar, and type.
- POSTCreate a new event.
- GETGet an event by ID with attendees and links.
- PUTUpdate an event.
- DELDelete an event (soft delete).
- GETFull-text search across events.
- POSTAdd an attendee to an event.
- PUTUpdate an attendee's RSVP status.
- DELRemove an attendee from an event.
- POSTAdd a cross-domain link to an event.
- DELRemove a cross-domain link from an event.
Notes
- GETList all notebooks for the tenant with note counts.
- POSTCreate a new notebook.
- GETGet a notebook by ID with note count.
- PUTUpdate a notebook.
- DELDelete a notebook (soft delete).
- GETList notes with optional filtering by notebook, tag, and search.
- POSTCreate a new note.
- GETGet a note by ID with tags and link counts.
- PUTUpdate a note.
- DELDelete a note (soft delete).
- GETList outgoing links from a note.
- POSTAdd a link from a note to another entity.
- DELRemove a link from a note.
- GETList notes that link to a given note (backlinks).
- GETList notes that link to any entity (cross-domain backlinks).
- POSTAdd a tag to a note (creates the tag if it does not exist).
- DELRemove a tag from a note.
- GETList attachments for a note.
- POSTAdd an attachment to a note.
- DELRemove an attachment from a note.
- GETList all note tag definitions for the tenant.
- POSTCreate a new note tag definition.
Billing & Usage
Health
- GETHealth check — verifies database and Redis connectivity. Returns 200 if all checks pass, 503 if any fail. Traefik uses this for load balancing decisions.
- GETReadiness probe — returns 200 only when the application has completed startup. Deploy scripts use this to verify an instance is ready before routing traffic.
Get an event by ID with attendees and links.
curl --request GET \
--url https://api.backside.app/api/v1/events/{id} \
--header 'Authorization: Bearer <token>'{
"availability": "<string>",
"calendar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"event_type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_all_day": true,
"metadata": "<unknown>",
"reminders": "<unknown>",
"sequence": 123,
"status": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "<string>",
"attendees": [
{
"created_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<unknown>",
"participant_type": "<string>",
"response_status": "<string>",
"role": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"comment": "<string>",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"key_version": 123
}
],
"links": [
{
"created_at": "2023-11-07T05:31:56Z",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"color": "<string>",
"conference_url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"exdates": [
"2023-11-07T05:31:56Z"
],
"ical_uid": "<string>",
"location": "<string>",
"location_lat": 123,
"location_lng": 123,
"next_occurrence": "2023-11-07T05:31:56Z",
"organizer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recurrence_id": "2023-11-07T05:31:56Z",
"rrule": "<string>",
"series_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at": "2023-11-07T05:31:56Z",
"start_date": "2023-12-25",
"timezone": "<string>"
}Calendar
Get an event by ID with attendees and links.
GET
/
api
/
v1
/
events
/
{id}
Get an event by ID with attendees and links.
curl --request GET \
--url https://api.backside.app/api/v1/events/{id} \
--header 'Authorization: Bearer <token>'{
"availability": "<string>",
"calendar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"event_type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_all_day": true,
"metadata": "<unknown>",
"reminders": "<unknown>",
"sequence": 123,
"status": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"visibility": "<string>",
"attendees": [
{
"created_at": "2023-11-07T05:31:56Z",
"email": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": "<unknown>",
"participant_type": "<string>",
"response_status": "<string>",
"role": "<string>",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"comment": "<string>",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"key_version": 123
}
],
"links": [
{
"created_at": "2023-11-07T05:31:56Z",
"entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "<string>",
"event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"color": "<string>",
"conference_url": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"end_at": "2023-11-07T05:31:56Z",
"end_date": "2023-12-25",
"exdates": [
"2023-11-07T05:31:56Z"
],
"ical_uid": "<string>",
"location": "<string>",
"location_lat": 123,
"location_lng": 123,
"next_occurrence": "2023-11-07T05:31:56Z",
"organizer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recurrence_id": "2023-11-07T05:31:56Z",
"rrule": "<string>",
"series_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_at": "2023-11-07T05:31:56Z",
"start_date": "2023-12-25",
"timezone": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Event ID
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.