users

Retrieve all users created by an API client

Changed on

Requires user:read scope. Default limit is set to 10.

get/users

Request

  • Base URL
    https://identity.moneyhub.co.uk
  • URL
    https://identity.moneyhub.co.uk/users
  • Auth
    API key in header Authorization

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

Response

Successful User Response

Example response

{
  "data": [
    {
      "userId": "6017e13d58c06e66ad39af16",
      "clientUserId": "b3f118e8-93ce-4fa0-814a-7a7d8f6e1d9",
      "clientId": "b68594a4-aa8c-4d92-ae1d-f39d9d6cc7ec",
      "createdAt": "2021-02-01T11:08:45.574Z",
      "updatedAt": "2021-02-02T11:08:45.574Z",
      "scopes": "user:create",
      "managedBy": "client",
      "lastAccessed": "2021-02-01T11:08:45.574Z",
      "deletedAt": "2021-02-01T11:08:45.574Z",
      "userType": "test",
      "clientName": "My API client",
      "connectionIds": [
        "5233db2a04fe41dd01d3308ea92e8bd7:b67c778c-1f31-48e3-a5f5-67e61d604a30"
      ]
    }
  ]
}

Changes

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status