GETRequires Bearer token

List colleagues

/api/v1/colleagues

Other users in the caller’s company. No pagination. Empty list if the caller has no company.

Path parameters

This endpoint has no path parameters.

Query parameters

Field	Type	Description
search	string	Filter by name or email. e.g. "ada"
sort_by	string	`first_name`, `email`, or `created_at`. e.g. "first_name"
sort_order	string	`asc` or `desc`. e.g. "asc"

Request body

This endpoint does not accept a request body.

Responses

Status	Meaning
200	Company colleagues
401	Missing or invalid Bearer token.

Request

curl

curl -X GET 'https://api.dkbsigns.com/api/v1/colleagues?search=ada&sort_by=first_name&sort_order=asc' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN'

Response 200

json

{
  "data": [
    {
      "id": 12,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "ada@acme.test",
      "role": "user",
      "company_id": 1,
      "job_title": "Chief Financial Officer",
      "locale": "fr",
      "seal": null,
      "signature_mentions": {
        "enabled": true,
        "frame": false,
        "mentions": [
          "fullName",
          "jobTitle"
        ]
      },
      "is_available": true
    }
  ]
}