BackAPI reference

Users

Read-only. You can list the people on your account and fetch one by id. Creating, changing and removing users is done in the app, not through the API.

The usual reason to call this is attribution: take a user's id or email and pass it when writing a KPI entry, so the value is recorded against that person.

Base URL https://api.simplekpi.com/v1

Endpoints

List users — GET /v1/users
Get a user — GET /v1/users/{id}

User object

Name	Type	Read Only	Mandatory	Notes
`id`	integer	yes	no	Identifies the user. Send it as user_id when writing a KPI entry against this person.
`user_type`	string	yes	no	The role the user holds on the account. `Owner` Full control, including billing, `Admin` Full control of the account, `Manager` Manages KPIs and other people, `User` Enters and views their own data.
`user_status_id`	string	yes	no	Whether the user can sign in. Case sensitive. `A` Active, `L` Locked.
`first_name`	string	yes	no	The user's first name.
`last_name`	string	yes	no	Nullable. The user's last name.
`email`	string	yes	no	Nullable. The address the user signs in with. Can be sent instead of user_id when writing a KPI entry.
`created_at`	datetime	yes	no
`updated_at`	datetime	yes	no

List users

GET /v1/users

Read-only. People are added and changed in the app, not through the API.

Requires users:read on the API key.

Parameters

Name	Type	Required	Default	Notes
`page`	integer	no	1	Which page to return, counting from 1.
`rows`	integer	no	500	How many rows per page. Defaults to 500.

Using curl

curl https://api.simplekpi.com/v1/users \
  -H "Authorization: Bearer skpi_your_api_key"

Example response

Status: 200 OK
[
  {
    "id": 42,
    "user_type": "Manager",
    "user_status_id": "A",
    "first_name": "Alex",
    "last_name": "Okafor",
    "email": "alex@example.com",
    "created_at": "2026-01-14T09:00:00",
    "updated_at": "2026-05-02T11:00:00"
  }
]

Status codes

Code	Meaning
`200`	OK
`400`	Bad Request
`401`	Unauthorized
`403`	Forbidden
`429`	Too Many Requests

Get a user

GET /v1/users/{id}

Requires users:read on the API key.

Parameters

Name	Type	Required	Default	Notes
`id`	integer	yes		The user to return.

Using curl

curl https://api.simplekpi.com/v1/users/{id} \
  -H "Authorization: Bearer skpi_your_api_key"

Status codes

Code	Meaning
`200`	OK
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`429`	Too Many Requests

Users

Endpoints

User object

List users

Parameters

Using curl

Example response

Status codes

Get a user

Parameters

Using curl

Status codes

We value your privacy