Contacts

List all contacts

GEThttps://api.dashdoc.eu/api/v4/contacts/

Query parameters

Response

200

Get successful

Body

application/json

countinteger

Example: 1

nextnullable string

previousnullable string

resultsarray of Contact (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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": "[e-mail]",
        "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,
          "radius": 500,
          "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": "[e-mail]",
              "first_name": "Adèle",
              "last_name": "Bouvet"
            },
            "display_name": "text",
            "role": "text"
          }
        ],
        "has_loggable_managers": false
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "[e-mail]",
      "phone_number": "[phone]",
      "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

204

Empty body

Request

JavaScriptCurlPython

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