Accounts

The Accounts are the backbone of any SaaS solution. It is easy to push data,

Create accounts

POST /api/v1/accounts

This endpoint allows you to create accounts. The domain is the place where you can access the client. The endpoint supports custom attributes, just send them as other query parameters and they will be collected so you can query on it. The parameters should be snake_cased as shown below.

Query Parameters

Name	Type	Description
signup_date	string	The timestamp when the customer signed up
currency	string	Currency of the ARR
mrr*	string	How much ARR they are paying
plan	string	What pricing plan they are on
remote_id	string	Your internal ID for the account
name	string	Name of the account
active*	boolean	If the account is active (churned or not)

Headers

Name	Type	Description
Authentication	string	API-key

200 Cake successfully retrieved.

{    "status": "ok"}

You can pass additional information as you need. If you e.g. have a CRM solution you could pass the number of records the account has inserted. If you had a company providing a SaaS search solution, you can pass how many searches the account had done the last 30/60/90 days.

Attributes is a JSON field where you can add all your extra attributes. This could be data you would like to use to segment the accounts.