Skip to content
Accounts API/accounts

Coolset Accounts API (1.0)

User account management, workspace configuration, and country data.

Download OpenAPI description
accounts-api.json
accounts-api.yaml
Overview
URL
https://coolset.com
E-mail
support@coolset.com
Languages
Servers
Mock server
https://api.coolset.com/_mock/accounts-api/
Production server
https://developers.coolset.com/api/

accounts

Operations

Accounts Countries List

Request

List all countries with optional filtering by name, codes, or search term

Security
Bearer
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

searchstring

Search countries by name (case-insensitive partial match)

namestring

Filter by exact country name

alpha_2string

Filter by 2-letter country code (e.g., 'US', 'GB')

alpha_3string

Filter by 3-letter country code (e.g., 'USA', 'GBR')

numericstring

Filter by numeric country code (e.g., '840' for US)

curl -i -X GET \
  'https://api.coolset.com/_mock/accounts-api/accounts/countries?limit=0&offset=0&search=string&name=string&alpha_2=string&alpha_3=string&numeric=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
namestring(Name)non-emptyread-only
alpha_2string(Alpha 2)non-emptyread-only
alpha_3string(Alpha 3)non-emptyread-only
numericstring(Numeric)non-emptyread-only
official_namestring or null(Official name)non-emptyread-only
flagstring or null(Flag)non-emptyread-only
]
Response
application/json
[
  {
    "name": "string",
    "alpha_2": "string",
    "alpha_3": "string",
    "numeric": "string",
    "official_name": "string",
    "flag": "string"
  }
]

Read-only ViewSet for country data using Country dataclass.

Request

Provides list and retrieve actions like a standard Django model.

Security
Bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.coolset.com/_mock/accounts-api/accounts/countries/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
namestring(Name)non-emptyread-only
alpha_2string(Alpha 2)non-emptyread-only
alpha_3string(Alpha 3)non-emptyread-only
numericstring(Numeric)non-emptyread-only
official_namestring or null(Official name)non-emptyread-only
flagstring or null(Flag)non-emptyread-only
Response
application/json
{
  "name": "string",
  "alpha_2": "string",
  "alpha_3": "string",
  "numeric": "string",
  "official_name": "string",
  "flag": "string"
}

Accounts User Config List

Request

Get current user configuration and available actions

Security
Bearer
curl -i -X GET \
  https://api.coolset.com/_mock/accounts-api/accounts/user-config \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
configobject(Config)required

Current user configuration

available_actionsArray of stringsrequired

List of actions available to the user based on their current state

company_typestring(Company type)non-emptyrequired

Type of company the user belongs to

Response
application/json
{
  "config": {},
  "available_actions": [
    "string"
  ],
  "company_type": "string"
}

Accounts User Config Partial Update

Request

Update user configuration

Security
Bearer
Bodyapplication/jsonrequired
sign_stakeholder_agreementboolean(Sign stakeholder agreement)

Set to true to sign the stakeholder agreement

curl -i -X PATCH \
  https://api.coolset.com/_mock/accounts-api/accounts/user-config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sign_stakeholder_agreement": true
  }'

Responses

Bodyapplication/json
configobject(Config)required

Current user configuration

available_actionsArray of stringsrequired

List of actions available to the user based on their current state

company_typestring(Company type)non-emptyrequired

Type of company the user belongs to

Response
application/json
{
  "config": {},
  "available_actions": [
    "string"
  ],
  "company_type": "string"
}

ViewSet for viewing and changing authenticated user's workspaces (companies).

Request

This view is optimized to prevent N+1 queries through the use of annotations and prefetching in the repository layer.

Security
Bearer
Query
namestring

name

name__icontainsstring

name__icontains

name__istartswithstring

name__istartswith

name__iendswithstring

name__iendswith

typestring

type

Enum"active""inactive""test""demo""trial""stakeholder"
type__instring

type__in

countrystring

country

country__icontainsstring

country__icontains

country__istartswithstring

country__istartswith

country__iendswithstring

country__iendswith

country__instring

country__in

type__excludestring

type__exclude

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/accounts-api/accounts/workspaces?name=string&name__icontains=string&name__istartswith=string&name__iendswith=string&type=active&type__in=string&country=string&country__icontains=string&country__istartswith=string&country__iendswith=string&country__in=string&type__exclude=string&ordering=string&search=string&limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(Workspace)required
results[].​workspace_idinteger(Workspace id)read-only
results[].​workspace_namestring(Workspace name)non-emptyread-only
results[].​workspace_logostring(uri)(Workspace logo)read-only
results[].​idinteger(ID)read-only
results[].​namestring(Name)non-emptyread-only
results[].​logostring or null(uri)(Logo)read-only
results[].​typestring(Type)read-only
Enum"active""inactive""test""demo""trial""stakeholder"
results[].​countrystring or null(Country)non-emptyread-only
results[].​member_countinteger(Member count)read-only
results[].​is_mfa_enabledboolean(Is mfa enabled)read-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}