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": "eaff945d-d438-4139-8a32-ddc5c74c5760",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "51d191e4-2687-496e-ba93-24c5b1442484",
"company_code": "sample string 5",
"company": {
"id": "566e3019-f74c-4c29-8157-8336ec843f2a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-28T03:11:16.243875+00:00",
"sales_territory_id": "ee4f08e6-de14-4a43-b799-ad9edb1d80e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "89d94920-cf2f-4ebf-9c49-b309051e1860",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5e6758f9-8e2a-48eb-977f-ae5d2f0e4d31",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4baafb0d-82da-421c-bab8-73afa1085357",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d04cc260-1858-474d-a2d0-ca3435bad3ae",
"db_currency_id": "64d78a98-74bb-401f-9ecf-a7f507a8d956",
"db_language_id": "9291a855-fc72-4e59-8d17-f45db4a68f6d",
"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-01-28T03:11:16.243875+00:00"
},
"modified_dateutc": "2026-01-28T03:11:16.243875+00:00"
},
"marketing_segment_id": "d756e67e-b22b-4380-ad54-b9f6a76320dd",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d1e1ad4d-7dcd-4484-b5dd-9c00e7122b76",
"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": "696cda07-592a-4608-a4c5-051de2bbec14",
"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": "f7e61020-054f-4bf9-86e4-99f8ff828ac8",
"db_country_code": "sample string 28",
"feelist_id": "b5505300-8c8e-4b3d-94c9-677fd892c847",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4de853ab-785b-434b-9a48-3194ce8ef28e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "6a6f11bb-0a25-4547-872b-23584ce2db20",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-28T03:11:16.243875+00:00",
"db_currency_id": "cb232f59-37f7-43c2-9b4d-688fd8742a0e",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2bc1e09-3c6d-4cc1-a4e4-b0132b6608eb",
"company_type_name": "sample string 32",
"company_type": {
"id": "6c2c08f6-5d25-4705-a87d-6b5bd3701497",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf5eab76-0938-42a8-b4e6-07d7bfeeb740",
"sales_organization_code": "sample string 5"
},
"db_language_id": "59b9d588-2f3e-4e94-8c48-6ae7e9d08cff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1d3771e5-45d6-453e-be15-615aad70a4ce",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1a229484-712e-4f4b-8e1b-6f830ba11602",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5fe95a1f-baba-4931-b215-0d191178e328",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-28T03:11:16.243875+00:00"
},
"company_sector_id": "16473ef3-4f50-4366-8712-284ec06750a0",
"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": "aab56c5d-d92f-4179-8547-17bc86451a86",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f1c068d2-aa20-4361-9a7f-888500610542",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9da570b8-e4f1-4a84-88fb-b8aaabba1dd7",
"account_manager_user_code": "sample string 56",
"company_status_id": "ce5bf59f-1df4-4632-bde2-498dd16f0694",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-28T03:11:16.243875+00:00",
"id2": 60
},
"db_language_id": "dd2973da-7130-4427-b70f-e54e4744dad3",
"db_language_code": "sample string 7",
"db_title_id": "b198711b-7bd3-40bd-998c-7e355de4657f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-28T03:11:16.243875+00:00",
"create_date": "2026-01-28T03:11:16.243875+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-01-28T03:11:16.243875+00:00"
}