Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contacts

List all contacts

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Query parameters
pageintegerOptional

A page number within the paginated result set.

company__idintegerOptional

The primary key of a company to filter on.

company__id__instringOptional

A comma separated list of company primary keys.

Example: 12345,9876
Responses
200

Get successful

application/json
countintegerOptionalExample: 1
nextstring · nullableOptional
previousstring · nullableOptional
get/contacts/
GET /api/v4/contacts/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

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": "i.love.dashdoc@gmail.com",
        "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": 23498,
          "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": {
            "pk": 25,
            "name": "Transport Bouvet"
          },
          "created_by_user": {
            "pk": 34,
            "display_name": "Jean Pierre Bouvet",
            "company": 25,
            "trucker_id": 95
          },
          "created": "2020-12-22T15:31:39.26167Z",
          "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": true
      },
      "first_name": "Adèle",
      "last_name": "Bouvet",
      "email": "adele.bouvet@gmail.com",
      "phone_number": "+33600000000",
      "fax_number": "text",
      "remote_id": "CONTACT_123",
      "is_manager": true,
      "has_pending_invite": true,
      "is_invitable": true,
      "invitation_link": "text"
    }
  ]
}

Create a contact

post

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.

Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Body
uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
first_namestring · max: 200Optional
last_namestring · max: 200Required
emailstring · emailOptional
phone_numberstring · max: 100Optional
fax_numberstring · max: 100Optional
remote_idstringOptional

The id of the contact in your system

Example: CONTACT_123
Responses
201

Create successful

application/json
uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
first_namestringOptionalExample: Adèle
last_namestringOptionalExample: Bouvet
emailstring · emailOptionalExample: adele.bouvet@gmail.com
phone_numberstringOptionalExample: +33600000000
fax_numberstringOptional
remote_idstringOptional

The id of the contact in your system

Example: CONTACT_123
is_managerbooleanOptional

Ignore. Dashdoc technical data.

has_pending_invitebooleanOptional

Ignore. Dashdoc technical data.

is_invitablebooleanOptional

Ignore. Dashdoc technical data.

invitation_linkstring · url · nullableOptional
post/contacts/
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": "name@gmail.com",
  "phone_number": "text",
  "fax_number": "text",
  "remote_id": "CONTACT_123"
}
201

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": "i.love.dashdoc@gmail.com",
    "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": 23498,
      "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": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "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": true
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": true,
  "has_pending_invite": true,
  "is_invitable": true,
  "invitation_link": "text"
}

Delete a contact

delete
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired
remote_idstringOptional

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
lookup_fieldstringOptional

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)

Responses
204

Empty body

No content
delete/contacts/{uid}/
DELETE /api/v4/contacts/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
204

Empty body

No content

Read a contact

get
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired
remote_idstringOptional

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
lookup_fieldstringOptional

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)

Responses
200

Get successful

application/json
uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
first_namestringOptionalExample: Adèle
last_namestringOptionalExample: Bouvet
emailstring · emailOptionalExample: adele.bouvet@gmail.com
phone_numberstringOptionalExample: +33600000000
fax_numberstringOptional
remote_idstringOptional

The id of the contact in your system

Example: CONTACT_123
is_managerbooleanOptional

Ignore. Dashdoc technical data.

has_pending_invitebooleanOptional

Ignore. Dashdoc technical data.

is_invitablebooleanOptional

Ignore. Dashdoc technical data.

invitation_linkstring · url · nullableOptional
get/contacts/{uid}/
GET /api/v4/contacts/{uid}/ HTTP/1.1
Host: api.dashdoc.eu
Authentication: YOUR_API_KEY
Accept: */*
200

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": "i.love.dashdoc@gmail.com",
    "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": 23498,
      "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": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "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": true
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": true,
  "has_pending_invite": true,
  "is_invitable": true,
  "invitation_link": "text"
}

Partially update a contact

patch
Authorizations
AuthenticationstringRequired

Authentication is token based. You can issue a token for your API request from the 'API' section of the settings menu. The token MUST be sent in a Authorization header with each request.

Example of authenticated request

$ curl -X GET -H "Authorization: Token <your token>" "https://api.dashdoc.eu/api/v4/"
Path parameters
uidstringRequired
remote_idstringOptional

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
lookup_fieldstringOptional

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)

Body
first_namestring · max: 200Optional
last_namestring · max: 200Optional
emailstring · emailOptional
phone_numberstring · max: 100Optional
fax_numberstring · max: 100Optional
Responses
200

Update successful

application/json
uidstring · uuidOptionalExample: 687cddac-dbd2-11ea-9024-0242ac130006
createdstring · date-timeOptional

Date of creation on our server

Example: 2020-12-22T15:31:39.26167Z
first_namestringOptionalExample: Adèle
last_namestringOptionalExample: Bouvet
emailstring · emailOptionalExample: adele.bouvet@gmail.com
phone_numberstringOptionalExample: +33600000000
fax_numberstringOptional
remote_idstringOptional

The id of the contact in your system

Example: CONTACT_123
is_managerbooleanOptional

Ignore. Dashdoc technical data.

has_pending_invitebooleanOptional

Ignore. Dashdoc technical data.

is_invitablebooleanOptional

Ignore. Dashdoc technical data.

invitation_linkstring · url · nullableOptional
patch/contacts/{uid}/
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": "name@gmail.com",
  "phone_number": "text",
  "fax_number": "text"
}
200

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": "i.love.dashdoc@gmail.com",
    "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": 23498,
      "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": {
        "pk": 25,
        "name": "Transport Bouvet"
      },
      "created_by_user": {
        "pk": 34,
        "display_name": "Jean Pierre Bouvet",
        "company": 25,
        "trucker_id": 95
      },
      "created": "2020-12-22T15:31:39.26167Z",
      "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": true
  },
  "first_name": "Adèle",
  "last_name": "Bouvet",
  "email": "adele.bouvet@gmail.com",
  "phone_number": "+33600000000",
  "fax_number": "text",
  "remote_id": "CONTACT_123",
  "is_manager": true,
  "has_pending_invite": true,
  "is_invitable": true,
  "invitation_link": "text"
}
PreviousCompanies
NextInvite

Last updated

Was this helpful?