Cubicl Docs
Search…
⌃K

Clients

Definitions of the types and format of the data used in the endpoints can be found at the bottom of the page.

Endpoints

get
https://cubicl.io/api/v1
/crm/customers
Get Clients
post
https://cubicl.io/api/v1
/crm/customers
Create Client
put
https://cubicl.io/api/v1
/crm/customers/:id
Update Client
delete
https://cubicl.io/api/v1
/crm/customers/:id
Delete Client

Data

Clients

type Client = {
_id: string;
name: string; // A short name shown in UI and used for search
phone: string;
email: string;
fullname: string;
// People working at this client you are in contact with
contacts: Contact[];
// An object where keys are custom field ids and values are field values
// customFields can be null
customFields: {
[fieldId: string]: string | null
} | null;
// List of user ids who get notifications for activities from portal users
// of this client
portalCustomerManagerIds: string[];
createdAt: number;
}

Contacts

type Contact = {
name: string;
position: string;
phone: string;
email: string;
}