Module: Contacts
Collection: Organisations
Object Key: contacts.org
The Organisation Object is used to represent an organisation or company record in Organisation Collection store.
| Friendly Field Name | Data Field Name | General Data Type | Description | Optimised for Searching |
|---|---|---|---|---|
| UUID | uuid | UUID | Universally Unique Identifier for each organisation object. | Yes |
| Application UUID | app_uuid | UUID | Identifier for the associated application. This is what links the object in your account to your specific application. | Yes |
| Application Context Ref | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub UUID | sub_uuid | UUID | Similar to the Application Context Ref, This field can be used to store a UUID to another Object. | Yes |
| Label | label | Text (max length 50) | A label for easier identification of the organisation. | Yes |
| Parent Organisation UUID | parent_org_uuid | UUID | Identifier for a parent organisation, if applicable. The Parent Object must already exist in this Collection, otherwise an error will occur when creating the new Object. | No |
| Organisation Name | org_name | Text (max length 50) | Name of the organisation. | Yes |
| Organisation Type | org_type | Enumerated List | Type of organisation (e.g., customer, lead, partner). Allowable values are:agent, account, customer, franchisee, lead, licensee, occupant, partner, subscriber, supplier, tenant, user other, <empty-string> | Yes |
| Organisation Website | org_website | Text (max length 100) | Website URL of the organisation. | No |
| Organisation Email | org_email | Text (max length 100) | Email address of the organisation. | Yes |
| Organisation Phone | org_phone | Text (max length 20) | Phone number of the organisation. | Yes |
| Organisation Fax | org_fax | Text (max length 20) | Fax number of the organisation. | No |
| Organisation Address Line 1 | org_addr_line1 | Text (max length 50) | First line of the organisation’s address. | No |
| Organisation Address Line 2 | org_addr_line2 | Text (max length 50) | Second line of the organisation’s address. | No |
| Organisation Address Line 3 | org_addr_line3 | Text (max length 50) | Third line of the organisation’s address. | No |
| Organisation Address Line 4 | org_addr_line4 | Text (max length 50) | Fourth line of the organisation’s address. | No |
| Organisation City | org_city | Text (max length 50) | City / town in the organisation’s address. | Yes |
| Organisation County | org_county | Text (max length 50) | County / state in the organisation’s address. | No |
| Organisation Postcode | org_postcode | Text (max length 10) | Postal / Zip code in the organisation’s address. | No |
| Organisation Country Code | org_country_code | Text (max length 3) | ISO 3-digit country code of the organisation. | Yes |
| Organisation VAT Number | org_vat_number | Text (max length 20) | VAT number of the organisation. | No |
| Organisation Registration Number | org_reg_number | Text (max length 20) | Registration number of the organisation. | No |
| Organisation Notes | org_notes | Memo | Additional notes about the organisation. | No |
| Organisation Status | org_status | Enumerated List | Status of the organisation (e.g., active, inactive). Allowable values are:active, inactive, archived, test, other, <empty-string> | Yes |
| Organisation Contact Person | org_contact_person | Text (max length 50) | Name of the primary contact person at the organisation. | No |
| Organisation Contact Position | org_contact_position | Text (max length 50) | Position of the primary contact person at the organisation. | No |
| Organisation Contact Email | org_contact_email | Text (max length 100) | Email of the primary contact person at the organisation. | No |
| Organisation Contact Phone | org_contact_phone | Text (max length 20) | Phone number of the primary contact person at the organisation. | No |
| Organisation Taxonomy | org_taxonomy | Text (max length 50) | Categorisation of the organisation (default: org ). | Yes |
| Meta Data | meta_data | Memo | Additional meta data for the organisation. | No |
| Updated At | updated_at | DateTime | Timestamp when the record was last updated. | No |
| Created At | created_at | DateTime | Timestamp when the record was created. | No |
| Created By | created_by | Text (max length 50) | You can use this field to record who or what created the Object record. | No |
| Updated By | updated_by | Text (max length 50) | You can use this field to record who or what last updated the Object record. | No |