Skip to content
Help Center
Products

API Reference

GET /api/v1/public/users

Return users

Returns active users in the account, ordered by name. KnowledgeCity support accounts are always excluded. Takes no parameters.

operationId Return users

Responses

200 Every active user, ordered by name, with KnowledgeCity support accounts removed.

Response headers

NameTypeDescription
X-RateLimit-Limit integer Your hourly allowance.
X-RateLimit-Remaining integer Requests left in the current window.
X-RateLimit-Reset integer When the window resets, as an absolute Unix epoch time in seconds — not a countdown.

application/json body

Field Type Required Description
error boolean required Always `false` on a successful response. Authentication and rate-limit failures instead return a string error code in this field.
data array required The full, unpaginated list.
id string (uuid) required User identifier.
name string required Full name.
email string (email) required Email address.
role string required Role in KC Safety.
department string optional Department name.
job_title string optional Job title.
created_at string (date-time) required When the user was created.

Example

{
  "error": false,
  "data": [
    {
      "id": "41de…",
      "name": "Dana Reyes",
      "email": "dana@example.com",
      "role": "manager",
      "department": "Operations",
      "job_title": "Shift Lead",
      "created_at": "2026-02-02T11:30:00.000Z"
    }
  ]
}

401 `API_KEY_REQUIRED` — the `Authorization: Bearer kcs_…` header is missing or malformed. `API_KEY_INVALID` — the key is unknown, revoked, or expired.

403 `INSUFFICIENT_SCOPE` — the key's scope does not permit this method. `FEATURE_NOT_AVAILABLE` — the account's plan does not include API access.

429 `RATE_LIMIT_EXCEEDED` — the hourly limit was reached. Read `Retry-After` (seconds); `X-RateLimit-Reset` is not set on a 429.

Response headers

NameTypeDescription
Retry-After integer Seconds to wait before retrying.

500 Unexpected server error.