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": "2a2392ed-314d-464c-8a1a-7e473af4f2a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80deae1f-7074-4096-8eff-a7ef227db7da",
"company_code": "sample string 5",
"company": {
"id": "e361afad-f225-427c-8fb7-cf1fbc405d9c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-02T10:33:07.6034707+00:00",
"sales_territory_id": "e12445a7-dd93-4e1c-b0b1-3f230aa35128",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e6ec2817-6a02-45da-8908-a5bf6430d9ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "09f600cf-cf9f-49c0-9b46-0b8ff08e40f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "70b3c02e-4a32-48a7-860c-b47d70d72731",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b40abe03-c965-46fa-b7fe-9fd1a58322b4",
"db_currency_id": "a3dd8d48-69ba-4392-a9a3-f560d86b9e13",
"db_language_id": "2a9cb187-8c7b-456d-86d8-bbfecf7e652c",
"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-02T10:33:07.6034707+00:00"
},
"modified_dateutc": "2026-07-02T10:33:07.6034707+00:00"
},
"marketing_segment_id": "239fab08-8e54-4c20-b99a-4db942a438a8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "86d78874-6450-4848-97c4-a55975508c85",
"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": "76cae3ef-f4f9-4c0c-93b7-9d6de7c0ef48",
"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": "1829f642-3123-494a-bc36-8806e150b43a",
"db_country_code": "sample string 28",
"feelist_id": "22527fff-a902-41e3-9a5a-21a5af975e0f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "81b30968-ed84-4eb7-bd72-7ea5ebc98753",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74503f1b-024d-4271-bedf-a57bd0cafdbf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-02T10:33:07.6034707+00:00",
"db_currency_id": "6b07f88a-d105-403f-8c1a-b69c61886e23",
"db_currency_code": "sample string 10"
},
"company_type_id": "e199f831-25ea-4eb4-85b5-4797a817481a",
"company_type_name": "sample string 32",
"company_type": {
"id": "243aac9f-cb84-4371-b4ae-97dc882b65d9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e571f330-7403-491b-8ecd-5f4cc8d0f00e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b73ae1cd-c6fe-469e-87a7-5f4ce2567a97",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6107097a-d56e-4d8d-a164-acc46a342dab",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c7013663-0d59-44b4-a3e5-41ef3db58c7e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a57f7f0-ee3e-4b55-b9c6-771fdb55d2ae",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-02T10:33:07.6034707+00:00"
},
"company_sector_id": "79098e9d-142b-40df-b797-533fa6a9dcc1",
"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": "525d2cd6-9079-4bad-999f-0874d8dd3a53",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "49aa2422-4817-43c3-9c36-6001c97c6254",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9380add0-5e3d-438d-9cd2-e42f88901a3e",
"account_manager_user_code": "sample string 56",
"company_status_id": "191e82e3-6cc6-46a1-bcd8-23703b972921",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-02T10:33:07.6034707+00:00",
"id2": 60
},
"db_language_id": "4656afb6-b963-46f9-8ef7-839af8ca9a3b",
"db_language_code": "sample string 7",
"db_title_id": "33bc0360-a9e2-437e-99ea-50a451735ef2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-02T10:33:07.6034707+00:00",
"create_date": "2026-07-02T10:33:07.6034707+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-02T10:33:07.6034707+00:00"
}