Data Structure
| Field | Type | Length | Allow Null | Default Value |
|---|---|---|---|---|
| id | int | None | No | AUTO_INCREMENT |
| company_name | varchar | 150 | No | None |
| type | enum | None | No | 'organization' |
| address | text | None | Yes | None |
| city | varchar | 50 | Yes | NULL |
| state | varchar | 50 | Yes | NULL |
| zip | varchar | 50 | Yes | NULL |
| country | varchar | 50 | Yes | NULL |
| created_date | datetime | None | No | None |
| website | text | None | Yes | None |
| phone | varchar | 20 | Yes | NULL |
| currency_symbol | varchar | 20 | Yes | NULL |
| starred_by | mediumtext | None | No | None |
| group_ids | text | None | No | None |
| deleted | tinyint | 1 | No | 0 |
| is_lead | tinyint | 1 | No | 0 |
| lead_status_id | int | None | No | None |
| owner_id | int | None | No | None |
| created_by | int | None | No | None |
| sort | int | None | No | 0 |
| lead_source_id | int | None | No | None |
| last_lead_status | text | None | No | None |
| client_migration_date | date | None | No | None |
| vat_number | text | None | Yes | None |
| gst_number | text | None | Yes | None |
| stripe_customer_id | text | None | No | None |
| stripe_card_ending_digit | int | None | No | None |
| currency | varchar | 3 | Yes | NULL |
| disable_online_payment | tinyint | 1 | No | 0 |
| labels | text | None | Yes | None |
The fields is_lead, lead_status_id and lead_source_id. If is_lead is set as 1 then this is no longer a client, and is just a Lead.
REST API to Search, List or filter your workspace clients:
An strict number of fields are required in order to create a client, once a client or lead is created, is strongly recommended to attach a new contact or people in relation with this client.
The only difference between a client and a lead is the field is_lead set as 1, and the lead_status_id and lead_source_id are required to be set.