Contacts

Individual contact management endpoints

Create contact

post

Create a new contact in a contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
201Success
application/json
post
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/create/
POST /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/create/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "contact_group_name": "text",
  "entity_type": "client",
  "entity_type_display": "text",
  "entity_id": "text",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "mobile": "text",
  "linkedin_url": "https://example.com",
  "is_active": true,
  "primary_contact": true,
  "date_created": "2025-10-25T15:27:09.782Z",
  "last_updated": "2025-10-25T15:27:09.782Z"
}

List contacts

get

Get all contacts in a specific contact group

Authorizations
Path parameters
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/
GET /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*
200Success
[
  {
    "unique_id": "text",
    "translations": "text",
    "organisation_name": "text",
    "created_by_name": "text",
    "contact_group_name": "text",
    "entity_type": "client",
    "entity_type_display": "text",
    "entity_id": "text",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "[email protected]",
    "phone": "text",
    "mobile": "text",
    "linkedin_url": "https://example.com",
    "is_active": true,
    "primary_contact": true,
    "date_created": "2025-10-25T15:27:09.782Z",
    "last_updated": "2025-10-25T15:27:09.782Z"
  }
]

Contact details

get

Get, update, or delete a specific contact

Authorizations
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
get
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/
GET /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "contact_group_name": "text",
  "entity_type": "client",
  "entity_type_display": "text",
  "entity_id": "text",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "mobile": "text",
  "linkedin_url": "https://example.com",
  "is_active": true,
  "primary_contact": true,
  "date_created": "2025-10-25T15:27:09.782Z",
  "last_updated": "2025-10-25T15:27:09.782Z"
}

Contact details

put

Get, update, or delete a specific contact

Authorizations
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
put
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/
PUT /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "contact_group_name": "text",
  "entity_type": "client",
  "entity_type_display": "text",
  "entity_id": "text",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "mobile": "text",
  "linkedin_url": "https://example.com",
  "is_active": true,
  "primary_contact": true,
  "date_created": "2025-10-25T15:27:09.782Z",
  "last_updated": "2025-10-25T15:27:09.782Z"
}

Contact details

delete

Get, update, or delete a specific contact

Authorizations
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
delete
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/
DELETE /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "contact_group_name": "text",
  "entity_type": "client",
  "entity_type_display": "text",
  "entity_id": "text",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "mobile": "text",
  "linkedin_url": "https://example.com",
  "is_active": true,
  "primary_contact": true,
  "date_created": "2025-10-25T15:27:09.782Z",
  "last_updated": "2025-10-25T15:27:09.782Z"
}

Contact details

patch

Get, update, or delete a specific contact

Authorizations
Path parameters
contact_unique_idstringRequired
group_unique_idstringRequired
unique_idstringRequired
Responses
200Success
application/json
patch
/api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/
PATCH /api/v1.0/organisation/{unique_id}/contact-groups/{group_unique_id}/contacts/{contact_unique_id}/ HTTP/1.1
Host: skhokho.ai
Authorization: Basic username:password
Accept: */*

{
  "unique_id": "text",
  "translations": "text",
  "organisation_name": "text",
  "created_by_name": "text",
  "contact_group_name": "text",
  "entity_type": "client",
  "entity_type_display": "text",
  "entity_id": "text",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "mobile": "text",
  "linkedin_url": "https://example.com",
  "is_active": true,
  "primary_contact": true,
  "date_created": "2025-10-25T15:27:09.782Z",
  "last_updated": "2025-10-25T15:27:09.782Z"
}
PreviousContact GroupsNextModels