Api

get

OpenApi3 schema for this API. Format can be selected via content negotiation.

• YAML: application/vnd.oai.openapi

• JSON: application/vnd.oai.openapi+json

Authorizations

BearerAuth

AuthorizationstringOptional

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Query parameters

formatstring · enumOptionalPossible values:

langstring · enumOptionalPossible values:

Responses

200Success

application/vnd.oai.openapiapplication/yamlapplication/vnd.oai.openapi+jsonapplication/json

Other propertiesanyOptional

get

/api/schema/

HTTPcURLJavaScriptPython

GET /api/schema/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

post

Handle POST requests to the Clerk webhook endpoint.

This method is called when Clerk sends a webhook event to this endpoint. It expects the request to contain a valid Svix signature in the headers. The expected headers are:

• svix-id: The unique identifier for the webhook event.

• svix-timestamp: The timestamp of the webhook event.

• svix-signature: The signature to verify the authenticity of the webhook event. The request body should be a JSON payload containing the event data. The expected JSON structure is: { "type": "user.created" | "user.updated" | "user.deleted", "data": { "id": "<clerk_user_id>", ... } } If the signature is valid, the method processes the event and updates the local user database accordingly. It handles the following event types:

• user.created: Syncs a new user with the Clerk user ID.

• user.updated: Syncs an updated user with the Clerk user ID.

• user.deleted: Marks a user as inactive in the local database based on the Clerk user ID. If the signature is invalid or the event type is not handled, it returns an error response. If the signature is valid and the event is processed successfully, it returns a success response. Args: request: The HTTP request object containing the webhook event data. *args: Additional positional arguments. **kwargs: Additional keyword arguments. Returns: JsonResponse: A JSON response indicating the success or failure of the webhook processing. Raises: HttpResponseBadRequest: If the SIGNING_SECRET is not configured or if required headers are missing. JsonResponse: If the request body is invalid or if the webhook verification fails. Raises: Exception: If there is an error processing the webhook event.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200

No response body

No content

post

/api/v1/account/clerk_webhook/

HTTPcURLJavaScriptPython

POST /api/v1/account/clerk_webhook/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

No response body

No content

get

Developer-only GET endpoint.

Args: request: The HTTP request object.

Returns: Response: Greeting message for the developer.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

get

/api/v1/account/devtest/

HTTPcURLJavaScriptPython

GET /api/v1/account/devtest/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

post

Developer-only POST endpoint.

Args: request: The HTTP request object.

Returns: Response: Message indicating development-only access.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

Responses

200Success

application/json

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

post

/api/v1/account/devtest/

HTTPcURLJavaScriptPython

POST /api/v1/account/devtest/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

put

Developer-only PUT endpoint.

Args: request: The HTTP request object.

Returns: Response: Message indicating PUT support for developers.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

Responses

200Success

application/json

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

put

/api/v1/account/devtest/

HTTPcURLJavaScriptPython

PUT /api/v1/account/devtest/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

delete

Developer-only DELETE endpoint.

Args: request: The HTTP request object.

Returns: Response: Message indicating DELETE support for developers.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

204

No response body

delete

/api/v1/account/devtest/

HTTPcURLJavaScriptPython

DELETE /api/v1/account/devtest/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

get

Retrieve the current user's basic information.

Args: request: The HTTP request object.

Returns: Response: Serialized User data for the authenticated user.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for User including the nested UserProfile.

usernamestring · max: 150 · nullableOptional

emailstring · email · nullableRead-onlyOptional

User's primary email address, synchronized with the primary EmailAddress.

first_namestring · max: 30Optional

last_namestring · max: 30Optional

last_loginstring · date-time · nullableOptional

unsafe_metadataanyOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

last_sign_in_atstring · date-time · nullableOptional

email_verifiedbooleanOptional

phone_number_verifiedbooleanOptional

two_factor_enabledbooleanOptional

is_activebooleanOptional

is_staffbooleanOptional

is_superuserbooleanOptional

Designates that this user has all permissions without explicitly assigning them.

is_developerbooleanOptional

is_beta_testerbooleanOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

session_actorstring · max: 255 · nullableOptional

rolesinteger[]Optional

audstringRead-onlyOptionalDefault: http://localhost:3000

get

/api/v1/account/user/

HTTPcURLJavaScriptPython

GET /api/v1/account/user/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "username": "text",
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "last_login": "2026-04-03T19:35:51.838Z",
  "unsafe_metadata": null,
  "created_at": "2026-04-03T19:35:51.838Z",
  "updated_at": "2026-04-03T19:35:51.838Z",
  "last_sign_in_at": "2026-04-03T19:35:51.838Z",
  "email_verified": true,
  "phone_number_verified": true,
  "two_factor_enabled": true,
  "is_active": true,
  "is_staff": true,
  "is_superuser": true,
  "is_developer": true,
  "is_beta_tester": true,
  "subscription_level": 0,
  "session_actor": "text",
  "roles": [
    1
  ],
  "aud": "http://localhost:3000"
}

post

Partially update the current user's basic information.

Args: request: The HTTP request object containing update data.

Returns: Response: Updated serialized User data or validation errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for User including the nested UserProfile.

usernamestring · max: 150 · nullableOptional

first_namestring · max: 30Optional

last_namestring · max: 30Optional

last_loginstring · date-time · nullableOptional

unsafe_metadataanyOptional

last_sign_in_atstring · date-time · nullableOptional

email_verifiedbooleanOptional

phone_number_verifiedbooleanOptional

two_factor_enabledbooleanOptional

is_activebooleanOptional

is_staffbooleanOptional

is_superuserbooleanOptional

Designates that this user has all permissions without explicitly assigning them.

is_developerbooleanOptional

is_beta_testerbooleanOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

session_actorstring · max: 255 · nullableOptional

rolesinteger[]Optional

Responses

200Success

application/json

Serializer for User including the nested UserProfile.

usernamestring · max: 150 · nullableOptional

emailstring · email · nullableRead-onlyOptional

User's primary email address, synchronized with the primary EmailAddress.

first_namestring · max: 30Optional

last_namestring · max: 30Optional

last_loginstring · date-time · nullableOptional

unsafe_metadataanyOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

last_sign_in_atstring · date-time · nullableOptional

email_verifiedbooleanOptional

phone_number_verifiedbooleanOptional

two_factor_enabledbooleanOptional

is_activebooleanOptional

is_staffbooleanOptional

is_superuserbooleanOptional

Designates that this user has all permissions without explicitly assigning them.

is_developerbooleanOptional

is_beta_testerbooleanOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

session_actorstring · max: 255 · nullableOptional

rolesinteger[]Optional

audstringRead-onlyOptionalDefault: http://localhost:3000

post

/api/v1/account/user/

HTTPcURLJavaScriptPython

POST /api/v1/account/user/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "last_login": "2026-04-03T19:35:51.838Z",
  "unsafe_metadata": null,
  "last_sign_in_at": "2026-04-03T19:35:51.838Z",
  "email_verified": true,
  "phone_number_verified": true,
  "two_factor_enabled": true,
  "is_active": true,
  "is_staff": true,
  "is_superuser": true,
  "is_developer": true,
  "is_beta_tester": true,
  "subscription_level": 0,
  "session_actor": "text",
  "roles": [
    1
  ]
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "username": "text",
  "email": "[email protected]",
  "first_name": "text",
  "last_name": "text",
  "last_login": "2026-04-03T19:35:51.838Z",
  "unsafe_metadata": null,
  "created_at": "2026-04-03T19:35:51.838Z",
  "updated_at": "2026-04-03T19:35:51.838Z",
  "last_sign_in_at": "2026-04-03T19:35:51.838Z",
  "email_verified": true,
  "phone_number_verified": true,
  "two_factor_enabled": true,
  "is_active": true,
  "is_staff": true,
  "is_superuser": true,
  "is_developer": true,
  "is_beta_tester": true,
  "subscription_level": 0,
  "session_actor": "text",
  "roles": [
    1
  ],
  "aud": "http://localhost:3000"
}

get

Retrieve the current user's extended information.

Args: request: The HTTP request object.

Returns: Response: Serialized UserExt data for the authenticated user.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for UserExt model data.

addressstring · max: 255 · nullableOptional

citystring · max: 100 · nullableOptional

statestring · max: 100 · nullableOptional

countrystring · max: 100 · nullableOptional

zip_codestring · max: 10 · nullableOptional

birth_datestring · date · nullableOptional

get

/api/v1/account/userextension/

HTTPcURLJavaScriptPython

