Skip to main content

​
Base URL

https://api.backside.app

​
Authentication

All endpoints under /api/v1/ require authentication via Bearer API key or x402 payment receipt. See Authentication.

​
OpenAPI spec

The full OpenAPI 3.1 specification is available at: 
https://api.backside.app/docs/openapi.json
Mintlify auto-generates interactive API reference pages from this spec. Each endpoint below links to its auto-generated page with request builders, parameter documentation, and response examples.

​
Available endpoints

​
Auth & Tenant

MethodEndpointDescription
POST/api/v1/api-keysCreate an API key
GET/api/v1/api-keysList API keys
GET/api/v1/api-keys/{id}Get an API key
POST/api/v1/api-keys/{id}/rotateRotate an API key
DELETE/api/v1/api-keys/{id}Revoke an API key
GET/api/v1/tenantGet tenant info
PATCH/api/v1/tenantUpdate tenant info
GET/api/v1/audit-logList audit log
POST/api/v1/checkoutCreate Stripe checkout session
GET/api/v1/provisioning/keyRetrieve API key after checkout

​
Contacts

MethodEndpointDescription
GET/api/v1/contactsList contacts
POST/api/v1/contactsCreate a contact
GET/api/v1/contacts/{id}Get a contact
PUT/api/v1/contacts/{id}Update a contact
DELETE/api/v1/contacts/{id}Delete a contact
GET/api/v1/contacts/find-by-channelFind contact by email or phone
POST/api/v1/contacts/{id}/channelsAdd a communication channel
DELETE/api/v1/contacts/{id}/channels/{channel_id}Remove a channel
POST/api/v1/contacts/{id}/addressesAdd an address
PUT/api/v1/contacts/{id}/addresses/{address_id}Update an address
DELETE/api/v1/contacts/{id}/addresses/{address_id}Remove an address
POST/api/v1/contacts/{id}/datesAdd a date
PUT/api/v1/contacts/{id}/dates/{date_id}Update a date
DELETE/api/v1/contacts/{id}/dates/{date_id}Remove a date
GET/api/v1/contacts/{id}/relationshipsList relationships
POST/api/v1/contacts/{id}/relationshipsAdd a relationship
DELETE/api/v1/contacts/{id}/relationships/{rel_id}Remove a relationship
GET/api/v1/contacts/{id}/affiliationsList affiliations
POST/api/v1/contacts/{id}/affiliationsAdd an affiliation
DELETE/api/v1/contacts/{id}/affiliations/{aff_id}Remove an affiliation
GET/api/v1/contacts/{id}/interactionsList interactions
POST/api/v1/contacts/{id}/interactionsLog an interaction
POST/api/v1/contacts/{id}/tagsAdd a tag
DELETE/api/v1/contacts/{id}/tags/{tag_id}Remove a tag
GET/api/v1/contact-tagsList tag definitions
POST/api/v1/contact-tagsCreate a tag definition
GET/api/v1/contact-groupsList groups
POST/api/v1/contact-groupsCreate a group
DELETE/api/v1/contact-groups/{group_id}Delete a group
GET/api/v1/contact-groups/{group_id}/membersList group members
POST/api/v1/contact-groups/{group_id}/membersAdd to group
DELETE/api/v1/contact-groups/{group_id}/members/{contact_id}Remove from group
GET/api/v1/relationship-typesList relationship types

​
CRM

MethodEndpointDescription
GET/api/v1/pipelinesList pipelines
POST/api/v1/pipelinesCreate a pipeline
GET/api/v1/pipelines/{id}Get a pipeline
PUT/api/v1/pipelines/{id}Update a pipeline
DELETE/api/v1/pipelines/{id}Delete a pipeline
POST/api/v1/pipelines/{id}/defaultSet default pipeline
GET/api/v1/pipelines/{id}/stagesList stages
POST/api/v1/pipelines/{id}/stagesCreate a stage
PUT/api/v1/pipelines/{id}/stages/reorderReorder stages
PUT/api/v1/pipelines/{id}/stages/{stage_id}Update a stage
DELETE/api/v1/pipelines/{id}/stages/{stage_id}Delete a stage
GET/api/v1/pipelines/{id}/summaryPipeline analytics
GET/api/v1/dealsList deals
POST/api/v1/dealsCreate a deal
GET/api/v1/deals/{id}Get a deal
PUT/api/v1/deals/{id}Update a deal
DELETE/api/v1/deals/{id}Delete a deal
POST/api/v1/deals/{id}/moveMove deal to stage
GET/api/v1/deals/{id}/historyDeal stage history
GET/api/v1/deals/{id}/contactsList deal contacts
POST/api/v1/deals/{id}/contactsAdd deal contact
DELETE/api/v1/deals/{id}/contacts/{contact_id}Remove deal contact
POST/api/v1/deals/{id}/tagsAdd deal tag
DELETE/api/v1/deals/{id}/tags/{tag_id}Remove deal tag
GET/api/v1/crm/tagsList CRM tags
POST/api/v1/crm/tagsCreate CRM tag

​
Tasks & Projects

