👥 Contacts

Individual contact management and information

Create contact (no group)

post
/api/v1.0/organisation/{unique_id}/contacts/create/

Create a new contact without requiring a contact group. First name, last name, and entity type are required. The contact_group field is optional.

Authorizations
sessionidstringRequired
Path parameters
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring · max: 100 · nullableOptional
translationsstringRequired
contact_groupstring · nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring · enumRequired

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring · max: 100 · nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring · min: 1 · max: 150Required
last_namestring · min: 1 · max: 150Required
emailstring · email · max: 254 · nullableOptional
phonestring · max: 17 · nullableOptional
mobilestring · max: 17 · nullableOptional
linkedin_urlstring · uri · max: 200 · nullableOptional

LinkedIn profile URL

job_titlestring · nullableOptional
departmentstring · nullableOptional
notesstring · nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
Responses
post
/api/v1.0/organisation/{unique_id}/contacts/create/

List all contacts

get
/api/v1.0/organisation/{unique_id}/contacts/

Get all contacts for an organisation with optional filters

Authorizations
sessionidstringRequired
Path parameters
unique_idstringRequired
Query parameters
contact_groupstringOptional

Filter by contact group name or unique_id

entity_typestring · enumOptional

Filter by entity type

Possible values:
is_activestringOptional

Filter by active status (true/false)

no_groupstringOptional

Show only contacts without a group (true/false)

searchstringOptional

Search contacts by first name or last name

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contacts/

Contact details (org level)

get
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/

Get a specific contact by unique_id. Works for contacts with or without groups.

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/

Update contact (org level)

put
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/update/

Update a specific contact by unique_id (full or partial update). Works for contacts with or without groups.

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring · max: 100 · nullableOptional
translationsstringRequired
contact_groupstring · nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring · enumRequired

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring · max: 100 · nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring · min: 1 · max: 150Required
last_namestring · min: 1 · max: 150Required
emailstring · email · max: 254 · nullableOptional
phonestring · max: 17 · nullableOptional
mobilestring · max: 17 · nullableOptional
linkedin_urlstring · uri · max: 200 · nullableOptional

LinkedIn profile URL

job_titlestring · nullableOptional
departmentstring · nullableOptional
notesstring · nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/update/

Update contact (org level)

patch
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/update/

Update a specific contact by unique_id (full or partial update). Works for contacts with or without groups.

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Contact model. Handles contact creation, updates, and group assignment.

unique_idstring · max: 100 · nullableOptional
translationsstringOptional
contact_groupstring · nullableOptional

Contact group unique_id (optional - can be assigned later)

entity_typestring · enumOptional

Type of entity (client, vendor, lead)

  • client - Client
  • vendor - Vendor
  • lead - Lead
Possible values:
entity_idstring · max: 100 · nullableOptional

ID of the entity this contact belongs to (optional for potential clients/vendors)

first_namestring · min: 1 · max: 150Optional
last_namestring · min: 1 · max: 150Optional
emailstring · email · max: 254 · nullableOptional
phonestring · max: 17 · nullableOptional
mobilestring · max: 17 · nullableOptional
linkedin_urlstring · uri · max: 200 · nullableOptional

LinkedIn profile URL

job_titlestring · nullableOptional
departmentstring · nullableOptional
notesstring · nullableOptional
is_activebooleanOptional
primary_contactbooleanOptional

Indicates if this is the primary contact for the entity

date_createdstring · date-time · nullableOptional
last_updatedstring · date-time · nullableOptional
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/update/

Delete contact (org level)

delete
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/delete/

Delete a specific contact by unique_id. Works for contacts with or without groups.

Authorizations
sessionidstringRequired
Path parameters
contact_unique_idstringRequired
unique_idstringRequired
Responses
delete
/api/v1.0/organisation/{unique_id}/contacts/{contact_unique_id}/delete/

No content

Last updated