Contacts

List all contacts

GEThttps://api.dashdoc.eu/api/v4/contacts/
Query parameters
Response

Get successful

Body
countinteger
Example: 1
nextnullable string
previousnullable string
resultsarray of Contact (object)
Request
const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "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": false,
        "invoicing_remote_id": "COMP_456",
        "name": "Transport Bouvet",
        "phone_number": "0601020304",
        "email": "i.love.dashdoc@gmail.com",
        "siren": "123456789",
        "trade_number": "text",
        "country": "FR",
        "comments": "text",
        "vat_number": "text",
        "is_verified": false,
        "settings_transport_order_observations": "text",
        "settings_constrain_reference_edition": false,
        "account_type": "text",
        "logo": "text",
        "primary_address": {
          "pk": "text",
          "name": "Transport Bouvet",
          "address": "3 rue des champs",
          "city": "Nantes",
          "postcode": "44000",
          "country": "FR",
          "latitude": -52.5561625,
          "longitude": 92.896504,
          "coords_validated": false,
          "is_demo": false,
          "is_carrier": false,
          "is_shipper": false,
          "is_origin": false,
          "is_destination": false,
          "created_by": 0,
          "created": "2020-07-30T21:10:06.44551Z",
          "instructions": "text",
          "remote_id": "text"
        },
        "managers": [
          {
            "pk": 928,
            "user": {
              "email": "adele.bouvet@gmail.com",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": false
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": false,
      "has_pending_invite": false,
      "is_invitable": false,
      "invitation_link": "text"
    }
  ]
}

Create a contact

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.

POSThttps://api.dashdoc.eu/api/v4/contacts/
Body
uidstring (uuid)
Example: "687cddac-dbd2-11ea-9024-0242ac130006"
createdcreated (string (date-time))

Date of creation on our server

Example: "2020-12-22T15:31:39.26167Z"
company*CompanyIdentification (object)

Identification of the company. The company must already exist in Dashdoc.

first_namestring
last_name*string
emailstring (email)
phone_numberstring
fax_numberstring
remote_idstring

The id of the contact in your system

Example: "CONTACT_123"
Response

Create successful

Body
uidstring (uuid)
Example: "687cddac-dbd2-11ea-9024-0242ac130006"
createdcreated (string (date-time))

Date of creation on our server

Example: "2020-12-22T15:31:39.26167Z"
companyCompany (object)
first_namestring
Example: "Adèle"
last_namestring
Example: "Bouvet"
emailstring (email)
Example: "adele.bouvet@gmail.com"
phone_numberstring
Example: "+33600000000"
fax_numberstring
remote_idstring

The id of the contact in your system

Example: "CONTACT_123"
is_managerboolean

Ignore. Dashdoc technical data.

has_pending_inviteboolean

Ignore. Dashdoc technical data.

is_invitableboolean

Ignore. Dashdoc technical data.

invitation_linknullable string (url)
Request
const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "company": {},
      "last_name": "text"
    }),
});
const data = await response.json();
Response
{
  "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": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "i.love.dashdoc@gmail.com",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "adele.bouvet@gmail.com",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": false,
  "has_pending_invite": false,
  "is_invitable": false,
  "invitation_link": "text"
}

Delete a contact

DELETEhttps://api.dashdoc.eu/api/v4/contacts/{uid}/
Path parameters
uid*string
remote_idstring

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
Response

Empty body

Request
const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/{uid}/', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Read a contact

GEThttps://api.dashdoc.eu/api/v4/contacts/{uid}/
Path parameters
uid*string
remote_idstring

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
Response

Get successful

Body
uidstring (uuid)
Example: "687cddac-dbd2-11ea-9024-0242ac130006"
createdcreated (string (date-time))

Date of creation on our server

Example: "2020-12-22T15:31:39.26167Z"
companyCompany (object)
first_namestring
Example: "Adèle"
last_namestring
Example: "Bouvet"
emailstring (email)
Example: "adele.bouvet@gmail.com"
phone_numberstring
Example: "+33600000000"
fax_numberstring
remote_idstring

The id of the contact in your system

Example: "CONTACT_123"
is_managerboolean

Ignore. Dashdoc technical data.

has_pending_inviteboolean

Ignore. Dashdoc technical data.

is_invitableboolean

Ignore. Dashdoc technical data.

invitation_linknullable string (url)
Request
const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/{uid}/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "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": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "i.love.dashdoc@gmail.com",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "adele.bouvet@gmail.com",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": false,
  "has_pending_invite": false,
  "is_invitable": false,
  "invitation_link": "text"
}

Partially update a contact

PATCHhttps://api.dashdoc.eu/api/v4/contacts/{uid}/
Path parameters
uid*string
remote_idstring

If you choose to identify an object with its remote_id instead of its uid then

  • replace the uid value with the remote_id value in the URL

  • specify lookup_field=remote_id in the query parameters

Query parameters
Body
companyCompanyIdentification (object)

Identification of the company. The company must already exist in Dashdoc.

first_namestring
last_namestring
emailstring (email)
phone_numberstring
fax_numberstring
Response

Update successful

Body
uidstring (uuid)
Example: "687cddac-dbd2-11ea-9024-0242ac130006"
createdcreated (string (date-time))

Date of creation on our server

Example: "2020-12-22T15:31:39.26167Z"
companyCompany (object)
first_namestring
Example: "Adèle"
last_namestring
Example: "Bouvet"
emailstring (email)
Example: "adele.bouvet@gmail.com"
phone_numberstring
Example: "+33600000000"
fax_numberstring
remote_idstring

The id of the contact in your system

Example: "CONTACT_123"
is_managerboolean

Ignore. Dashdoc technical data.

has_pending_inviteboolean

Ignore. Dashdoc technical data.

is_invitableboolean

Ignore. Dashdoc technical data.

invitation_linknullable string (url)
Request
const response = await fetch('https://api.dashdoc.eu/api/v4/contacts/{uid}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "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": false,
    "invoicing_remote_id": "COMP_456",
    "name": "Transport Bouvet",
    "phone_number": "0601020304",
    "email": "i.love.dashdoc@gmail.com",
    "siren": "123456789",
    "trade_number": "text",
    "country": "FR",
    "comments": "text",
    "vat_number": "text",
    "is_verified": false,
    "settings_transport_order_observations": "text",
    "settings_constrain_reference_edition": false,
    "account_type": "text",
    "logo": "text",
    "primary_address": {
      "pk": "text",
      "name": "Transport Bouvet",
      "address": "3 rue des champs",
      "city": "Nantes",
      "postcode": "44000",
      "country": "FR",
      "latitude": -52.5561625,
      "longitude": 92.896504,
      "coords_validated": false,
      "is_demo": false,
      "is_carrier": false,
      "is_shipper": false,
      "is_origin": false,
      "is_destination": false,
      "created_by": 0,
      "created": "2020-07-30T21:10:06.44551Z",
      "instructions": "text",
      "remote_id": "text"
    },
    "managers": [
      {
        "pk": 928,
        "user": {
          "email": "adele.bouvet@gmail.com",
          "first_name": "Adèle",
          "last_name": "Bouvet"
        },
        "display_name": "text",
        "role": "text"
      }
    ],
    "has_loggable_managers": false
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": false,
  "has_pending_invite": false,
  "is_invitable": false,
  "invitation_link": "text"
}
PreviousCompaniesNextInvite

Last updated