docs
CTRL K
GitHubDiscord
DevelopersAPI ReferenceLearnIntegrationsWebsiteGitHubDiscord
Skip to Content

Organizations

Organization CRUD, members, invites, configuration, branding and SEO settings.

Create an organization

POST/api/v1/orgs/
User session only — API tokens not accepted

Create a new organization owned by the authenticated user.

Request bodyapplication/jsonrequired

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired

Returns

OrganizationRead — Organization created.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 401 Not authenticated
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "description": "An example description",
  "about": "string",
  "socials": {},
  "links": {},
  "scripts": {},
  "logo_image": "string",
  "thumbnail_image": "string",
  "previews": {},
  "explore": false,
  "label": "string",
  "slug": "my-example-slug",
  "email": "ada@example.com",
  "id": 1,
  "org_uuid": "string",
  "config": {
    "id": 1,
    "org_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  },
  "creation_date": "string",
  "update_date": "string"
}

Create an organization with config

POST/api/v1/orgs/withconfig/
User session only — API tokens not accepted

Create a new organization together with its base configuration in a single call (pre-alpha).

Request bodyapplication/jsonrequired

org_objectOrganizationCreaterequired
Show child attributes
namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
config_objectOrganizationConfigBaserequired
Show child attributes
config_versionstring
generalOrgGeneralConfigrequired
Show child attributes
enabledboolean
colorstring
footer_textstring
watermarkboolean
favicon_imagestring
auth_brandingAuthBrandingConfig
Show child attributes
welcome_messagestring
background_typeenum
gradientcustomunsplash
background_imagestring
text_colorenum
lightdark
unsplash_photographer_namestring
unsplash_photographer_urlstring
unsplash_photo_urlstring
featuresOrgFeatureConfigrequired
Show child attributes
coursesCourseOrgConfig
Show child attributes
enabledboolean
limitinteger
membersMemberOrgConfig
Show child attributes
enabledboolean
signup_modeenum
openinviteOnly
admin_limitinteger
limitinteger
usergroupsUserGroupOrgConfig
Show child attributes
enabledboolean
limitinteger
storageStorageOrgConfig
Show child attributes
enabledboolean
limitinteger
aiAIOrgConfig
Show child attributes
enabledboolean
limitinteger
modelstring
assignmentsAssignmentOrgConfig
Show child attributes
enabledboolean
limitinteger
paymentsPaymentOrgConfig
Show child attributes
enabledboolean
discussionsDiscussionOrgConfig
Show child attributes
enabledboolean
limitinteger
communitiesCommunitiesOrgConfig
Show child attributes
enabledboolean
foldersFoldersOrgConfig
Show child attributes
enabledboolean
sort_modestring
analyticsAnalyticsOrgConfig
Show child attributes
enabledboolean
limitinteger
collaborationCollaborationOrgConfig
Show child attributes
enabledboolean
limitinteger
apiAPIOrgConfig
Show child attributes
enabledboolean
limitinteger
podcastsPodcastsOrgConfig
Show child attributes
enabledboolean
limitinteger
boardsBoardsOrgConfig
Show child attributes
enabledboolean
limitinteger
playgroundsPlaygroundsOrgConfig
Show child attributes
enabledboolean
limitinteger
cloudOrgCloudConfigrequired
Show child attributes
planenum
freepersonalpersonal-familystandardproenterpriseoss
custom_domainboolean
landingLanding
seoSeoOrgConfig
Show child attributes
default_meta_title_suffixstring
default_meta_descriptionstring
default_og_imagestring
google_site_verificationstring
twitter_handlestring
noindex_communitiesboolean

Returns

OrganizationRead — Organization and configuration created.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 401 Not authenticated
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "description": "An example description",
  "about": "string",
  "socials": {},
  "links": {},
  "scripts": {},
  "logo_image": "string",
  "thumbnail_image": "string",
  "previews": {},
  "explore": false,
  "label": "string",
  "slug": "my-example-slug",
  "email": "ada@example.com",
  "id": 1,
  "org_uuid": "string",
  "config": {
    "id": 1,
    "org_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  },
  "creation_date": "string",
  "update_date": "string"
}