MethodEndpointDescription
GET/api/v1/projectsList projects
POST/api/v1/projectsCreate a project
GET/api/v1/projects/{id}Get a project
PUT/api/v1/projects/{id}Update a project
DELETE/api/v1/projects/{id}Delete a project
GET/api/v1/projects/{id}/statusesList project statuses
POST/api/v1/projects/{id}/statusesAdd a status
PUT/api/v1/projects/{id}/statuses/{status_id}Update a status
DELETE/api/v1/projects/{id}/statuses/{status_id}Remove a status
GET/api/v1/projects/{id}/sectionsList sections
POST/api/v1/projects/{id}/sectionsAdd a section
PUT/api/v1/projects/{id}/sections/{section_id}Update a section
DELETE/api/v1/projects/{id}/sections/{section_id}Remove a section
GET/api/v1/projects/{id}/milestonesList milestones
POST/api/v1/projects/{id}/milestonesAdd a milestone
PUT/api/v1/projects/{id}/milestones/{milestone_id}Update a milestone
DELETE/api/v1/projects/{id}/milestones/{milestone_id}Remove a milestone
GET/api/v1/projects/{id}/membersList members
POST/api/v1/projects/{id}/membersAdd a member
DELETE/api/v1/projects/{id}/members/{member_id}Remove a member
GET/api/v1/tasksList tasks
POST/api/v1/tasksCreate a task
GET/api/v1/tasks/{id}Get a task
PUT/api/v1/tasks/{id}Update a task
DELETE/api/v1/tasks/{id}Delete a task
POST/api/v1/tasks/{id}/completeComplete a task
POST/api/v1/tasks/{id}/cancelCancel a task
GET/api/v1/tasks/overdueList overdue tasks
GET/api/v1/tasks/by-identifier/{identifier}Get task by identifier
GET/api/v1/tasks/{id}/subtasksList subtasks
GET/api/v1/tasks/{id}/dependenciesList dependencies
POST/api/v1/tasks/{id}/dependenciesAdd a dependency
DELETE/api/v1/tasks/{id}/dependencies/{dep_id}Remove a dependency
GET/api/v1/tasks/{id}/commentsList comments
POST/api/v1/tasks/{id}/commentsAdd a comment
PUT/api/v1/tasks/{id}/comments/{comment_id}Update a comment
POST/api/v1/tasks/{id}/labelsAdd a label
DELETE/api/v1/tasks/{id}/labels/{label_id}Remove a label
GET/api/v1/tasks/{id}/linksList links
POST/api/v1/tasks/{id}/linksAdd a link
DELETE/api/v1/tasks/{id}/links/{link_id}Remove a link
GET/api/v1/task-labelsList label definitions
POST/api/v1/task-labelsCreate label definition

​
Calendar

MethodEndpointDescription
GET/api/v1/calendarsList calendars
POST/api/v1/calendarsCreate a calendar
GET/api/v1/calendars/{id}Get a calendar
PUT/api/v1/calendars/{id}Update a calendar
DELETE/api/v1/calendars/{id}Delete a calendar
GET/api/v1/eventsList events
POST/api/v1/eventsCreate an event
GET/api/v1/events/{id}Get an event
PUT/api/v1/events/{id}Update an event
DELETE/api/v1/events/{id}Delete an event
GET/api/v1/events/searchSearch events
POST/api/v1/events/{id}/attendeesAdd attendee
PUT/api/v1/events/{id}/attendees/{attendee_id}Update attendee RSVP
DELETE/api/v1/events/{id}/attendees/{attendee_id}Remove attendee
POST/api/v1/events/{id}/linksAdd event link
DELETE/api/v1/events/{id}/links/{link_id}Remove event link

​
Notes

MethodEndpointDescription
GET/api/v1/notebooksList notebooks
POST/api/v1/notebooksCreate a notebook
GET/api/v1/notebooks/{id}Get a notebook
PUT/api/v1/notebooks/{id}Update a notebook
DELETE/api/v1/notebooks/{id}Delete a notebook
GET/api/v1/notesList notes
POST/api/v1/notesCreate a note
GET/api/v1/notes/{id}Get a note
PUT/api/v1/notes/{id}Update a note
DELETE/api/v1/notes/{id}Delete a note
GET/api/v1/notes/{id}/linksList note links
POST/api/v1/notes/{id}/linksAdd a note link
DELETE/api/v1/notes/{id}/links/{link_id}Remove a note link
GET/api/v1/notes/{id}/backlinksList backlinks
GET/api/v1/backlinks/{entity_type}/{entity_id}Cross-domain backlinks
POST/api/v1/notes/{id}/tagsAdd a tag
DELETE/api/v1/notes/{id}/tags/{tag_id}Remove a tag
GET/api/v1/notes/{id}/attachmentsList attachments
POST/api/v1/notes/{id}/attachmentsAdd an attachment
DELETE/api/v1/notes/{id}/attachments/{attachment_id}Remove an attachment
GET/api/v1/note-tagsList tag definitions
POST/api/v1/note-tagsCreate tag definition

​
Payments & Usage

MethodEndpointDescription
GET/api/v1/usageGet usage stats
POST/api/v1/billing/portalCreate Stripe portal session

​
Health

MethodEndpointDescription
GET/healthHealth check (no auth)
GET/readyReadiness check (no auth)