Aden
APIAPI reference

S D K

Endpoints accessible with a team API key (aden_live_xxx)

Search track content, versions, milestones, and todos within a team

GET
/api/v1/tracks/search/deep

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

q*string
teamId*string
limit?string
curl -X GET "https://example.com/api/v1/tracks/search/deep?q=string&teamId=string"

Get Api V1 Tracks

GET
/api/v1/tracks/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId?string
curl -X GET "https://example.com/api/v1/tracks/"

Get Api V1 Tracks By Id

GET
/api/v1/tracks/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/tracks/string"

Update editable track metadata fields

PATCH
/api/v1/tracks/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/tracks/string" \  -H "Content-Type: application/json" \  -d '{}'

Get collaborators for a track

GET
/api/v1/tracks/{id}/collaborators

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/tracks/string/collaborators"

List all covers for a track

GET
/api/v1/tracks/{id}/covers

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/tracks/string/covers"

Create a new track cover and return presigned upload URL

POST
/api/v1/tracks/{id}/covers

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/covers" \  -H "Content-Type: application/json" \  -d '{    "fileName": "string"  }'

Set a cover as the current track cover

PATCH
/api/v1/tracks/{id}/covers/{coverId}/current

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
coverId*string
curl -X PATCH "https://example.com/api/v1/tracks/string/covers/string/current"

Delete a track cover