GET /api/v1/account/userextension/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "address": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "zip_code": "text",
  "birth_date": "2026-04-03"
}

post

Partially update the current user's extended information.

Args: request: The HTTP request object containing update data.

Returns: Response: Updated serialized UserExt data or validation errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for UserExt model data.

addressstring · max: 255 · nullableOptional

citystring · max: 100 · nullableOptional

statestring · max: 100 · nullableOptional

countrystring · max: 100 · nullableOptional

zip_codestring · max: 10 · nullableOptional

birth_datestring · date · nullableOptional

Responses

200Success

application/json

Serializer for UserExt model data.

addressstring · max: 255 · nullableOptional

citystring · max: 100 · nullableOptional

statestring · max: 100 · nullableOptional

countrystring · max: 100 · nullableOptional

zip_codestring · max: 10 · nullableOptional

birth_datestring · date · nullableOptional

post

/api/v1/account/userextension/

HTTPcURLJavaScriptPython

POST /api/v1/account/userextension/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "address": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "zip_code": "text",
  "birth_date": "2026-04-03"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "address": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "zip_code": "text",
  "birth_date": "2026-04-03"
}

get

Retrieve the current user's organisation information.

Args: request: The HTTP request object.

Returns: Response: Serialized organisation data for the authenticated user.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

get

/api/v1/account/userorganisation/

HTTPcURLJavaScriptPython

GET /api/v1/account/userorganisation/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

post

Partially update the current user's organisation information.

Args: request: The HTTP request object containing update data.

Returns: Response: Updated serialized organisation data or validation errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

Responses

200Success

application/json

Serializer for UserOrganisation model data.

org_idstring · max: 255 · nullableOptional

org_namestring · max: 255 · nullableOptional

org_rolestring · max: 255 · nullableOptional

org_slugstring · max: 255 · nullableOptional

org_has_imagebooleanOptional

org_image_urlstring · uri · max: 500 · nullableOptional

org_public_metadataanyOptional

org_private_metadataanyOptional

org_unsafe_metadataanyOptional

org_membership_permissionsanyOptional

post

/api/v1/account/userorganisation/

HTTPcURLJavaScriptPython

POST /api/v1/account/userorganisation/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "org_id": "text",
  "org_name": "text",
  "org_role": "text",
  "org_slug": "text",
  "org_has_image": true,
  "org_image_url": "https://example.com",
  "org_public_metadata": null,
  "org_private_metadata": null,
  "org_unsafe_metadata": null,
  "org_membership_permissions": null
}

get

Retrieve the current user's profile data.

Args: request: The HTTP request object.

Returns: Response: Serialized UserProfile data for the authenticated user.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for UserProfile model data.

timezonestring · max: 50 · nullableOptional

languagestring · max: 50 · nullableOptional

biostringOptional

aboutmestringOptional

facebookstring · uri · max: 255 · nullableOptional

twitterstring · uri · max: 255 · nullableOptional

linkedinstring · uri · max: 255 · nullableOptional

githubstring · uri · max: 255 · nullableOptional

websitestring · uri · max: 255 · nullableOptional

interestsstring · nullableOptional

onboarding_tasksanyOptional

get

/api/v1/account/userprofile/

HTTPcURLJavaScriptPython

GET /api/v1/account/userprofile/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "timezone": "text",
  "language": "text",
  "bio": "text",
  "aboutme": "text",
  "facebook": "https://example.com",
  "twitter": "https://example.com",
  "linkedin": "https://example.com",
  "github": "https://example.com",
  "website": "https://example.com",
  "interests": "text",
  "onboarding_tasks": null
}

post

Partially update the current user's profile data.

Args: request: The HTTP request object containing update data.

Returns: Response: Updated serialized UserProfile data or validation errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for UserProfile model data.

timezonestring · max: 50 · nullableOptional

languagestring · max: 50 · nullableOptional

biostringOptional

aboutmestringOptional

facebookstring · uri · max: 255 · nullableOptional

twitterstring · uri · max: 255 · nullableOptional

linkedinstring · uri · max: 255 · nullableOptional

githubstring · uri · max: 255 · nullableOptional

websitestring · uri · max: 255 · nullableOptional

interestsstring · nullableOptional

onboarding_tasksanyOptional

Responses

200Success

application/json

