Contacts
A page number within the paginated result set.
The primary key of a company to filter on.
A comma separated list of company primary keys.
12345,9876
GET /api/v4/contacts/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Get successful
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"created": "2020-12-22T15:31:39.26167Z",
"company": {
"pk": 928,
"remote_id": "text",
"created": "2020-07-30T21:10:06.445510Z",
"updated": "2020-07-30T21:10:06.44551Z",
"deleted": true,
"invoicing_remote_id": "COMP_456",
"name": "Transport Bouvet",
"phone_number": "0601020304",
"email": "[email protected]",
"siren": "123456789",
"trade_number": "text",
"country": "FR",
"comments": "text",
"vat_number": "text",
"is_verified": true,
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"account_type": "text",
"logo": "text",
"subscription_access": {},
"settings": {},
"primary_address": {
"pk": "text",
"name": "Transport Bouvet",
"address": "3 rue des champs",
"city": "Nantes",
"postcode": "44000",
"country": "FR",
"latitude": -52.5561625,
"longitude": 92.896504,
"radius": 500,
"coords_validated": false,
"is_demo": true,
"is_carrier": true,
"is_shipper": true,
"is_origin": true,
"is_destination": true,
"created_by": 1,
"created": "2020-07-30T21:10:06.44551Z",
"instructions": "text",
"remote_id": "text"
},
"managers": [
{
"pk": 928,
"user": {
"email": "[email protected]",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
],
"has_loggable_managers": true
},
"first_name": "Adèle",
"last_name": "Bouvet",
"email": "[email protected]",
"phone_number": "+33600000000",
"fax_number": "text",
"remote_id": "CONTACT_123",
"is_manager": true,
"has_pending_invite": true,
"is_invitable": true,
"invitation_link": "text"
}
]
}
Add a contact to a specific company in the requester's address book.
The company can be identified either by its pk
or its remote_id
.
687cddac-dbd2-11ea-9024-0242ac130006
Date of creation on our server
2020-12-22T15:31:39.26167Z
The id of the contact in your system
CONTACT_123
POST /api/v4/contacts/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 597
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"created": "2020-12-22T15:31:39.26167Z",
"company": {
"pk": 23498,
"remote_id": "text",
"name": "Transport Bouvet",
"trade_number": "text",
"country": "FR",
"settings_contract_html": "text",
"settings_logo": "text",
"settings_stamp": "text",
"settings_print_mode": true,
"settings_special_agreements": "text",
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"vat_number": "text",
"is_verified": "text"
},
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone_number": "text",
"fax_number": "text",
"remote_id": "CONTACT_123"
}
Create successful
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"created": "2020-12-22T15:31:39.26167Z",
"company": {
"pk": 928,
"remote_id": "text",
"created": "2020-07-30T21:10:06.445510Z",
"updated": "2020-07-30T21:10:06.44551Z",
"deleted": true,
"invoicing_remote_id": "COMP_456",
"name": "Transport Bouvet",
"phone_number": "0601020304",
"email": "[email protected]",
"siren": "123456789",
"trade_number": "text",
"country": "FR",
"comments": "text",
"vat_number": "text",
"is_verified": true,
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"account_type": "text",
"logo": "text",
"subscription_access": {},
"settings": {},
"primary_address": {
"pk": "text",
"name": "Transport Bouvet",
"address": "3 rue des champs",
"city": "Nantes",
"postcode": "44000",
"country": "FR",
"latitude": -52.5561625,
"longitude": 92.896504,
"radius": 500,
"coords_validated": false,
"is_demo": true,
"is_carrier": true,
"is_shipper": true,
"is_origin": true,
"is_destination": true,
"created_by": 1,
"created": "2020-07-30T21:10:06.44551Z",
"instructions": "text",
"remote_id": "text"
},
"managers": [
{
"pk": 928,
"user": {
"email": "[email protected]",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
],
"has_loggable_managers": true
},
"first_name": "Adèle",
"last_name": "Bouvet",
"email": "[email protected]",
"phone_number": "+33600000000",
"fax_number": "text",
"remote_id": "CONTACT_123",
"is_manager": true,
"has_pending_invite": true,
"is_invitable": true,
"invitation_link": "text"
}
If you choose to identify an object with its remote_id
instead of its uid
then
-
replace the
uid
value with theremote_id
value in the URL -
specify
lookup_field=remote_id
in the query parameters
Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id
(see path parameters)
DELETE /api/v4/contacts/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Empty body
No content
If you choose to identify an object with its remote_id
instead of its uid
then
-
replace the
uid
value with theremote_id
value in the URL -
specify
lookup_field=remote_id
in the query parameters
Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id
(see path parameters)
GET /api/v4/contacts/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
Get successful
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"created": "2020-12-22T15:31:39.26167Z",
"company": {
"pk": 928,
"remote_id": "text",
"created": "2020-07-30T21:10:06.445510Z",
"updated": "2020-07-30T21:10:06.44551Z",
"deleted": true,
"invoicing_remote_id": "COMP_456",
"name": "Transport Bouvet",
"phone_number": "0601020304",
"email": "[email protected]",
"siren": "123456789",
"trade_number": "text",
"country": "FR",
"comments": "text",
"vat_number": "text",
"is_verified": true,
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"account_type": "text",
"logo": "text",
"subscription_access": {},
"settings": {},
"primary_address": {
"pk": "text",
"name": "Transport Bouvet",
"address": "3 rue des champs",
"city": "Nantes",
"postcode": "44000",
"country": "FR",
"latitude": -52.5561625,
"longitude": 92.896504,
"radius": 500,
"coords_validated": false,
"is_demo": true,
"is_carrier": true,
"is_shipper": true,
"is_origin": true,
"is_destination": true,
"created_by": 1,
"created": "2020-07-30T21:10:06.44551Z",
"instructions": "text",
"remote_id": "text"
},
"managers": [
{
"pk": 928,
"user": {
"email": "[email protected]",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
],
"has_loggable_managers": true
},
"first_name": "Adèle",
"last_name": "Bouvet",
"email": "[email protected]",
"phone_number": "+33600000000",
"fax_number": "text",
"remote_id": "CONTACT_123",
"is_manager": true,
"has_pending_invite": true,
"is_invitable": true,
"invitation_link": "text"
}
If you choose to identify an object with its remote_id
instead of its uid
then
-
replace the
uid
value with theremote_id
value in the URL -
specify
lookup_field=remote_id
in the query parameters
Used to specify what field is used in the URL to identify the object you're requesting, e.g. with the remote_id
(see path parameters)
PATCH /api/v4/contacts/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 487
{
"company": {
"pk": 23498,
"remote_id": "text",
"name": "Transport Bouvet",
"trade_number": "text",
"country": "FR",
"settings_contract_html": "text",
"settings_logo": "text",
"settings_stamp": "text",
"settings_print_mode": true,
"settings_special_agreements": "text",
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"vat_number": "text",
"is_verified": "text"
},
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone_number": "text",
"fax_number": "text"
}
Update successful
{
"uid": "687cddac-dbd2-11ea-9024-0242ac130006",
"created": "2020-12-22T15:31:39.26167Z",
"company": {
"pk": 928,
"remote_id": "text",
"created": "2020-07-30T21:10:06.445510Z",
"updated": "2020-07-30T21:10:06.44551Z",
"deleted": true,
"invoicing_remote_id": "COMP_456",
"name": "Transport Bouvet",
"phone_number": "0601020304",
"email": "[email protected]",
"siren": "123456789",
"trade_number": "text",
"country": "FR",
"comments": "text",
"vat_number": "text",
"is_verified": true,
"settings_transport_order_observations": "text",
"settings_constrain_reference_edition": true,
"account_type": "text",
"logo": "text",
"subscription_access": {},
"settings": {},
"primary_address": {
"pk": "text",
"name": "Transport Bouvet",
"address": "3 rue des champs",
"city": "Nantes",
"postcode": "44000",
"country": "FR",
"latitude": -52.5561625,
"longitude": 92.896504,
"radius": 500,
"coords_validated": false,
"is_demo": true,
"is_carrier": true,
"is_shipper": true,
"is_origin": true,
"is_destination": true,
"created_by": 1,
"created": "2020-07-30T21:10:06.44551Z",
"instructions": "text",
"remote_id": "text"
},
"managers": [
{
"pk": 928,
"user": {
"email": "[email protected]",
"first_name": "Adèle",
"last_name": "Bouvet"
},
"display_name": "text",
"role": "text"
}
],
"has_loggable_managers": true
},
"first_name": "Adèle",
"last_name": "Bouvet",
"email": "[email protected]",
"phone_number": "+33600000000",
"fax_number": "text",
"remote_id": "CONTACT_123",
"is_manager": true,
"has_pending_invite": true,
"is_invitable": true,
"invitation_link": "text"
}
Last updated
Was this helpful?