Get organization by UUID

GET/api/v1/orgs/uuid/{org_uuid}
User session only — API tokens not accepted

Fetch a single organization by its UUID.

Path parameters

org_uuidstringrequired

Returns

OrganizationRead — Organization matching the UUID.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "description": "An example description",
  "about": "string",
  "socials": {},
  "links": {},
  "scripts": {},
  "logo_image": "string",
  "thumbnail_image": "string",
  "previews": {},
  "explore": false,
  "label": "string",
  "slug": "my-example-slug",
  "email": "ada@example.com",
  "id": 1,
  "org_uuid": "string",
  "config": {
    "id": 1,
    "org_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  },
  "creation_date": "string",
  "update_date": "string"
}

Export organization users as CSV

GET/api/v1/orgs/{org_id}/users/export
User session only — API tokens not accepted

Export organization users as a CSV file. Supports the same filters as the users listing endpoint. Requires authentication; anonymous access is rejected.

Path parameters

org_idintegerrequired

Query parameters

searchstring
usergroup_idinteger | null
usergroup_filterenum | null
in_groupnot_in_group
sort_orderenum | null
ascdesc
role_idinteger | null
statusenum | null
verifiedunverified
Error responses
  • 401 Not authenticated
  • 403 Caller is not a member of the organization
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List organization users

GET/api/v1/orgs/{org_id}/users
User session only — API tokens not accepted

List organization users with pagination, search and filters. Requires authentication; anonymous access is rejected. The limit is capped at 100 to prevent data dumping.

Path parameters

org_idintegerrequired

Query parameters

pageinteger

Page number

limitinteger

Items per page (max 100)

searchstring
usergroup_idinteger | null

Filter by usergroup membership

usergroup_filterenum | null

Membership filter: 'in_group' or 'not_in_group'

in_groupnot_in_group
sort_orderenum | null

Sort order for join date

ascdesc
role_idinteger | null

Filter by role ID

statusenum | null

Filter by verification status

verifiedunverified
Error responses
  • 401 Not authenticated
  • 403 Caller is not a member of the organization
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Join an organization

POST/api/v1/orgs/join
User session only — API tokens not accepted

Join an existing organization, optionally consuming an invite code.

Request bodyapplication/jsonrequired

org_idintegerrequired
user_idstring | integerrequired
invite_codestring | null
Error responses
  • 401 Not authenticated
  • 403 Organization is invite-only or invite is invalid
  • 404 Organization or invite not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update user role in organization

PUT/api/v1/orgs/{org_id}/users/{user_id}/role/{role_uuid}
User session only — API tokens not accepted

Update the role of a user within an organization by role UUID.

Path parameters

org_idintegerrequired
user_idintegerrequired
role_uuidstringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller lacks permission to change roles
  • 404 Organization, user, or role not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Remove multiple users from organization

DELETE/api/v1/orgs/{org_id}/users/batch/remove
User session only — API tokens not accepted

Remove a batch of users from the organization in a single call.

Path parameters

org_idintegerrequired

Query parameters

user_idsinteger[]required

List of user IDs to remove

Error responses
  • 401 Not authenticated
  • 403 Caller lacks permission to remove users
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Remove all users from organization

DELETE/api/v1/orgs/{org_id}/users/all
User session only — API tokens not accepted

Remove every member from the organization except the caller. The organization and its content are kept. Admin only.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Wipe all organization content

DELETE/api/v1/orgs/{org_id}/content
User session only — API tokens not accepted

Delete all courses (and their cascaded content) in the organization while keeping the organization and its members. Admin only.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Remove a user from organization

DELETE/api/v1/orgs/{org_id}/users/{user_id}
User session only — API tokens not accepted

Remove a single user from the organization.

Path parameters

org_idintegerrequired
user_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller lacks permission to remove users
  • 404 Organization or user not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Leave an organization

DELETE/api/v1/orgs/{org_id}/leave
User session only — API tokens not accepted

