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": "af4332cc-2ae2-42f7-9c95-e7ef3474275e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "362eb2cc-9dfe-4ebf-bed6-8d111215154a",
"company_code": "sample string 5",
"company": {
"id": "d6c2c964-1e11-4d61-ab45-ce2f3899ca39",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T01:45:06.9555437+00:00",
"sales_territory_id": "cc0990fd-8e09-432b-82a8-ac7f359db33f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "adff3f77-31da-42f7-91d6-e74c0b966c6c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "633b1d17-1827-4ec3-aef4-64450ddfd42a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "22578675-e9ee-4e0c-b4f4-9929fa019e9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8c3e4d9b-46c6-4df5-8bfd-f3ecaf8e0a4c",
"db_currency_id": "de5b475a-e43c-43c8-b192-f735d0ee69c1",
"db_language_id": "656c2ba7-ba46-4308-b416-4866827cd2d3",
"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": "2025-12-10T01:45:06.9555437+00:00"
},
"modified_dateutc": "2025-12-10T01:45:06.9555437+00:00"
},
"marketing_segment_id": "0be2c0b4-226a-4a46-99e5-00c7ca58719a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f36fdec-9ae6-4e9b-ba01-214ec5ab46a7",
"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": "4f92b658-32c2-442b-9c81-a73a577cd50f",
"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": "abea27f4-af3a-4e54-8369-9642e482d6e1",
"db_country_code": "sample string 28",
"feelist_id": "5a40946c-3193-493d-9d23-1d6142901513",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9ca527a6-f892-457b-a958-e121ed820cfa",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8dc5b193-e133-4ac8-b253-59652a0e6853",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T01:45:06.9555437+00:00",
"db_currency_id": "305f7828-26f3-4236-99cb-ac263948c4ad",
"db_currency_code": "sample string 10"
},
"company_type_id": "5949673d-4683-4c2f-90a3-13f3d9abf21e",
"company_type_name": "sample string 32",
"company_type": {
"id": "24c3630a-40ba-43bc-83b2-a7c6faa38726",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d193b70a-a162-4739-a563-a82e8b9f2084",
"sales_organization_code": "sample string 5"
},
"db_language_id": "134ff04f-88e5-479d-8b6c-a864cc99c452",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a4907d9-708a-46f5-91e3-7d3f76d5d885",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4530aaa0-0f15-4bef-9e70-c951a778d2ce",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a9ec0981-d118-4871-a694-3748c22108e1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T01:45:06.9555437+00:00"
},
"company_sector_id": "ff7741f4-efca-432a-a069-3ebaeafe1fa1",
"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": "a47572e3-c595-44e8-8cb8-e3586d9ef635",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "41e4fb4d-9b6c-4ac7-b1d7-610a5dc9d77a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "03bd3b2f-3ad7-48e7-80a8-2fdd4435b0ac",
"account_manager_user_code": "sample string 56",
"company_status_id": "9065b5e3-2c72-40c4-84d7-c0af6f026152",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T01:45:06.9555437+00:00",
"id2": 60
},
"db_language_id": "8c4ab5b7-b8ec-428e-84d9-e3e8fd7cb11c",
"db_language_code": "sample string 7",
"db_title_id": "e4c7f63d-344f-4a6b-8520-e81b79b79843",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T01:45:06.9555437+00:00",
"create_date": "2025-12-10T01:45:06.9555437+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": "2025-12-10T01:45:06.9711678+00:00"
}