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": "45714cb6-68ae-40d7-b2d5-2c262932ceec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "15e176bb-ee28-450b-b5e6-4912450a231a",
"company_code": "sample string 5",
"company": {
"id": "dafcfafa-4135-4700-9fdc-57fc367b3021",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-06T10:41:58.9067799+00:00",
"sales_territory_id": "9ceb71d1-0ac4-4e57-a706-3cbf504fa2d7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1794f505-8a46-4698-902a-b8f91c3208a1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2aac2468-5075-46c2-9b39-b69e04082d2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26869601-fe02-4ac1-b8ad-015ebf60ff19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb63a1e0-9207-4940-91a1-2c2e909f9bef",
"db_currency_id": "fadee0dd-612f-4e15-8c43-8b542a912d6c",
"db_language_id": "03609b79-10a1-4c6f-83de-7682293736be",
"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-07-06T10:41:58.9067799+00:00"
},
"modified_dateutc": "2026-07-06T10:41:58.9067799+00:00"
},
"marketing_segment_id": "30a3602d-3925-40b3-a140-781ba74ea147",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "70fc029c-acb3-4987-8b34-311ac4fc57b6",
"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": "d80c9c12-724e-4c59-8076-147e26467e42",
"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": "4b207caf-0482-4475-993f-4574fa4629a7",
"db_country_code": "sample string 28",
"feelist_id": "eb07929f-f918-488b-95a9-2cf3695a473b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1da814fd-8ba3-4f1e-a5e5-6af622a60fb4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "dc402148-590a-4343-9bfc-d337fd2066e5",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-06T10:41:58.9067799+00:00",
"db_currency_id": "4e72e68c-4514-46cc-a910-e11ba4b8e60d",
"db_currency_code": "sample string 10"
},
"company_type_id": "d6c93431-3cf9-4da6-a0c4-bdd647d9ea77",
"company_type_name": "sample string 32",
"company_type": {
"id": "5fc2bca5-82f5-4d27-b7f6-e34a7cdc6bc0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8d55553-bc08-4aac-809e-45df31819852",
"sales_organization_code": "sample string 5"
},
"db_language_id": "39f58c74-74e1-4a75-a731-00eba2b41b19",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc068d27-da75-47a7-a407-ea32c1801bd1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f4948cd-d5cc-49c0-b637-2df553377928",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d0c497d6-ce40-4206-873f-f8b9a0611b12",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-06T10:41:58.9067799+00:00"
},
"company_sector_id": "56f3ad11-b5ca-474e-b2ad-8a857f34c1f1",
"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": "d87abde4-fdc2-4038-8e73-302cb4e8f3a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "338396da-e940-4e11-9dec-efff62c69884",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "18648e8d-37b0-4eee-974f-121c1de5e846",
"account_manager_user_code": "sample string 56",
"company_status_id": "a1228f9a-1f9f-48e6-aa4d-5982c1d35be6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-06T10:41:58.9067799+00:00",
"id2": 60
},
"db_language_id": "87364fcb-eec3-47b6-839a-3d16eafd42d1",
"db_language_code": "sample string 7",
"db_title_id": "eb486b50-c9f6-4479-953e-2759e0472fb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-06T10:41:58.9067799+00:00",
"create_date": "2026-07-06T10:41:58.9067799+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-07-06T10:41:58.9067799+00:00"
}