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": "b33a1bbb-8aa3-441a-a99e-ac3cbea703b7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ec5e9b18-8cdb-4c73-9533-0a797694ad72",
"company_code": "sample string 5",
"company": {
"id": "55c31b50-f6b7-45a8-852a-61b4b60c34d6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T21:05:37.8886436+00:00",
"sales_territory_id": "07aa7d1f-b0c4-42e2-a256-b5e26d2d1a7c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a7005ffd-ee28-40f1-8505-7f4a231cb909",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "75e6fa4e-135b-45b8-9d3c-6a5f8c806078",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d932e700-86aa-4bb3-9719-39ed8446946c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72cbe028-f680-4410-9b12-a1359a8c8c66",
"db_currency_id": "59b2633c-6e9c-4853-91ad-363b7653a184",
"db_language_id": "c7b4abc4-392a-4332-97a8-f7ed808d53e7",
"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-05-07T21:05:37.8886436+00:00"
},
"modified_dateutc": "2026-05-07T21:05:37.8886436+00:00"
},
"marketing_segment_id": "1df5caea-c2e0-45ad-916d-205b70c7134f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3f951530-93be-4eee-92ef-a7c0471a55c9",
"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": "a86e5d87-acbc-4ad8-b0ae-65c98a0cd32b",
"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": "6e9c997b-6e31-4cf9-b097-877b19822ed6",
"db_country_code": "sample string 28",
"feelist_id": "2a22f4fe-6352-479d-b40f-34670c876aef",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3028a4f1-7be7-4909-8fd9-c1ee4b5d98d9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c6c1742-95cc-462f-99e2-c9612b88c43d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T21:05:37.8886436+00:00",
"db_currency_id": "32d318fe-0568-4124-8559-4ffb08de49cb",
"db_currency_code": "sample string 10"
},
"company_type_id": "4e1391ae-e170-4aba-9e7c-d9bc91661ce0",
"company_type_name": "sample string 32",
"company_type": {
"id": "0155e5b1-941e-440b-8ff5-ae3f40507524",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "47d56df5-f0c1-43f8-8349-701ef442b11c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e7e1c0c-6e4f-4c1b-a89f-992f069a055b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "36088af2-ce41-4823-b8eb-81ce371cad3b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3c500a8f-35fc-4d53-aa91-ceac5b512b2d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "048a7e51-065a-45b1-9c24-b46745214521",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T21:05:37.8886436+00:00"
},
"company_sector_id": "feec5afa-205d-4e4d-88da-c9bc46f080dd",
"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": "3278987f-a200-4f35-aecb-7a6a4d1b11b1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c5551bde-4263-4301-8af1-d03b05773a20",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "08fa4ab6-fcbc-4e7c-99cb-14df5b84235a",
"account_manager_user_code": "sample string 56",
"company_status_id": "36fba17f-d3d0-4ba8-a0aa-25407cb50806",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T21:05:37.8886436+00:00",
"id2": 60
},
"db_language_id": "0c161bf8-d43f-40b4-b3fc-63cb4a204386",
"db_language_code": "sample string 7",
"db_title_id": "9a427bbe-bdbd-4604-9cab-29f5eea04b0c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T21:05:37.8886436+00:00",
"create_date": "2026-05-07T21:05:37.8886436+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-05-07T21:05:37.8886436+00:00"
}