Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
company of the contact |
globally unique identifier | |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_title_id | globally unique identifier | ||
| db_functionbis_id | globally unique identifier | ||
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| notes | string | ||
| phone |
Phone number of the contact |
string |
Max length: 255 |
| mobile |
Mobile number of the contact |
string |
Max length: 255 |
|
|
string |
Max length: 255 |
|
| e_login |
e_login |
string |
Max length: 50 |
| e_servicedesk |
e_servicedesk |
boolean | |
| e_new_password |
new_e_password |
string |
Max length: 50 |
| e_commerce | boolean | ||
| e_document | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| contact_picture | Collection of byte |
Response Formats
application/json, text/json
Sample:
{
"id": "9691ce5a-d139-44b8-af06-590ab864bd48",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0571e69a-f18f-4779-a404-2d2bda6ff39f",
"db_language_id": "9711d0d6-e55b-46a8-be9f-eb28e4988259",
"db_title_id": "f4c63bbb-5270-4775-b095-54995cdd980c",
"db_functionbis_id": "84e3fa95-48ae-4e04-935d-590a3f8492a0",
"archived": true,
"functions": "sample string 9",
"notes": "sample string 10",
"phone": "sample string 11",
"mobile": "sample string 12",
"email": "sample string 13",
"e_login": "sample string 14",
"e_servicedesk": true,
"e_new_password": "sample string 16",
"e_commerce": true,
"e_document": true,
"modified_dateutc": "2026-01-11T21:01:52.3068804+00:00",
"contact_picture": "QEA="
}
application/xml, text/xml
Sample:
<contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <company_id>0571e69a-f18f-4779-a404-2d2bda6ff39f</company_id> <contact_picture>QEA=</contact_picture> <db_functionbis_id>84e3fa95-48ae-4e04-935d-590a3f8492a0</db_functionbis_id> <db_language_id>9711d0d6-e55b-46a8-be9f-eb28e4988259</db_language_id> <db_title_id>f4c63bbb-5270-4775-b095-54995cdd980c</db_title_id> <e_commerce>true</e_commerce> <e_document>true</e_document> <e_login>sample string 14</e_login> <e_new_password>sample string 16</e_new_password> <e_servicedesk>true</e_servicedesk> <email>sample string 13</email> <firstname>sample string 2</firstname> <functions>sample string 9</functions> <id>9691ce5a-d139-44b8-af06-590ab864bd48</id> <lastname>sample string 3</lastname> <mobile>sample string 12</mobile> <modified_dateutc>2026-01-11T21:01:52.306Z</modified_dateutc> <notes>sample string 10</notes> <phone>sample string 11</phone> </contact>