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": "4ad11909-33ae-424a-9eb9-5dbfd50fe8a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b269e29c-d44e-4256-b12e-cbd5c5f81af4",
"company_code": "sample string 5",
"company": {
"id": "8adfeee5-001c-492e-910d-7d2fa29eb4d7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-28T20:49:30.8084179+00:00",
"sales_territory_id": "a8127aac-285c-4291-a71d-8226ab852daf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bada9cd3-7619-4e20-9c19-c631621bb4aa",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1c9e506e-9ea4-4ed0-80c7-6281d0c33afe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc6e11c6-b4ea-45a8-847b-caf9b0b3d19f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3aa4f93-a06b-44ab-934c-69e1f1a17cb9",
"db_currency_id": "7934c64b-53ec-47a3-a23b-ce2c4520f488",
"db_language_id": "7c4b48fa-d5e3-41e2-be8d-2aff82c7641d",
"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-05-28T20:49:30.8084179+00:00"
},
"modified_dateutc": "2026-05-28T20:49:30.8084179+00:00"
},
"marketing_segment_id": "46583dca-540d-48ad-affd-add938b4664c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4f9902c3-b469-4499-9e5b-c8b71cc92655",
"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": "ee967c5e-d603-43c5-974b-f87ddb9c07ff",
"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": "54a1e1a6-09cc-42bd-b185-93316e8723cb",
"db_country_code": "sample string 28",
"feelist_id": "7ebf1599-b681-42eb-82b5-d16e2fd908af",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fb4551b1-590e-4a1f-8de3-4906da252a3e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ca0f7511-d7fc-478a-ad3b-68e431618440",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-28T20:49:30.8084179+00:00",
"db_currency_id": "b5bd80ed-1491-4ae8-8932-cdd823d0fdd4",
"db_currency_code": "sample string 10"
},
"company_type_id": "01a0e34a-955e-47bf-b75f-a92eb719252e",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c238e1f-80d4-44d7-8a94-3b3786288306",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f1a14f0-8bac-43ab-92ec-abe4a865d91d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "adec6838-3744-4a1d-9f06-dd556e5ff07a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0e5884ad-d46d-4a83-aa70-110717c5a21d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "99aa2361-4414-4dd3-907e-8186717b2db3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c021a61e-f264-4bc5-865d-bc695a474c9e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-28T20:49:30.8084179+00:00"
},
"company_sector_id": "7e5a88be-e55b-453e-b8a0-b51881878fa3",
"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": "d1e467f9-f915-42ea-905d-1e8e7435398d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b6dcddef-4a0b-4ac0-892a-01598b67a8b1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e1cf7de-34cf-4a0f-9d32-bd121fdbc15a",
"account_manager_user_code": "sample string 56",
"company_status_id": "bbb350da-895e-4bfd-9efb-344089f09e71",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-28T20:49:30.8084179+00:00",
"id2": 60
},
"db_language_id": "1bdc3772-6b5b-4d52-9f94-3ee96705a8a5",
"db_language_code": "sample string 7",
"db_title_id": "66ffc60d-8aeb-4ea1-bdbd-17da58f0ba0a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-28T20:49:30.8084179+00:00",
"create_date": "2026-05-28T20:49:30.8084179+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-05-28T20:49:30.8084179+00:00"
}