DKBSignDocs

API reference

GETRequires Bearer token

List company users

/api/v1/companies/{company}/users

Company-admin. {company} must match the caller’s company. Paginated user resources.

Path parameters

FieldTypeDescription
company
Required
stringPath parameter company.

Query parameters

FieldTypeDescription
page
integerPage number.
e.g. 1
per_page
integerPage size.
e.g. 25
search
stringFilter by name or email.
start_date
stringCreated-from date.
end_date
stringCreated-to date.
sort_by
stringSort column.
e.g. "created_at"
sort_order
stringasc or desc.
e.g. "desc"

Request body

This endpoint does not accept a request body.

Responses

StatusMeaning
200Paginated users
401Missing or invalid Bearer token.

Request

curl
curl -X GET 'https://api.dkbsigns.com/api/v1/companies/company/users?page=1&per_page=25&search=search&start_date=start_date&end_date=end_date&sort_by=created_at&sort_order=desc' \
  -H 'Authorization: Bearer $DKBSIGN_TOKEN'

Response 200

json
{
  "data": [
    {
      "id": 4,
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "user@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
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1
  }
}