Remove the CURRENT (authenticated) user's own membership in the org — self-service, no admin rights required. The last remaining admin cannot leave (they must transfer ownership or delete the org).

Path parameters

org_idintegerrequired
Error responses
  • 400 You are the last admin
  • 401 Not authenticated
  • 404 Organization not found or you are not a member
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization signup mechanism

PUT/api/v1/orgs/{org_id}/signup_mechanism
User session only — API tokens not accepted

Change whether the organization allows open signup or requires an invite code.

Path parameters

org_idintegerrequired

Query parameters

signup_mechanismenumrequired
openinviteOnly
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization color

PUT/api/v1/orgs/{org_id}/config/color
User session only — API tokens not accepted

Update the organization's primary color used for branding.

Path parameters

org_idintegerrequired

Query parameters

colorstring
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization font

PUT/api/v1/orgs/{org_id}/config/font
User session only — API tokens not accepted

Update the organization's branding font family.

Path parameters

org_idintegerrequired

Query parameters

fontstring
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization footer text

PUT/api/v1/orgs/{org_id}/config/footer_text
User session only — API tokens not accepted

Update the organization's footer text used across learner-facing pages.

Path parameters

org_idintegerrequired

Query parameters

footer_textstring
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization default language

PUT/api/v1/orgs/{org_id}/config/default_language
User session only — API tokens not accepted

Update the organization's default language used for the public UI and outgoing emails. Admin only.

Path parameters

org_idintegerrequired

Query parameters

default_languagestringrequired
Error responses
  • 400 Unsupported language code
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization watermark

PUT/api/v1/orgs/{org_id}/config/watermark
User session only — API tokens not accepted

Enable or disable the watermark. Free plan organizations are not allowed to disable it.

Path parameters

org_idintegerrequired

Query parameters

watermark_enabledboolean
Error responses
  • 401 Not authenticated
  • 403 Caller is not an admin or free plan cannot disable the watermark
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update auth page branding

PUT/api/v1/orgs/{org_id}/config/auth_branding
User session only — API tokens not accepted

Update branding configuration for the organization's authentication pages.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

welcome_messagestring
background_typeenum
gradientcustomunsplash
background_imagestring
text_colorenum
lightdark
unsplash_photographer_namestring
unsplash_photographer_urlstring
unsplash_photo_urlstring
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update public menu config

PUT/api/v1/orgs/{org_id}/config/menu
User session only — API tokens not accepted

Customize which links appear in the public organization navigation, their order, labels, and custom links.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Upload auth page background

PUT/api/v1/orgs/{org_id}/auth_background
User session only — API tokens not accepted

Upload the background image shown on the organization's authentication pages.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

background_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization SEO config

PUT/api/v1/orgs/{org_id}/config/seo
User session only — API tokens not accepted

Update SEO-related configuration such as titles, descriptions and keywords.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

default_meta_title_suffixstring
default_meta_descriptionstring
default_og_imagestring
google_site_verificationstring
twitter_handlestring
noindex_communitiesboolean
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Upload OG image

PUT/api/v1/orgs/{org_id}/og_image
User session only — API tokens not accepted

Upload the OpenGraph image used for social media sharing previews.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

og_image_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List invite codes

GET/api/v1/orgs/{org_id}/invites
User session only — API tokens not accepted

List all invite codes for the organization.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create an invite code

POST/api/v1/orgs/{org_id}/invites
User session only — API tokens not accepted

Create a new invite code for the organization, optionally linked to a usergroup.

Path parameters

org_idintegerrequired

Query parameters

usergroup_idinteger | null
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization or usergroup not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get an invite code

GET/api/v1/orgs/{org_id}/invites/code/{invite_code}
User session only — API tokens not accepted

Fetch details for a single invite code.

Path parameters

org_idintegerrequired
invite_codestringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Invite code not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Delete an invite code

DELETE/api/v1/orgs/{org_id}/invites/{org_invite_code_uuid}
User session only — API tokens not accepted

Delete an invite code by its UUID.

Path parameters

org_idintegerrequired
org_invite_code_uuidstringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Invite code not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Invite a batch of users

