Skip to main content

GetUsersResponse

users object[]nullable

Array of users

  • Array [
  • idstringrequired

    User ID

    Possible values: non-empty

    Example: 8fkjh5
    namestringrequired

    User name

    Possible values: non-empty

    Example: User-123
    registrationdate-timerequired

    Registration date

    Example: 2021-12-01T10:01:11.123
    lastTransferdate-timenullable

    Last transfer date

    Example: 2021-12-01T10:01:11.123
    lastExportdate-timenullable

    Last export date

    Example: 2021-12-01T10:01:11.123
    deletedAtdate-timenullable

    User deletion date

    Example: 2023-11-21T10:01:11.123
    isDeletedboolean

    If true, the user is deleted

    Example: false
    isActiveboolean

    If true, the user is active

    Example: false
    emailstringnullable

    User Email

    Example: partner@example.de
  • ]
  • pagination objectnullable

    Pagination info

    pageNumberint32

    Returned page number

    Example: 1
    previousPageReferencestringnullable

    Reference to get the previous page

    nextPageReferencestringnullable

    Reference to get the next page

    previousPageurinullable

    URL of the previous page

    nextPageurinullable

    URL of the next page

    pageSizeint32

    Number of items per page

    Example: 25
    pagesCountint32nullable

    Total number of pages

    Example: 5
    totalCountint32

    Total number of items

    Example: 125
    GetUsersResponse
    {
    "users": [
    {
    "id": "8fkjh5",
    "name": "User-123",
    "registration": "2021-12-01T10:01:11.123",
    "lastTransfer": "2021-12-01T10:01:11.123",
    "lastExport": "2021-12-01T10:01:11.123",
    "deletedAt": "2023-11-21T10:01:11.123",
    "isDeleted": false,
    "isActive": false,
    "email": "partner@example.de"
    }
    ],
    "pagination": {
    "pageNumber": 1,
    "previousPageReference": "string",
    "nextPageReference": "string",
    "previousPage": "string",
    "nextPage": "string",
    "pageSize": 25,
    "pagesCount": 5,
    "totalCount": 125
    }
    }