Client Contact API (1.0.0)

Download OpenAPI specification:Download

API for managing client contacts - individual contact persons associated with clients

Client Contact

Client contact management operations

Get all client contacts

Retrieve a list of all client contacts with optional filtering and pagination

Authorizations:

ApiKeyAuth

query Parameters

page	integer >= 1 Default: 1 Page number for pagination
per_page	integer [ 1 .. 100 ] Default: 25 Number of items per page
sort	string Sort field
	string or Array of strings Filter by contact ID(s)
search	string Search text for contact name
	string or Array of strings Filter by contact name(s)
from_updatedAt	integer <int64> Filter contacts updated after this timestamp
to_updatedAt	integer <int64> Filter contacts updated before this timestamp
from__id	string Filter contacts with ID greater than this value
to__id	string Filter contacts with ID less than this value
	Array of objects Advanced sorting options

Responses

Response samples

200
400
401
500

Content type

application/json

{"success": true,
"data": [{"_id": "60f1b2b3c9e9a12345678901",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"name": "John Smith",
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "active"
},
"company_namespace": ["company1"
],
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}
],
"pagination": {"page": 1,
"per_page": 25,
"pre_page": 0,
"next_page": 2,
"total": 100,
"total_page": 4
}
}

Create a new client contact

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string Contact name (required)
	AdminCreator (object) or RepCreator (object) or ClientCreator (object) User who created this contact
	AdminCreator (object) or RepCreator (object) or ClientCreator (object) User who last edited this contact
local_name	string Local/translated name
phone1	string Primary phone number
phone2	string Secondary phone number
email	string <email> Email address
title	string Job title or position
extra_info	string Additional information about the contact
disabled	boolean Whether the contact is disabled
media	Array of strings Array of media file URLs
cover_photo	string Cover photo URL
	object Metadata for third-party integrations
company_namespace	Array of strings Company namespaces this contact belongs to

Responses

Request samples

Payload

Content type

application/json

{"name": "John Smith",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123"
},
"company_namespace": ["company1"
]
}

Response samples

201
400
401
500

Content type

application/json

{"success": true,
"data": {"_id": "60f1b2b3c9e9a12345678901",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"name": "John Smith",
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "active"
},
"company_namespace": ["company1"
],
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}
}

Get a specific client contact

Retrieve a specific client contact by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Client contact ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"success": true,
"data": {"_id": "60f1b2b3c9e9a12345678901",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"name": "John Smith",
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "active"
},
"company_namespace": ["company1"
],
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}
}

Update a client contact

Update an existing client contact

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Client contact ID

Request Body schema: application/json

name	string Contact name
	AdminCreator (object) or RepCreator (object) or ClientCreator (object) User who created this contact
	AdminCreator (object) or RepCreator (object) or ClientCreator (object) User who last edited this contact
local_name	string Local/translated name
phone1	string Primary phone number
phone2	string Secondary phone number
email	string <email> Email address
title	string Job title or position
extra_info	string Additional information about the contact
disabled	boolean Whether the contact is disabled
media	Array of strings Array of media file URLs
cover_photo	string Cover photo URL
	object Metadata for third-party integrations
company_namespace	Array of strings Company namespaces this contact belongs to
_id	string Contact ID (for internal use)
createdAt	string <date-time> Creation timestamp (for internal use)
updatedAt	string <date-time> Last update timestamp (for internal use)
__v	integer Version key (for internal use)

Responses

Request samples

Payload

Content type

application/json

{"name": "John Smith Updated",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"local_name": "جون سميث محدث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith.updated@example.com",
"title": "Senior Sales Manager",
"extra_info": "Primary contact for technical issues - updated",
"disabled": false,
"media": ["https://example.com/photo1.jpg",
"https://example.com/photo2.jpg"
],
"cover_photo": "https://example.com/cover-updated.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "updated"
},
"company_namespace": ["company1"
],
"_id": "60f1b2b3c9e9a12345678901",
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}

Response samples

200
400
401
404
500

Content type

application/json

{"success": true,
"data": {"_id": "60f1b2b3c9e9a12345678901",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"name": "John Smith",
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "active"
},
"company_namespace": ["company1"
],
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}
}

Delete a client contact

Delete an existing client contact

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Client contact ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"success": true,
"data": {"_id": "60f1b2b3c9e9a12345678901",
"creator": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"editor": {"_id": "60f1b2b3c9e9a12345678901",
"username": "admin_user",
"name": "Admin User",
"type": "admin"
},
"name": "John Smith",
"local_name": "جون سميث",
"phone1": "+1234567890",
"phone2": "+1234567891",
"email": "john.smith@example.com",
"title": "Sales Manager",
"extra_info": "Primary contact for technical issues",
"disabled": false,
"media": ["https://example.com/photo1.jpg"
],
"cover_photo": "https://example.com/cover.jpg",
"integration_meta": {"external_id": "contact_123",
"sync_status": "active"
},
"company_namespace": ["company1"
],
"createdAt": "2023-01-15T10:30:00.000Z",
"updatedAt": "2023-01-15T10:30:00.000Z",
"__v": 0
}
}