POST/api/v1/orgs/{org_id}/invites/users/batch
User session only — API tokens not accepted

Invite multiple users by email in a single request, optionally using a specific invite code.

Path parameters

org_idintegerrequired

Query parameters

emailsstringrequired
invite_code_uuidstring | null
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization or invite code not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List invited users

GET/api/v1/orgs/{org_id}/invites/users
User session only — API tokens not accepted

List users who have been invited to the organization but have not joined yet.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Revoke an invited user

DELETE/api/v1/orgs/{org_id}/invites/users/{email}
User session only — API tokens not accepted

Revoke a pending invitation for the user identified by email.

Path parameters

org_idintegerrequired
emailstringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Invitation not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get organization by slug

GET/api/v1/orgs/slug/{org_slug}
User session only — API tokens not accepted

Fetch a single organization by its URL slug.

Path parameters

org_slugstringrequired

Returns

OrganizationRead — Organization matching the slug.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "description": "An example description",
  "about": "string",
  "socials": {},
  "links": {},
  "scripts": {},
  "logo_image": "string",
  "thumbnail_image": "string",
  "previews": {},
  "explore": false,
  "label": "string",
  "slug": "my-example-slug",
  "email": "ada@example.com",
  "id": 1,
  "org_uuid": "string",
  "config": {
    "id": 1,
    "org_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  },
  "creation_date": "string",
  "update_date": "string"
}
PUT/api/v1/orgs/{org_id}/logo
User session only — API tokens not accepted

Upload a new logo image for the organization.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

logo_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization favicon

PUT/api/v1/orgs/{org_id}/favicon
User session only — API tokens not accepted

Upload a new favicon image for the organization.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

favicon_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization thumbnail

PUT/api/v1/orgs/{org_id}/thumbnail
User session only — API tokens not accepted

Upload a new thumbnail image for the organization.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

thumbnail_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization preview image

PUT/api/v1/orgs/{org_id}/preview
User session only — API tokens not accepted

Upload a new preview image used on the organization's landing page.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

preview_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List organizations for current user

GET/api/v1/orgs/user/page/{page}/limit/{limit}
User session only — API tokens not accepted

Return a paginated list of organizations the current user belongs to.

Path parameters

pageintegerrequired

Page number (1-based)

limitintegerrequired

Items per page (max 100)

Returns

OrganizationRead[] — Paginated organizations for the current user.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
[
  {
    "name": "Example name",
    "description": "An example description",
    "about": "string",
    "socials": {},
    "links": {},
    "scripts": {},
    "logo_image": "string",
    "thumbnail_image": "string",
    "previews": {},
    "explore": false,
    "label": "string",
    "slug": "my-example-slug",
    "email": "ada@example.com",
    "id": 1,
    "org_uuid": "string",
    "config": {
      "id": 1,
      "org_id": 1,
      "config": {},
      "creation_date": "string",
      "update_date": "string"
    },
    "creation_date": "string",
    "update_date": "string"
  }
]

List organizations the user administers

GET/api/v1/orgs/user_admin/page/{page}/limit/{limit}
User session only — API tokens not accepted

Return a paginated list of organizations where the current user has admin rights.

Path parameters

pageintegerrequired

Page number (1-based)

limitintegerrequired

Items per page (max 100)

Returns

OrganizationRead[] — Paginated organizations the current user administers.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 422 Validation Error — HTTPValidationError
Request
Response
[
  {
    "name": "Example name",
    "description": "An example description",
    "about": "string",
    "socials": {},
    "links": {},
    "scripts": {},
    "logo_image": "string",
    "thumbnail_image": "string",
    "previews": {},
    "explore": false,
    "label": "string",
    "slug": "my-example-slug",
    "email": "ada@example.com",
    "id": 1,
    "org_uuid": "string",
    "config": {
      "id": 1,
      "org_id": 1,
      "config": {},
      "creation_date": "string",
      "update_date": "string"
    },
    "creation_date": "string",
    "update_date": "string"
  }
]

Update an organization

PUT/api/v1/orgs/{org_id}
User session only — API tokens not accepted

Update an organization's core fields by ID.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

namestring | null
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
labelstring | null
slugstring | null
emailstring | null

Returns

OrganizationRead — Organization updated.

namestringrequired
descriptionstring | null
aboutstring | null
socialsSocials | null
linksLinks | null
scriptsScripts | null
logo_imagestring | null
thumbnail_imagestring | null
previewsPreviews | null
exploreboolean | null
labelstring | null
slugstringrequired
emailstringrequired
idintegerrequired
org_uuidstringrequired
configOrganizationConfig | object | null
Show child attributes
idinteger | null
org_idintegerrequired
configConfig
creation_datestring | null
update_datestring | null
creation_datestringrequired
update_datestringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "name": "Example name",
  "description": "An example description",
  "about": "string",
  "socials": {},
  "links": {},
  "scripts": {},
  "logo_image": "string",
  "thumbnail_image": "string",
  "previews": {},
  "explore": false,
  "label": "string",
  "slug": "my-example-slug",
  "email": "ada@example.com",
  "id": 1,
  "org_uuid": "string",
  "config": {
    "id": 1,
    "org_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  },
  "creation_date": "string",
  "update_date": "string"
}

Delete an organization

DELETE/api/v1/orgs/{org_id}
User session only — API tokens not accepted

Delete an organization by its ID. This action cannot be undone.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization landing page

PUT/api/v1/orgs/{org_id}/landing
User session only — API tokens not accepted

Update the organization's landing page content object.

Path parameters

org_idintegerrequired

Request bodyapplication/jsonrequired

Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Upload landing page content

POST/api/v1/orgs/{org_id}/landing/content
User session only — API tokens not accepted

Upload a content asset (image or file) to attach to the organization's landing page.

Path parameters

org_idintegerrequired

Request bodymultipart/form-datarequired

content_filefilerequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get organization usage and limits

GET/api/v1/orgs/{org_id}/usage
User session only — API tokens not accepted

Return current usage, plan limits, and remaining quota for the organization's plan-based features.

Path parameters

org_idintegerrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not a member of the organization
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization AI config

PUT/api/v1/orgs/{org_id}/config/ai
User session only — API tokens not accepted

Update the organization's AI feature configuration, including the Copilot toggle. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

ai_enabledboolean | null
copilot_enabledboolean | null
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization communities config

PUT/api/v1/orgs/{org_id}/config/communities
User session only — API tokens not accepted

Enable or disable the communities feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

communities_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization payments config

PUT/api/v1/orgs/{org_id}/config/payments
User session only — API tokens not accepted

Enable or disable the payments feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

payments_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization courses config

PUT/api/v1/orgs/{org_id}/config/courses
User session only — API tokens not accepted

Enable or disable the courses feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

courses_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization folders config

PUT/api/v1/orgs/{org_id}/config/folders
User session only — API tokens not accepted

Enable or disable the folders feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

folders_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization library folders sort mode

PUT/api/v1/orgs/{org_id}/config/folders-sort
User session only — API tokens not accepted

Set the library folder ordering mode (name_asc | name_desc | newest | oldest | manual). Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

sort_modestringrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Invalid sort mode
Request

Update organization podcasts config

PUT/api/v1/orgs/{org_id}/config/podcasts
User session only — API tokens not accepted

Enable or disable the podcasts feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

podcasts_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization boards config

PUT/api/v1/orgs/{org_id}/config/boards
User session only — API tokens not accepted

Enable or disable the boards feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

boards_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update organization playgrounds config

PUT/api/v1/orgs/{org_id}/config/playgrounds
User session only — API tokens not accepted

Enable or disable the playgrounds feature for the organization. Admin only.

Path parameters

org_idintegerrequired

Organization ID

Query parameters

playgrounds_enabledbooleanrequired
Error responses
  • 401 Not authenticated
  • 403 Caller is not an organization administrator
  • 404 Organization not found
  • 422 Validation Error — HTTPValidationError
Request
Response
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}