Users

Search users

Searches for users with optional filtering by login name

get/api/users

Query parameters

loginstring required
pagenumber double required

Response

Paginated list of user accounts

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "id": "entity123",
      "createdBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "updatedBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "createdAt": "2023-10-31T12:34:56.789Z",
      "updatedAt": "2023-10-31T12:34:56.789Z",
      "login": "john.doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "language": "en",
      "timezone": "Europe/Paris",
      "friendlyName": "John Doe"
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}

Changes

Changed in 8 of the 73 revisions of this API.121224

  • cdb5b7ea719924See the full diff
    • removed the optional property content/items/creationDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/lastEditInstant from the response with the 200 status

      response-optional-property-removed

    • added the required property content/items/createdAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/createdBy to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedBy to the response with the 200 status

      response-required-property-added

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

  • 108013c9462942See the full diff
    • removed the required property content/items/createdAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/createdBy from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedBy from the response with the 200 status

      response-required-property-removed

    • added the optional property content/items/creationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/lastEditInstant to the response with the 200 status

      response-optional-property-added

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

  • fb56929c067524See the full diff
    • removed the optional property content/items/creationDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/lastEditInstant from the response with the 200 status

      response-optional-property-removed

    • added the required property content/items/createdAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/createdBy to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedBy to the response with the 200 status

      response-required-property-added

  • d6e364e3cd4e42See the full diff
    • removed the required property content/items/createdAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/createdBy from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedBy from the response with the 200 status

      response-required-property-removed

    • added the optional property content/items/creationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/lastEditInstant to the response with the 200 status

      response-optional-property-added

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

  • 3bf1b221f6ef24See the full diff
    • removed the optional property content/items/creationDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/lastEditInstant from the response with the 200 status

      response-optional-property-removed

    • added the required property content/items/createdAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/createdBy to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedAt to the response with the 200 status

      response-required-property-added

    • added the required property content/items/updatedBy to the response with the 200 status

      response-required-property-added

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

  • 88f262299d5e42See the full diff
    • removed the optional property content/items/createdAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/createdBy from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/updatedAt from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/updatedBy from the response with the 200 status

      response-optional-property-removed

    • added the optional property content/items/creationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/lastEditInstant to the response with the 200 status

      response-optional-property-added

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

  • 76d90b88c3e524See the full diff
    • removed the optional property content/items/creationDate from the response with the 200 status

      response-optional-property-removed

    • removed the optional property content/items/lastEditInstant from the response with the 200 status

      response-optional-property-removed

    • added the optional property content/items/createdAt to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/createdBy to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/updatedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/updatedBy to the response with the 200 status

      response-optional-property-added

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

    • removed the required property content/items/createdAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/createdBy from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedAt from the response with the 200 status

      response-required-property-removed

    • removed the required property content/items/updatedBy from the response with the 200 status

      response-required-property-removed

    • added the optional property content/items/creationDate to the response with the 200 status

      response-optional-property-added

    • added the optional property content/items/lastEditInstant to the response with the 200 status

      response-optional-property-added

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