Users and organisationList users

List users

Lists every user of the account, ordered by first name, one page at a time.

There is no filter, search or sort parameter: filter on IsActive and UserType on your side. The model carries only identifiers, name, initials, e-mail, active flag, user type and legal entity.

Use it to:

  • Initial sync of users into an HR, payroll or BI system
  • Map initials or e-mail to the UserID needed by time registrations

Not for:

  • The caller's own user → GET /v1/user/me

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.
  • Reads the user tables directly.

Next: GET /v1/user/{id}, PUT /v1/user

See also: GET /v1/user/me, GET /v1/legal-entity

curl -X GET "https://app3.timelog.com/your-account/api/v1/user?$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "UserID": 123,
        "ID": "123e4567-e89b-12d3-a456-426614174000",
        "FirstName": "John Doe",
        "LastName": "John Doe",
        "Initials": "example_string",
        "IsActive": true,
        "UserType": "Employee",
        "LegalEntityID": 123,
        "Email": "user@example.com"
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/user
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum enforced in the API layer.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum enforced in the API layer.

Responses

Propertiesobject

Paging values. They are returned as STRINGS, for example "TotalRecord": "12".

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray