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": "bc661d36-b488-4117-b1ff-e09158d5c086",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c12486c5-0bac-4eff-a733-f474443d786c",
"company_code": "sample string 5",
"company": {
"id": "dbf8a31c-781c-4321-bc1c-1c4cade53705",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T18:52:22.75362+00:00",
"sales_territory_id": "f544d700-9b2f-4c35-90ca-36fe5242f1a6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "10679f9c-bc7e-4caf-9b53-06dd9446c6a7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fbf3ac55-436b-4c9d-9ba6-952599dcfc7d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bae13583-c61a-47d3-9fc0-e8fc77a8b252",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5f6f35b-143a-4440-97fc-4acafbe236b4",
"db_currency_id": "12718c1b-4d7c-4f67-8891-dabcbb3e9bac",
"db_language_id": "75061212-12eb-42d4-86d3-10b13bafd3e1",
"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-09-21T18:52:22.75362+00:00"
},
"modified_dateutc": "2026-09-21T18:52:22.75362+00:00"
},
"marketing_segment_id": "1e24240e-6087-4099-8fc4-3ef5789a81cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a49a58f6-2b96-46a4-a27a-bea0dea7467a",
"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": "5c568c95-3494-41b6-a1ee-df2874660f67",
"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": "1c3a1850-e00e-4a37-9da5-48e3c3abbc31",
"db_country_code": "sample string 28",
"feelist_id": "75c39884-318a-4de1-9d2d-fa0fb3437a5a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49cea28e-1a0e-4929-878b-80e2979e68ea",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "63c951dd-525b-421d-828c-9ef2dcd18373",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T18:52:22.75362+00:00",
"db_currency_id": "7272b0f1-5447-4b49-b5be-60a6ab332d00",
"db_currency_code": "sample string 10"
},
"company_type_id": "7467475c-7f01-46e8-a117-e143d10e496f",
"company_type_name": "sample string 32",
"company_type": {
"id": "ed9f81b9-a577-4052-8683-7c0476689cc8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8ada8ec-96cf-4f81-ab28-69cd46a1768f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c6c446e6-f01b-4bd0-8ef9-63bb41dd3333",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a3eb628a-faa2-4dd8-b902-9354d8919c2c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "03122e09-e188-4b7d-97a6-f148adcef949",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7fa92fa1-84da-4812-8ece-247e4db13ade",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T18:52:22.75362+00:00"
},
"company_sector_id": "db559125-3574-4d20-81b4-b5a7fbc30ca1",
"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": "1367589a-16b2-4c3d-b554-602b6b111dc1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cc86278b-96ad-4dc7-a7b6-7aa3d92188af",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "483b9496-62d5-49d8-9c44-4dd9acfdac84",
"account_manager_user_code": "sample string 56",
"company_status_id": "d9324bd5-436d-4286-a7c0-41f0736dea2e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T18:52:22.75362+00:00",
"id2": 60
},
"db_language_id": "c912d2bf-8cc5-4c62-8523-a67e237f01ec",
"db_language_code": "sample string 7",
"db_title_id": "cfe20b5d-c1d6-4fab-99f1-b17107a348e7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T18:52:22.75362+00:00",
"create_date": "2026-09-21T18:52:22.75362+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-09-21T18:52:22.75362+00:00"
}