Sign in
Users

Listing all Users

Currently, there are no paging or filtering options, so listing Users will get you every User in the system, every time.

Optionally, a q querystring parameter may be provided to filter the returned users by any given string. The search is performed via a trigram similarity index over both the Email and Display Name fields, and results are ordered by match score, best matches first. Note that short search terms (less than 4 or 5 characters) may not return any results. Try a longer search if nothing is appearing.

If a q parameter is given, and it exactly matches an email address that exists in the system, that user's details will always be returned, even for actors who cannot user.list. The request must still authenticate as a valid Actor. This allows non-Administrators to choose a user for an action (eg grant rights) without allowing full search.

Actors who cannot user.list will always receive [] with a 200 OK response.

get/v1/users

Query parameters

qstring

An optional search parameter.

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

The type of actor

updatedAtstring

ISO date format

deletedAtstring

ISO date format

emailstring

The email address of the user

lastLoginAtstring date-time nullable

The timestamp of when the user last logged in. Will be null if the user has never logged in.

Example response

[
  {
    "createdAt": "2018-04-18T23:19:14.802Z",
    "displayName": "My Display Name",
    "id": 115,
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z",
    "lastLoginAt": "2025-01-15T10:30:00.000Z"
  }
]

Changes

Changed in 4 of the 54 revisions of this API.15

  • 022694254f0d1See the full diff
    • ○

      api operation id Listing all Users removed and replaced with listAllUsers

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • 17bb5681fead1See the full diff
    • ○

      added the optional property items/allOf[subschema #2]/lastLoginAt to the response with the 200 status

      response-optional-property-added

  • e8c2858fd4eb12See the full diff
    • ●

      removed the optional property items/allOf[subschema #2]/lastLoginAt from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id listAllUsers removed and replaced with Listing all Users

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog