Aden
APIAPI reference

Teams

Team management (session only)

Get Api V1 Teams

GET
/api/v1/teams/

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token: used by the web and mobile apps

In: header

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

Create a team

POST
/api/v1/teams/

Authorization

sessionAuth
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/teams/" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

Get Api V1 Teams By Id Invites

GET
/api/v1/teams/{id}/invites

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/teams/string/invites"

Invite someone to a team

POST
/api/v1/teams/{id}/invites

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/teams/string/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

Revoke a pending team invite

DELETE
/api/v1/teams/{id}/invites/{inviteId}

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token: used by the web and mobile apps

In: header

Path Parameters

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

Find teams by name: public ones, your own and the ones you share tracks with

GET
/api/v1/teams/lookup

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token: used by the web and mobile apps

In: header

Query Parameters

q?string
curl -X GET "https://example.com/api/v1/teams/lookup"

Get Api V1 Teams Socials

GET
/api/v1/teams/socials

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/teams/socials?teamId=string"

A team's and its organisations' members

GET
/api/v1/teams/directory

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/teams/directory?teamId=string"

Get Api V1 Teams By Id

GET
/api/v1/teams/{id}

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/teams/string"

Get Api V1 Teams By Id Overview

GET
/api/v1/teams/{id}/overview

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/teams/string/overview"

A team's members you can credit

GET
/api/v1/teams/{id}/invitable-members

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/teams/string/invitable-members"

Get Api V1 Teams By Id Members

GET
/api/v1/teams/{id}/members

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/teams/string/members"

Get Api V1 Teams By Id Plan

GET
/api/v1/teams/{id}/plan

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/teams/string/plan"

Get Api V1 Teams By Id Media

GET
/api/v1/teams/{id}/media

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/teams/string/media"

Create a team media record and get a presigned upload URL

POST
/api/v1/teams/{id}/media

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/teams/string/media" \  -H "Content-Type: application/json" \  -d '{    "fileName": "string",    "fileSize": 0,    "mediaType": "string"  }'

Get Api V1 Teams By Id Status config

GET
/api/v1/teams/{id}/status-config

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/teams/string/status-config"

Patch Api V1 Teams By Id Status config

PATCH
/api/v1/teams/{id}/status-config

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 PATCH "https://example.com/api/v1/teams/string/status-config" \  -H "Content-Type: application/json" \  -d '{    "patch": {}  }'

Patch Api V1 Teams By Id Switcher visibility

PATCH
/api/v1/teams/{id}/switcher-visibility

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 PATCH "https://example.com/api/v1/teams/string/switcher-visibility" \  -H "Content-Type: application/json" \  -d '{    "hidden": true  }'

Get a presigned upload URL for a team banner

POST
/api/v1/teams/{id}/banner/upload-url

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/teams/string/banner/upload-url" \  -H "Content-Type: application/json" \  -d '{    "fileName": "string"  }'

Set a team's banner to an uploaded file

PUT
/api/v1/teams/{id}/banner

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 PUT "https://example.com/api/v1/teams/string/banner" \  -H "Content-Type: application/json" \  -d '{    "fileKey": "string"  }'

Delete a team media record and its file

DELETE
/api/v1/teams/{id}/media/{mediaId}

Authorization

sessionAuth
AuthorizationBearer <token>

Supabase access token: used by the web and mobile apps

In: header

Path Parameters

id*string
mediaId*string
curl -X DELETE "https://example.com/api/v1/teams/string/media/string"
Was this helpful?

Albums

Album management: read endpoints available via API key

Organisations

Organisations the authenticated user belongs to. List, detail, teams, and members (session only)