Workspaces API

Create and list workspaces (organisations).

11 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs

Bearer token

Query parameters

• pageinteger
• limitinteger
• sortBystring

  one of name, slug, status

• sortDirstring

  one of asc, desc

• filterobject
  Fields

  • namestring
  • slugstring
  • statusstring
• filterOpobject
  Fields

  • namestring

    one of eq, contains

  • slugstring

    one of eq, contains

  • statusstring

    one of eq, in

Responses

200

• dataarray<object>required
  Item fields

  • idstring (uuid)required
  • slugstringrequired
  • namestringrequired
  • statusstringrequired
  • avatarUrlstring | nullrequired
  • rolestringrequired
  • roleNamestringrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs

Bearer token

Request body application/json

• namestringrequired
• slugstringrequired

Responses

201

• dataobjectrequired
  Fields

  • idstring (uuid)required
  • slugstringrequired
  • namestringrequired
  • statusstringrequired
  • avatarUrlstring | nullrequired
  • ownerIdstring (uuid) | nullrequired
  • createdAtstringrequired
  • updatedAtstring | nullrequired

Request

curl -X POST "https://api.adventur.ai/v1/orgs" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string"}'

GET/v1/orgs/{orgId}/logo

Bearer token

Path parameters

• orgIdstring (uuid)required

Responses

200

• dataobjectrequired
  Fields

  • keystringrequired
  • urlstringrequired
  • expiresInSecondsnumberrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/logo" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/logo

Bearer token

Path parameters

• orgIdstring (uuid)required

Request body application/json

• keystringrequired

Responses

200

• dataobjectrequired
  Fields

  • avatarUrlstring | nullrequired
  • keystringrequired

Request

curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/logo" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key":"string"}'

DELETE/v1/orgs/{orgId}/logo

Bearer token

Path parameters

• orgIdstring (uuid)required

Responses

200

No body.

Request

curl -X DELETE "https://api.adventur.ai/v1/orgs/$ORG_ID/logo" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/logo/upload-url

Bearer token

Path parameters

• orgIdstring (uuid)required

Request body application/json

• contentTypestringrequired

Responses

200

• dataobjectrequired
  Fields

  • uploadUrlstringrequired
  • keystringrequired
  • assetUrlstringrequired
  • expiresInSecondsnumberrequired
  • method"PUT"required
  • requiredHeadersobjectrequired

Request

curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/logo/upload-url" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"contentType":"string"}'

GET/v1/orgs/{orgId}/members

Bearer token

Path parameters

• orgIdstring (uuid)required

Query parameters

• pageinteger
• limitinteger
• sortBystring

  one of joinedAt, createdAt, role, status, email, name

• sortDirstring

  one of asc, desc

• filterobject
  Fields

  • statusstring
  • roleKeystring
  • emailstring
  • namestring
• filterOpobject
  Fields

  • statusstring

    one of eq, in

  • roleKeystring

    one of eq, in

  • emailstring

    one of eq, contains

  • namestring

    one of eq, contains

Responses

200

• dataarray<object>required
  Item fields

  • idstring (uuid)required
  • userIdstring (uuid)required
  • emailstring | nullrequired
  • namestring | nullrequired
  • avatarUrlstring | nullrequired
  • rolestringrequired
  • roleKeystringrequired
  • statusstringrequired
  • joinedAtstring | nullrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/members" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PATCH/v1/orgs/{orgId}/members/{memberId}

Bearer token

Path parameters

• orgIdstring (uuid)required
• memberIdstring (uuid)required

Request body application/json

• roleKeystring
• statusstring

  one of active, suspended

Responses

200

• dataobjectrequired
  Fields

  • idstring (uuid)required
  • roleIdstring (uuid) | nullrequired
  • statusstring | nullrequired

Request

curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/members/$MEMBER_ID" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/v1/orgs/{orgId}/members/{memberId}

Bearer token

Path parameters

• orgIdstring (uuid)required
• memberIdstring (uuid)required

Responses

200

No body.

Request

curl -X DELETE "https://api.adventur.ai/v1/orgs/$ORG_ID/members/$MEMBER_ID" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/timezone

Bearer token

Returns the persisted IANA timezone used for best-slot scheduling and coverage. Defaults to UTC until set.

Path parameters

• orgIdstring (uuid)required

Responses

200Returns the persisted IANA timezone used for best-slot scheduling and coverage. Defaults to UTC until set.

• dataobjectrequired
  Fields

  • timezonestringrequired
  • isSetbooleanrequired

Request

curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/timezone" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PATCH/v1/orgs/{orgId}/timezone

Bearer token

Sets the workspace IANA timezone used for scheduling. Owner/admin only.

Path parameters

• orgIdstring (uuid)required

Request body application/json

• timezonestringrequired

Responses

200Sets the workspace IANA timezone used for scheduling. Owner/admin only.

• dataobjectrequired
  Fields

  • timezonestringrequired
  • isSetbooleanrequired

Request

curl -X PATCH "https://api.adventur.ai/v1/orgs/$ORG_ID/timezone" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"timezone":"string"}'