Serializer for UserProfile model data.

timezonestring · max: 50 · nullableOptional

languagestring · max: 50 · nullableOptional

biostringOptional

aboutmestringOptional

facebookstring · uri · max: 255 · nullableOptional

twitterstring · uri · max: 255 · nullableOptional

linkedinstring · uri · max: 255 · nullableOptional

githubstring · uri · max: 255 · nullableOptional

websitestring · uri · max: 255 · nullableOptional

interestsstring · nullableOptional

onboarding_tasksanyOptional

post

/api/v1/account/userprofile/

HTTPcURLJavaScriptPython

POST /api/v1/account/userprofile/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 271

{
  "timezone": "text",
  "language": "text",
  "bio": "text",
  "aboutme": "text",
  "facebook": "https://example.com",
  "twitter": "https://example.com",
  "linkedin": "https://example.com",
  "github": "https://example.com",
  "website": "https://example.com",
  "interests": "text",
  "onboarding_tasks": null
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "timezone": "text",
  "language": "text",
  "bio": "text",
  "aboutme": "text",
  "facebook": "https://example.com",
  "twitter": "https://example.com",
  "linkedin": "https://example.com",
  "github": "https://example.com",
  "website": "https://example.com",
  "interests": "text",
  "onboarding_tasks": null
}

get

Retrieve the current user's subscription data.

Args: request: The HTTP request object.

Returns: Response: Serialized UserSubscription data or empty dict if not found.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer for User subscription data.

subscription_idstring · max: 255 · nullableOptional

subscription_namestring · max: 255 · nullableOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

subscription_statusstring · enumOptional

• active - Active
• inactive - Inactive
• cancelled - Cancelled
• suspended - Suspended

Possible values:

subscription_start_datestring · date-time · nullableOptional

subscription_end_datestring · date-time · nullableOptional

subscription_trial_end_datestring · date-time · nullableOptional

subscription_cancelled_datestring · date-time · nullableOptional

subscription_suspended_datestring · date-time · nullableOptional

subscription_metadataanyOptional

get

/api/v1/account/usersubscription/

HTTPcURLJavaScriptPython

GET /api/v1/account/usersubscription/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "subscription_id": "text",
  "subscription_name": "text",
  "subscription_level": 0,
  "subscription_status": "active",
  "subscription_start_date": "2026-04-03T19:35:51.838Z",
  "subscription_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_trial_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_cancelled_date": "2026-04-03T19:35:51.838Z",
  "subscription_suspended_date": "2026-04-03T19:35:51.838Z",
  "subscription_metadata": null
}

post

Partially update the current user's subscription data.

Args: request: The HTTP request object containing update data.

Returns: Response: Updated serialized UserSubscription data or validation errors.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializer for User subscription data.

subscription_idstring · max: 255 · nullableOptional

subscription_namestring · max: 255 · nullableOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

subscription_statusstring · enumOptional

• active - Active
• inactive - Inactive
• cancelled - Cancelled
• suspended - Suspended

Possible values:

subscription_start_datestring · date-time · nullableOptional

subscription_end_datestring · date-time · nullableOptional

subscription_trial_end_datestring · date-time · nullableOptional

subscription_cancelled_datestring · date-time · nullableOptional

subscription_suspended_datestring · date-time · nullableOptional

subscription_metadataanyOptional

Responses

200Success

application/json

Serializer for User subscription data.

subscription_idstring · max: 255 · nullableOptional

subscription_namestring · max: 255 · nullableOptional

subscription_levelinteger · enumOptional

• 0 - Free
• 10 - Basic
• 20 - Essential
• 30 - Plus
• 40 - Premium

Possible values:

subscription_statusstring · enumOptional

• active - Active
• inactive - Inactive
• cancelled - Cancelled
• suspended - Suspended

Possible values:

subscription_start_datestring · date-time · nullableOptional

subscription_end_datestring · date-time · nullableOptional

subscription_trial_end_datestring · date-time · nullableOptional

subscription_cancelled_datestring · date-time · nullableOptional

subscription_suspended_datestring · date-time · nullableOptional

subscription_metadataanyOptional

post

/api/v1/account/usersubscription/

HTTPcURLJavaScriptPython

POST /api/v1/account/usersubscription/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 411

