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": "99b72ff0-8c40-455f-b371-0852e9294d67",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e18a1721-0ba0-4416-a428-6da8cdc9192f",
"company_code": "sample string 5",
"company": {
"id": "120b8459-2d77-4fbf-befa-17dda96f1e47",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-01T14:48:11.6632365+00:00",
"sales_territory_id": "2592efec-84ab-484d-8ffa-c2a5ca6b27fd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a9e7fe3e-2926-4f03-bdde-ed9ebfef18c7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "68a3a14b-a192-44a6-9677-b61fd66c38a5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "341be91f-0cf2-4959-bb83-2fa219824adc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f98b155d-904a-4546-bb4f-60927a972185",
"db_currency_id": "bf3caaff-5a04-4764-acab-291972cb58ea",
"db_language_id": "23deb2bd-792c-406c-b2ac-ac425d9d85b1",
"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-02-01T14:48:11.6632365+00:00"
},
"modified_dateutc": "2026-02-01T14:48:11.6632365+00:00"
},
"marketing_segment_id": "26e1277e-2573-4cfa-8aca-97d51afe77f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4e83f4e4-3adc-4731-8ade-f9a6352c0b7b",
"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": "6366084d-8c59-4005-b5b0-732c72805afc",
"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": "ddcc09aa-ada9-42f1-9e7e-5d53e0eff98a",
"db_country_code": "sample string 28",
"feelist_id": "f2d3f9c4-d940-4c64-8789-2769ef7a63ee",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9a634ea6-3729-4a55-b545-5f16c1945f24",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "689b7d7e-4d8b-4a53-b611-be8c30ebc383",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-01T14:48:11.6632365+00:00",
"db_currency_id": "9cd65dc3-6784-451f-9214-e769a3c7a301",
"db_currency_code": "sample string 10"
},
"company_type_id": "f5bb8f62-31f2-4707-915f-97f6f0aea9d7",
"company_type_name": "sample string 32",
"company_type": {
"id": "b2f897a4-0ae2-42e0-bbc4-1202eebd845e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cf3caf34-eda2-456b-9068-016e2d720b7b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1626f562-436a-4478-9d0b-7e612c141001",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5800227f-5f55-4d1e-9ba6-a0757803174a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e14f4c3a-734d-4504-988b-11382dee797f",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e935d7f3-c313-41c6-a9a9-be0a3e884698",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-01T14:48:11.6632365+00:00"
},
"company_sector_id": "cdab43ca-f4f2-404c-bf40-fdcd6bf9f852",
"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": "e8e3e25f-aef9-4e23-876a-f11e88cffe16",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ae643ccd-235d-41da-b002-f896532492b0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fbb24ce1-710c-46f1-80a5-90842f6f42fe",
"account_manager_user_code": "sample string 56",
"company_status_id": "97212296-9031-4e23-9569-96ac3b3a2418",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-01T14:48:11.6632365+00:00",
"id2": 60
},
"db_language_id": "5d45da8c-626c-46f0-ae83-4ccff11c1de7",
"db_language_code": "sample string 7",
"db_title_id": "81f17279-7eab-4002-bbb1-ee827bb1ee81",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-01T14:48:11.6632365+00:00",
"create_date": "2026-02-01T14:48:11.6632365+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-02-01T14:48:11.6632365+00:00"
}