Organization Contacts

get_organization_contacts

Get all organization contacts with filters

Parameters

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contactTypestringCLIENTCUSTOMERLEAD

Filter by contact type

employeeIdstring<uuid>

Filter by employee ID

namestring

Filter by name (partial match)

primaryEmailstring

Filter by primary email (partial match)

primaryPhonestring

Filter by primary phone (partial match)

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>

Relations to include (e.g., ["contact", "projects", "members"])

get_organization_contact_count

Get organization contact count in the same tenant

Parameters

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contactTypestringCLIENTCUSTOMERLEAD

Filter by contact type

employeeIdstring<uuid>

Filter by employee ID

get_organization_contacts_pagination

Get organization contacts by pagination in the same tenant

Parameters

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contactTypestringCLIENTCUSTOMERLEAD

Filter by contact type

namestring

Filter by name (partial match)

primaryEmailstring

Filter by primary email (partial match)

primaryPhonestring

Filter by primary phone (partial match)

membersArray<string>

Filter by member IDs

pagenumber1

Page number

limitnumber10

Items per page

relationsArray<string>

Relations to include

get_organization_contacts_by_employee

Get organization contacts assigned to a specific employee

Parameters

employeeIdstring<uuid>required

The employee ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contactTypestringCLIENTCUSTOMERLEAD

Filter by contact type

get_organization_contact

Get a specific organization contact by ID

Parameters

idstring<uuid>required

The organization contact ID

relationsArray<string>

Relations to include (e.g., ["contact", "projects", "members", "tags"])

create_organization_contact

Create a new organization contact

Body

application/json
contact_dataobjectrequired

The data for creating the organization contact

Show child attributes
namestringrequired

The name (required)

organizationIdstringrequired

The organization ID (required)

[key: string]any

update_organization_contact

Update an existing organization contact

Parameters

idstring<uuid>required

The organization contact ID

contact_dataobjectrequired

The fields to update on the organization contact

update_organization_contact_by_employee

Update organization contact by employee

Parameters

idstring<uuid>required

The organization contact ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contact_dataobjectrequired

The fields to update on the organization contact

delete_organization_contact

Delete an organization contact by ID

Parameters

idstring<uuid>required

The organization contact ID

bulk_create_organization_contacts

Create multiple organization contacts in bulk

Body

application/json
contactsArray<object>required

Array of organization contacts to create

Show child attributes
namestringrequired

The name (required)

organizationIdstringrequired

The organization ID (required)

[key: string]any

bulk_update_organization_contacts

Update multiple organization contacts in bulk

Body

application/json
contactsArray<object>required

Array of organization contacts to update

Show child attributes
idstringrequired

The ID (required)

namestringrequired

The name (required)

organizationIdstringrequired

The organization ID (required)

tenantIdstringrequired

The tenant ID (required)

[key: string]any

bulk_delete_organization_contacts

Delete multiple organization contacts in bulk

Parameters

idsArray<string>required

Array of organization contact IDs to delete

get_organization_contact_statistics

Get organization contact statistics

Parameters

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

contactTypestringCLIENTCUSTOMERLEAD

Filter by contact type

employeeIdstring<uuid>

Filter by employee ID

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

assign_contact_to_employee

Assign an organization contact to an employee

Parameters

contactIdstring<uuid>required

The organization contact ID

employeeIdstring<uuid>required

The employee ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

unassign_contact_from_employee

Unassign an organization contact from an employee

Parameters

contactIdstring<uuid>required

The organization contact ID

employeeIdstring<uuid>required

The employee ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

get_contact_projects

Get projects associated with an organization contact

Parameters

contactIdstring<uuid>required

The organization contact ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

pagenumber1

Page number

limitnumber10

Items per page

invite_organization_contact

Send invitation to an organization contact

Parameters

contactIdstring<uuid>required

The organization contact ID

organizationIdstring<uuid>required

The organization ID

tenantIdstring<uuid>

The tenant ID

inviteTypestringEMAILSMSEMAIL

Invitation type

customMessagestring

Custom message for the invitation

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey