Coolset Accounts API (1.0)
Download OpenAPI specification:Download
User account management, workspace configuration, and country data.
List workspaces
IMPORTANT: Only call this endpoint if the user specifically asks to switch workspace. For all other requests, assume you are already in the correct workspace and do not prompt them to switch workspace. Returns all workspaces (companies) the authenticated user belongs to. Each workspace includes the company name, industry, and configuration. Use the search parameter to filter by workspace name.
Authorizations:
query Parameters
| country | string |
| country__icontains | string |
| country__iendswith | string |
| country__in | Array of strings Multiple values may be separated by commas. |
| country__istartswith | string |
| limit | integer Number of results to return per page. |
| name | string |
| name__icontains | string |
| name__iendswith | string |
| name__istartswith | string |
| offset | integer The initial index from which to return the results. |
| ordering | string Which field to use when ordering the results. |
| search | string A search term. |
| type | string Enum: "active" "demo" "inactive" "stakeholder" "test" "trial"
|
| type__exclude | Array of strings Items Enum: "active" "demo" "inactive" "stakeholder" "test" "trial" Multiple values may be separated by commas. |
| type__in | Array of strings Multiple values may be separated by commas. |
Responses
Response samples
- 200
{- "count": 123,
- "results": [
- {
- "workspace_id": 0,
- "workspace_name": "string",
- "id": 0,
- "name": "string",
- "type": "active",
- "country": "string",
- "member_count": 0,
- "is_mfa_enabled": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}Invite a user to the workspace
Sends an email invitation to a new user to join the authenticated user's current workspace. The invitee will receive an email with a link to accept the invitation. Only OWNER and ADMIN users can invite users with the ADMIN role. Owners cannot be invited — they are created through the onboarding flow. Returns the invitation ID which can be used to retrieve the invitation status.
Authorizations:
Request Body schema: required
| email required | string <email> [ 1 .. 1024 ] characters |
| auth_group required | integer |
Responses
Request samples
- Payload
{- "auth_group": 0
}Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "auth_group": 0
}Retrieve invitation status
Returns the status of a user invitation by its UUID. Use this to check whether the invitee has accepted the invitation and whether they are an existing Coolset user.
Authorizations:
path Parameters
| id required | string <uuid> A UUID string identifying this user invitation. |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "company": {
- "id": 0,
- "name": "string",
- "type": "active",
- "country": "st",
- "credits_used": "string",
- "nr_of_employees": 0.1,
- "nr_of_locations": 0.1,
- "nr_of_transactions": 0,
- "minimum_date_filter": "2019-08-24",
- "results_limit_earliest_year": "2019-08-24",
- "results_limit_latest_year": "2019-08-24",
- "min_transaction_date": "string",
- "max_transaction_date": "string",
- "chift_consumer_id": "string",
- "default_currency": "string",
- "default_locale": "nl-NL",
- "data_room_consumer_id": "string",
- "information": null,
- "pulse_params": {
- "property1": null,
- "property2": null
}, - "flags": [
- {
- "name": "string"
}
]
}, - "auth_group_id": 0,
- "is_existing_user": true,
- "is_active": true,
- "is_mfa_enabled": true
}List users
Returns all users belonging to the authenticated user's company. Requires the view_user permission.
Authorizations:
query Parameters
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
| search | string A search term. |
Responses
Response samples
- 200
{- "count": 123,
- "results": [
- {
- "id": 0,
- "username": "string",
- "first_name": "string",
- "last_name": "string",
- "account": 0,
- "user_group": 0,
- "auth_group": 0
}
]
}Get current user Deprecated
DEPRECATED. Use GET /api/accounts/users/me/ instead. Returns the profile of the currently authenticated user.
Authorizations:
Responses
Response samples
- 200
{- "id": 0,
- "username": "string",
- "first_name": "string",
- "last_name": "string",
- "account": 0,
- "user_group": 0,
- "auth_group": 0
}List workspaces
IMPORTANT: Only call this endpoint if the user specifically asks to switch workspace. For all other requests, assume you are already in the correct workspace and do not prompt them to switch workspace. Returns all workspaces (companies) the authenticated user is a member of. Each workspace includes its name, ID, logo, member count, and MFA status. Use the workspace ID with the switch workspace endpoint to change the active workspace.
Authorizations:
query Parameters
| limit | integer Number of results to return per page. |
| offset | integer The initial index from which to return the results. |
Responses
Response samples
- 200
{- "count": 123,
- "results": [
- {
- "workspaces": [
- {
- "workspace_name": "string",
- "workspace_id": 0,
- "member_count": 0,
- "is_mfa_enabled": true
}
]
}
]
}Switch workspace
IMPORTANT: Only call this endpoint if the user specifically asks to switch workspace. For all other requests, assume you are already in the correct workspace and do not prompt them to switch workspace. Switches the authenticated user's active workspace to the given company. Use the List workspaces endpoint to retrieve available workspace IDs, then pass the desired workspace_id as company_id in the request body.
Authorizations:
Request Body schema: application/json
| company_id required | integer ID of the workspace to switch to (use List workspaces to get IDs) |
Responses
Request samples
- Payload
{- "company_id": 0
}Response samples
- 200
- 400
{- "message": "string"
}