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": "86a2fa18-faf3-4284-904e-39317cc1a940",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bfbc2dbf-6dee-4935-b8d5-8a0c621808bb",
"company_code": "sample string 5",
"company": {
"id": "1c6fbed5-bae6-4077-b38b-016b60354241",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-23T06:13:54.3506904+00:00",
"sales_territory_id": "eb2845ac-2f8e-4a77-abf9-02019b0d4e5d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4c9c0538-b8ac-464b-af43-98059e5b8e28",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "daa6e2ee-4eb8-451b-99a5-2f9610d156f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "968684dd-0383-44f8-8d3a-5a2ef08d2292",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bdfb2686-3c2b-4f71-b4cc-93614b858b16",
"db_currency_id": "8fd6c0bf-4aaf-49b4-afd9-8a7b5bf0095e",
"db_language_id": "3e78ee85-38a0-4f99-b346-e48f83df6b40",
"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-11-23T06:13:54.3506904+00:00"
},
"modified_dateutc": "2025-11-23T06:13:54.3506904+00:00"
},
"marketing_segment_id": "c39676c8-8144-4cea-9ba6-fe35af98f090",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ad16bb0a-27d5-404d-85ec-49b2ed313535",
"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": "b855271c-4b22-416c-aa4d-052f0630a0e1",
"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": "fb2387f8-54a2-4ad5-8c62-e852e93ea18a",
"db_country_code": "sample string 28",
"feelist_id": "48107d4f-3e68-4688-b7c3-11f9eb7f1979",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a1f5750f-9460-40c5-9889-29acaccabf09",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff42acbb-202f-4c77-82cd-eabe0389f9ba",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-23T06:13:54.3506904+00:00",
"db_currency_id": "9dc236f3-f94e-4b63-be53-f887d0cf455d",
"db_currency_code": "sample string 10"
},
"company_type_id": "12de7884-94eb-45be-b439-1b151a94c754",
"company_type_name": "sample string 32",
"company_type": {
"id": "d86a0285-00da-4319-8c18-1510d9a81a00",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c79e2019-67ad-4df0-9c7f-0ff8b387ce15",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e57142ea-3b84-4eac-98ac-1507551e0997",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9a3c9ea9-7d77-4db7-8327-883a9dc317f8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e9bb431e-b16a-45e4-a4fc-9f750fab42b2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5fd5892b-a21f-47ec-9712-b4acb46f4b51",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-23T06:13:54.3506904+00:00"
},
"company_sector_id": "de26112b-7c80-4ac4-b0bd-d5165e2cb21a",
"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": "f83b03a7-1fac-4045-b101-2029d5046bb7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "82beb2c7-6f4f-4859-bad5-529c5f136e28",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8dcf0062-5a0b-4156-8655-f7d4cbc070a6",
"account_manager_user_code": "sample string 56",
"company_status_id": "69be0c5e-0f2d-42b1-b0e8-fceaf8720d29",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-23T06:13:54.3506904+00:00",
"id2": 60
},
"db_language_id": "90fd8b2e-1f01-4ec0-a468-aa50e8645f60",
"db_language_code": "sample string 7",
"db_title_id": "1418499a-5777-4ae3-88f4-4eedffcdba09",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-23T06:13:54.3506904+00:00",
"create_date": "2025-11-23T06:13:54.3506904+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-11-23T06:13:54.3506904+00:00"
}