Get Contact by email
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
|
Email of contact |
string |
Required |
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 |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
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 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "8337efdf-1e3d-409a-8046-f24eecd5116e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75c18671-d99d-4ebe-8738-b7e2c06608c2",
"company_code": "sample string 5",
"company": {
"id": "f8dcb70a-9d1a-453e-8a0f-dbde9db18bbf",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-03T06:50:39.4701539+00:00",
"sales_territory_id": "1d2ba1e6-612d-43b6-ac9c-44e7c7398fdf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "75af61a8-1a71-48fd-8433-c9182242964e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58a0d347-6f03-4e24-aac3-0cb11fb3762d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fccdd156-7a8d-48a2-8b97-bde74a90da81",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ce823c2f-febd-487a-9b03-6ecd290407a2",
"db_currency_id": "a0af6841-68f3-45d0-954e-676876474ded",
"db_language_id": "6107c0d6-a1cc-4938-a878-4bdf57043d15",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00"
},
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00"
},
"marketing_segment_id": "94744c41-ce1f-48d5-8ef9-a25ac9439352",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1149d260-7975-40ec-9128-75e2423c2ae0",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "f95c353e-0956-4f88-960d-f2290288d902",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "478f33a9-cc04-4515-954d-a05d10f22f73",
"db_country_code": "sample string 28",
"feelist_id": "79f86907-3751-4419-8be4-46ffafdf175e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "95d93b9a-93d4-40a7-9496-a5ec3613b8fb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36693562-8720-4ebf-bfde-816f21b30c90",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00",
"db_currency_id": "4586d66e-de69-41e9-834e-7deeb100ce61",
"db_currency_code": "sample string 10"
},
"company_type_id": "e7bffb8e-6726-4269-affc-b80f10b0f731",
"company_type_name": "sample string 32",
"company_type": {
"id": "0a20996e-32b8-468e-959d-da751573af8a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "636f92bf-0ffb-4576-b05b-d5cadba72911",
"sales_organization_code": "sample string 5"
},
"db_language_id": "df0d37c8-b670-4295-aed4-277bf366a92b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "382c8515-5d24-4aa9-9192-9f9f9e5d6e06",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "61c1d426-252c-48be-a69b-ede98ce947ea",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6119807a-23c4-43ce-b09a-c211a53ab82f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00"
},
"company_sector_id": "b4f62322-9003-4593-96a4-938692ea2310",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "ae5b645d-4190-4a69-9329-b20eb92038f7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "61387d83-72f9-46fb-b38d-69fbf255dff3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e0a2f53f-3810-4ff4-a9f7-d93cb1db10e5",
"account_manager_user_code": "sample string 56",
"company_status_id": "a4b282c8-b989-44dc-991c-440be766222d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00",
"id2": 60
},
"db_language_id": "4b0606ea-cb9f-4a51-aa8b-eb278201e838",
"db_language_code": "sample string 7",
"db_title_id": "e15db5a2-7687-4dd1-a2d6-3b1e8e8fef26",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-03T06:50:39.4701539+00:00",
"create_date": "2026-01-03T06:50:39.4701539+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-01-03T06:50:39.4701539+00:00"
}