DELETE
/api/v1/tracks/{id}/covers/{coverId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
coverId*string
curl -X DELETE "https://example.com/api/v1/tracks/string/covers/string"

Get Api V1 Albums

GET
/api/v1/albums/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId?string
limit?string
offset?string
curl -X GET "https://example.com/api/v1/albums/"
GET
/api/v1/albums/links

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
curl -X GET "https://example.com/api/v1/albums/links?teamId=string"

Get Api V1 Albums By Id

GET
/api/v1/albums/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/albums/string"

Get collaborators for an album

GET
/api/v1/albums/{id}/collaborators

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/albums/string/collaborators"

Create a track version and return a presigned upload URL

POST
/api/v1/tracks/{id}/versions/create

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/create" \  -H "Content-Type: application/json" \  -d '{    "audio_file_name": "string"  }'

Create an additional audio format for a version and return a presigned upload URL

POST
/api/v1/tracks/{id}/versions/{versionId}/files/create

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/string/files/create" \  -H "Content-Type: application/json" \  -d '{    "audio_file_name": "string"  }'

Get version detail with description, lyrics, and metadata

GET
/api/v1/tracks/{id}/versions/{versionId}/detail

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X GET "https://example.com/api/v1/tracks/string/versions/string/detail"

List todos for a specific version

GET
/api/v1/tracks/{id}/versions/{versionId}/todos

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X GET "https://example.com/api/v1/tracks/string/versions/string/todos"

Create a todo for a version

POST
/api/v1/tracks/{id}/versions/{versionId}/todos

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/string/todos" \  -H "Content-Type: application/json" \  -d '{    "todo": "string"  }'

Update a todo

PATCH
/api/v1/tracks/{id}/versions/{versionId}/todos/{todoId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
todoId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/tracks/string/versions/string/todos/string" \  -H "Content-Type: application/json" \  -d '{}'

Delete a todo

DELETE
/api/v1/tracks/{id}/versions/{versionId}/todos/{todoId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
todoId*string
curl -X DELETE "https://example.com/api/v1/tracks/string/versions/string/todos/string"

Update version description or lyrics

PATCH
/api/v1/tracks/{id}/versions/{versionId}/metadata

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/tracks/string/versions/string/metadata" \  -H "Content-Type: application/json" \  -d '{}'

Get play analytics for a version

GET
/api/v1/tracks/{id}/versions/{versionId}/plays

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X GET "https://example.com/api/v1/tracks/string/versions/string/plays"

Get presigned upload URL for a comment attachment (voice memo or file)

POST
/api/v1/tracks/{id}/versions/{versionId}/comments/upload

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X POST "https://example.com/api/v1/tracks/string/versions/string/comments/upload"

Create a comment with optional voice memo or file attachments

POST
/api/v1/tracks/{id}/versions/{versionId}/comments/with-attachments

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/string/comments/with-attachments" \  -H "Content-Type: application/json" \  -d '{}'

Get Api V1 Tracks By Id Versions By Version Id Comments

GET
/api/v1/tracks/{id}/versions/{versionId}/comments

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X GET "https://example.com/api/v1/tracks/string/versions/string/comments"

Post Api V1 Tracks By Id Versions By Version Id Comments

POST
/api/v1/tracks/{id}/versions/{versionId}/comments

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/string/comments" \  -H "Content-Type: application/json" \  -d '{    "comment": "string"  }'

Patch Api V1 Tracks By Id Versions By Version Id Comments By Comment Id

PATCH
/api/v1/tracks/{id}/versions/{versionId}/comments/{commentId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
commentId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/tracks/string/versions/string/comments/string" \  -H "Content-Type: application/json" \  -d '{}'

Delete Api V1 Tracks By Id Versions By Version Id Comments By Comment Id

DELETE
/api/v1/tracks/{id}/versions/{versionId}/comments/{commentId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
commentId*string
curl -X DELETE "https://example.com/api/v1/tracks/string/versions/string/comments/string"

Post Api V1 Tracks By Id Versions By Version Id Comments By Comment Id Reactions

POST
/api/v1/tracks/{id}/versions/{versionId}/comments/{commentId}/reactions

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
commentId*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/tracks/string/versions/string/comments/string/reactions" \  -H "Content-Type: application/json" \  -d '{    "emoji": "string"  }'

Delete Api V1 Tracks By Id Versions By Version Id Comments By Comment Id Reactions By Emoji

DELETE
/api/v1/tracks/{id}/versions/{versionId}/comments/{commentId}/reactions/{emoji}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
commentId*string
emoji*string
curl -X DELETE "https://example.com/api/v1/tracks/string/versions/string/comments/string/reactions/string"

Get Api V1 Tracks By Id Versions

GET
/api/v1/tracks/{id}/versions

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/tracks/string/versions"

Delete Api V1 Tracks By Id Versions By Version Id

DELETE
/api/v1/tracks/{id}/versions/{versionId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X DELETE "https://example.com/api/v1/tracks/string/versions/string"

Patch Api V1 Tracks By Id Versions By Version Id Final

PATCH
/api/v1/tracks/{id}/versions/{versionId}/final

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
versionId*string
curl -X PATCH "https://example.com/api/v1/tracks/string/versions/string/final"

Patch Api V1 Tracks By Id Versions Reorder

PATCH
/api/v1/tracks/{id}/versions/reorder

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/tracks/string/versions/reorder" \  -H "Content-Type: application/json" \  -d '{    "versions": [      {        "versionId": 0,        "order": 0      }    ]  }'

Get Api V1 Contacts

GET
/api/v1/contacts/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
curl -X GET "https://example.com/api/v1/contacts/?teamId=string"

List all documents for a team

GET
/api/v1/documents/team/{teamId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

teamId*string
curl -X GET "https://example.com/api/v1/documents/team/string"

List all documents for a track

GET
/api/v1/documents/track/{trackId}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

trackId*string
curl -X GET "https://example.com/api/v1/documents/track/string"

Get a presigned download URL for a document

GET
/api/v1/documents/{documentId}/download

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

documentId*string
curl -X GET "https://example.com/api/v1/documents/string/download"

Get the full document tree for a team (documents, tracks, versions)

GET
/api/v1/documents/team/{teamId}/tree

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

teamId*string
curl -X GET "https://example.com/api/v1/documents/team/string/tree"

List transfers for a team

GET
/api/v1/transfers/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
curl -X GET "https://example.com/api/v1/transfers/?teamId=string"

Get download URLs for a transfer

GET
/api/v1/transfers/{transferId}/download

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

transferId*string
curl -X GET "https://example.com/api/v1/transfers/string/download"

List projects (DAW snapshots) for a track

GET
/api/v1/project-files/

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

trackId*string
curl -X GET "https://example.com/api/v1/project-files/?trackId=string"

List tracks with project stats for a team

GET
/api/v1/project-files/tracks

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
curl -X GET "https://example.com/api/v1/project-files/tracks?teamId=string"

Get presigned download URLs for the latest version of each file

GET
/api/v1/project-files/{id}/download

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/project-files/string/download"

Get presigned download URL for the latest version of a single file

GET
/api/v1/project-files/{id}/download/{filePath}

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
filePath*string
curl -X GET "https://example.com/api/v1/project-files/string/download/string"

List milestones for a team, track, or album (provide one)

GET
/api/v1/milestones/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId?string
trackId?string
albumId?string
curl -X GET "https://example.com/api/v1/milestones/"

Create a milestone with optional inline todos

POST
/api/v1/milestones/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/milestones/" \  -H "Content-Type: application/json" \  -d '{    "milestone": "string"  }'

Reorder milestones

PATCH
/api/v1/milestones/reorder

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/milestones/reorder" \  -H "Content-Type: application/json" \  -d '{    "milestoneIds": [      0    ]  }'

Get milestone detail

GET
/api/v1/milestones/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/milestones/string"

Update a milestone

PATCH
/api/v1/milestones/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/milestones/string" \  -H "Content-Type: application/json" \  -d '{}'

Soft delete a milestone

DELETE
/api/v1/milestones/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X DELETE "https://example.com/api/v1/milestones/string"

List todos for a scope

GET
/api/v1/todos/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId?string
trackId?string
albumId?string
milestoneId?string
curl -X GET "https://example.com/api/v1/todos/"

Create a todo

POST
/api/v1/todos/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/todos/" \  -H "Content-Type: application/json" \  -d '{    "todo": "string"  }'

Update a todo

PATCH
/api/v1/todos/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/todos/string" \  -H "Content-Type: application/json" \  -d '{}'

Delete a todo

DELETE
/api/v1/todos/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X DELETE "https://example.com/api/v1/todos/string"

List time entries for a scope

GET
/api/v1/time-entries/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

trackId?string
trackVersionId?string
milestoneId?string
todoId?string
curl -X GET "https://example.com/api/v1/time-entries/"

Create a time entry

POST
/api/v1/time-entries/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/time-entries/" \  -H "Content-Type: application/json" \  -d '{    "durationMinutes": 1  }'

Update a time entry

PATCH
/api/v1/time-entries/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/time-entries/string" \  -H "Content-Type: application/json" \  -d '{}'

Soft delete a time entry

DELETE
/api/v1/time-entries/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X DELETE "https://example.com/api/v1/time-entries/string"

List comments for a milestone or todo

GET
/api/v1/milestone-comments/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

milestoneId?string
todoId?string
curl -X GET "https://example.com/api/v1/milestone-comments/"

Create a comment on a milestone or todo. @mentions in body are parsed server-side.

POST
/api/v1/milestone-comments/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/milestone-comments/" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'

Edit your own milestone/todo comment

PATCH
/api/v1/milestone-comments/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/milestone-comments/string" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'

Soft delete your own milestone/todo comment

DELETE
/api/v1/milestone-comments/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X DELETE "https://example.com/api/v1/milestone-comments/string"

Add a reaction to a milestone/todo comment

POST
/api/v1/milestone-comments/{id}/reactions

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/milestone-comments/string/reactions" \  -H "Content-Type: application/json" \  -d '{    "emoji": "string"  }'

Remove your reaction from a milestone/todo comment

DELETE
/api/v1/milestone-comments/{id}/reactions/{emoji}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
emoji*string
curl -X DELETE "https://example.com/api/v1/milestone-comments/string/reactions/string"

List users that can be @-mentioned on a milestone/todo

GET
/api/v1/milestone-comments/mentionable

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

milestoneId?string
todoId?string
curl -X GET "https://example.com/api/v1/milestone-comments/mentionable"

Post Api V1 Public Revoke key

POST
/api/v1/public/revoke-key

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/public/revoke-key" \  -H "Content-Type: application/json" \  -d '{    "secret": {      "api_key": "string"    }  }'

Get Api V1 Public Restore key By Token

GET
/api/v1/public/restore-key/{token}

Path Parameters

token*string
curl -X GET "https://example.com/api/v1/public/restore-key/497f6eca-6276-4993-bfeb-53cbbbba6f08"

List guides visible to the caller

GET
/api/v1/guides/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

curl -X GET "https://example.com/api/v1/guides/"

Create a guide. Public scope requires Aden admin approval (created pending).

POST
/api/v1/guides/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/guides/" \  -H "Content-Type: application/json" \  -d '{    "countryCode": "st",    "slug": "string",    "title": "string",    "content": "string",    "scope": "team"  }'

List financial entries for a team (team, track, and album scoped)

GET
/api/v1/financials/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
from?string
to?string
type?string
curl -X GET "https://example.com/api/v1/financials/?teamId=string"

Create a financial entry (team, track, or album scoped)

POST
/api/v1/financials/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/financials/" \  -H "Content-Type: application/json" \  -d '{    "teamId": 0,    "isIncome": true,    "amount": 0  }'

Financial summary for a team — totals, recurring forecast, and show pipeline

GET
/api/v1/financials/summary

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
from?string
to?string
curl -X GET "https://example.com/api/v1/financials/summary?teamId=string"

Show/deal pipeline — event bookings with fees, status, and follow-ups

GET
/api/v1/financials/pipeline

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
status?string
curl -X GET "https://example.com/api/v1/financials/pipeline?teamId=string"

Export financial entries as CSV (default) or JSON

GET
/api/v1/financials/export

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId*string
format?string
from?string
to?string
curl -X GET "https://example.com/api/v1/financials/export?teamId=string"

Bulk import financial entries (up to 500 per request)

POST
/api/v1/financials/import

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/financials/import" \  -H "Content-Type: application/json" \  -d '{    "teamId": 0,    "entries": [      {        "isIncome": true,        "amount": 0      }    ]  }'

List subscribable webhook event types

GET
/api/v1/webhooks/event-types

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

curl -X GET "https://example.com/api/v1/webhooks/event-types"

List webhook endpoints for a team or organisation

GET
/api/v1/webhooks/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Query Parameters

teamId?string
organisationId?string
curl -X GET "https://example.com/api/v1/webhooks/"

Create a webhook endpoint — the signing secret is returned once

POST
/api/v1/webhooks/

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X POST "https://example.com/api/v1/webhooks/" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'

Update a webhook endpoint

PATCH
/api/v1/webhooks/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

curl -X PATCH "https://example.com/api/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'

Delete a webhook endpoint

DELETE
/api/v1/webhooks/{id}

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X DELETE "https://example.com/api/v1/webhooks/string"

Recent delivery attempts for a webhook endpoint

GET
/api/v1/webhooks/{id}/deliveries

Authorization

AuthorizationBearer <token>

Supabase access token — used by the web and mobile apps

In: header

Path Parameters

id*string
curl -X GET "https://example.com/api/v1/webhooks/string/deliveries"
Was this helpful?

Contacts

Contact management

Testimonials

Public testimonials for onboarding and landing experiences