{
  "subscription_id": "text",
  "subscription_name": "text",
  "subscription_level": 0,
  "subscription_status": "active",
  "subscription_start_date": "2026-04-03T19:35:51.838Z",
  "subscription_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_trial_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_cancelled_date": "2026-04-03T19:35:51.838Z",
  "subscription_suspended_date": "2026-04-03T19:35:51.838Z",
  "subscription_metadata": null
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "subscription_id": "text",
  "subscription_name": "text",
  "subscription_level": 0,
  "subscription_status": "active",
  "subscription_start_date": "2026-04-03T19:35:51.838Z",
  "subscription_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_trial_end_date": "2026-04-03T19:35:51.838Z",
  "subscription_cancelled_date": "2026-04-03T19:35:51.838Z",
  "subscription_suspended_date": "2026-04-03T19:35:51.838Z",
  "subscription_metadata": null
}

get

List all TradeHistory entries.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer class for TradeHistory model.

idintegerRead-onlyOptional

created_atstring · date-timeOptional

update_atstring · date-timeRead-onlyOptional

versioninteger · min: -2147483648 · max: 2147483647Optional

symbolstring · max: 20Optional

sidestring · max: 10Optional

typestring · max: 20Optional

qtyinteger · min: -2147483648 · max: 2147483647Optional

trade_pricenumber · doubleOptional

close_pricenumber · doubleOptional

open_timestring · date-time · nullableOptional

close_timestring · date-time · nullableOptional

durationstring · nullableOptional

commission_feenumber · double · nullableOptional

order_idstring · max: 20Optional

trade_idstring · max: 20Optional

client_account_idstring · max: 50 · nullableOptional

account_aliasstring · max: 50 · nullableOptional

userstring · uuidRequired

get

/api/v1/ibkr/tradehistory/

HTTPcURLJavaScriptPython

GET /api/v1/ibkr/tradehistory/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": 1,
    "created_at": "2026-04-03T19:35:51.838Z",
    "update_at": "2026-04-03T19:35:51.838Z",
    "version": 1,
    "symbol": "text",
    "side": "text",
    "type": "text",
    "qty": 1,
    "trade_price": 1,
    "close_price": 1,
    "open_time": "2026-04-03T19:35:51.838Z",
    "close_time": "2026-04-03T19:35:51.838Z",
    "duration": "text",
    "commission_fee": 1,
    "order_id": "text",
    "trade_id": "text",
    "client_account_id": "text",
    "account_alias": "text",
    "user": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

List all TradeHistory entries.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200Success

application/json

Serializer class for TradeHistory model.

idintegerRead-onlyOptional

created_atstring · date-timeOptional

update_atstring · date-timeRead-onlyOptional

versioninteger · min: -2147483648 · max: 2147483647Optional

symbolstring · max: 20Optional

sidestring · max: 10Optional

typestring · max: 20Optional

qtyinteger · min: -2147483648 · max: 2147483647Optional

trade_pricenumber · doubleOptional

close_pricenumber · doubleOptional

open_timestring · date-time · nullableOptional

close_timestring · date-time · nullableOptional

durationstring · nullableOptional

commission_feenumber · double · nullableOptional

order_idstring · max: 20Optional

trade_idstring · max: 20Optional

client_account_idstring · max: 50 · nullableOptional

account_aliasstring · max: 50 · nullableOptional

userstring · uuidRequired

get

/api/v1/ibkr/trades/

HTTPcURLJavaScriptPython

GET /api/v1/ibkr/trades/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": 1,
    "created_at": "2026-04-03T19:35:51.838Z",
    "update_at": "2026-04-03T19:35:51.838Z",
    "version": 1,
    "symbol": "text",
    "side": "text",
    "type": "text",
    "qty": 1,
    "trade_price": 1,
    "close_price": 1,
    "open_time": "2026-04-03T19:35:51.838Z",
    "close_time": "2026-04-03T19:35:51.838Z",
    "duration": "text",
    "commission_fee": 1,
    "order_id": "text",
    "trade_id": "text",
    "client_account_id": "text",
    "account_alias": "text",
    "user": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

List method for ServerListViewSet class.

Authorizations

BearerAuthcookieAuth

AuthorizationstringRequired

JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'

Responses

200

No response body

No content

get

/api/v1/server/select/

HTTPcURLJavaScriptPython

GET /api/v1/server/select/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

No response body

No content