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": "97136d83-99ea-45e0-9a18-3230a4a2b2a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "855a3500-772f-4222-85f3-06a15e4c6c1b",
"company_code": "sample string 5",
"company": {
"id": "0648b085-9366-4e7a-9c6b-68993cf1b33f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-11T13:22:45.5304328+00:00",
"sales_territory_id": "1b591a52-9604-4363-bfc2-647bf4606e4b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0fe0c9a0-75d5-4805-9e95-b4a1e2cd1852",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a4ba0817-5ec7-4219-9e47-3a4fd8ad541a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f82d96c0-baab-45ec-a3ed-bd2d2e88cdb4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f06b512f-ffe5-45d9-88ba-d091993b5597",
"db_currency_id": "2ad0a430-0d61-410e-b724-341965d7ad4d",
"db_language_id": "3a719e5f-914d-4670-b8bc-967ad9c5eaf8",
"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-11T13:22:45.5304328+00:00"
},
"modified_dateutc": "2026-07-11T13:22:45.5304328+00:00"
},
"marketing_segment_id": "aec7bf6e-7fce-4a3b-8742-3840a8f086f6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "28bb4dad-6f05-4540-b6a9-a39a9d255e18",
"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": "f8420e41-0a3e-4093-8761-e8354614be54",
"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": "58277b4c-8b2f-4017-a5fc-1d40d0dcf4e3",
"db_country_code": "sample string 28",
"feelist_id": "39ba41ea-c992-437b-94f2-f9901a3b9b1e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4be67889-1799-4492-9131-a77a57ed7453",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "278217cd-033d-43f8-98ce-78e715837ca7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-11T13:22:45.5304328+00:00",
"db_currency_id": "8419292c-de2a-439e-b9d8-13979237225b",
"db_currency_code": "sample string 10"
},
"company_type_id": "250084c7-1cc9-404a-90c9-f7af37500916",
"company_type_name": "sample string 32",
"company_type": {
"id": "49c3ca17-ca62-461d-8f70-b491fe1e1894",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "094bf605-7049-4178-a0aa-0db7120a34bd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8dc28cbd-13b7-4159-b57c-9fb0404a48cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "830a3e83-6ed4-476f-88cd-d996a2dead46",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e627568e-e26a-4c2a-b913-9760def2d248",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92e69f91-255f-45b3-88a7-978d497675e0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-11T13:22:45.5304328+00:00"
},
"company_sector_id": "bc8ee3a3-a2ad-4a7c-8d66-d20d028bd2ab",
"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": "fecadcaa-d1f7-418a-b482-035001c067ee",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "605b3cab-b172-40a5-99b7-7d9dce987201",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "636ad39d-d51c-4893-bcbb-b83e92be85fb",
"account_manager_user_code": "sample string 56",
"company_status_id": "893dbe8b-7b93-4335-b4b4-f9e2b108947c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-11T13:22:45.5304328+00:00",
"id2": 60
},
"db_language_id": "7bc7dcf6-55c6-4ee9-b542-76bbd5183a07",
"db_language_code": "sample string 7",
"db_title_id": "76d918bb-3596-4e7c-b026-d3407e9f2227",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-11T13:22:45.5304328+00:00",
"create_date": "2026-07-11T13:22:45.5304328+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-11T13:22:45.5304328+00:00"
}