Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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": "d7357db1-1ff2-4fb2-96f4-e0fa26a9c7a7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "68ad04a5-b4a7-4d58-acac-cb343d422335",
"company_code": "sample string 5",
"company": {
"id": "fe783689-2f10-429d-ac49-636cf044ffe8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T16:01:22.868666+00:00",
"sales_territory_id": "b736d311-7427-4975-ae35-d1b192e20b3b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1cbc5b19-62bf-46cd-8d71-c27cd5601825",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "13a877b2-d597-44f1-80a9-f1f1bbbff372",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "592ce82f-ec7f-4153-896d-ef846fef76a8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "91759285-c2e0-41af-8244-8f246bbca8ec",
"db_currency_id": "f95d34ca-2419-4f94-b2cc-4e51fd97b78c",
"db_language_id": "ca0a1b5a-137d-4f0b-bf01-8b8a4d038ab8",
"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": "2025-04-25T16:01:22.868666+00:00"
},
"modified_dateutc": "2025-04-25T16:01:22.868666+00:00"
},
"marketing_segment_id": "22b4ac6b-5eb9-404e-9595-5cc663949d80",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "47184d47-d535-4fbc-be11-8edf63358cd9",
"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": "7cea531c-957f-45d7-8554-286d2f6eb097",
"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": "c802bf5b-0b5b-43f6-b49d-b64cf18bcc2a",
"db_country_code": "sample string 28",
"feelist_id": "47e510f5-7ff3-48d2-add6-07b7d82a2fdc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a4dd9b28-42eb-431e-9393-d873436e3c7e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9fbd616e-17ec-4aa1-a9e9-66c53bf2084d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T16:01:22.868666+00:00",
"db_currency_id": "17519640-bd4b-4cb1-9f4e-3cfdfa563eb1",
"db_currency_code": "sample string 10"
},
"company_type_id": "e8c9b5ba-336f-46ec-8436-2c326cd98343",
"company_type_name": "sample string 32",
"company_type": {
"id": "c143d473-94ab-400f-886d-1e8a9678d789",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "efadeadf-8bc4-47c4-b0ef-bd45a99259e9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2007be53-fcba-4b20-8102-e4daa0b1dcf4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "60978d1f-c20e-4600-aefe-da7f436a268b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "df10f3ee-1ce7-48bf-8b19-f6972ac59f18",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b40e55db-baf5-4476-a4be-b87f36316e36",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T16:01:22.868666+00:00"
},
"company_sector_id": "88eb780f-2a38-411d-b8df-02be58a462b2",
"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": "b7e48cc8-98d4-4588-9b09-c09501e59d05",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "54d458ed-b18d-4779-9e70-e5f0d3d4a500",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c9a2ba4b-b487-4745-96e7-2e6082719054",
"account_manager_user_code": "sample string 56",
"company_status_id": "6c8c0f19-2977-460a-a40e-45ad3615e998",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T16:01:22.868666+00:00",
"id2": 60
},
"db_language_id": "1e95e006-dbdb-44c3-9744-b502066a4b2f",
"db_language_code": "sample string 7",
"db_title_id": "83d344e7-d871-47ff-b5da-2d62eaa30985",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T16:01:22.868666+00:00",
"create_date": "2025-04-25T16:01:22.868666+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": "2025-04-25T16:01:22.868666+00:00"
}