---
updatedAt: 2026-07-22T09:35:36.000Z
agentTools:
  projectIndex: https://docs.moneyhubenterprise.com/llms.txt
---

# Retrieve all users created by an API client

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

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Swagger 2.0 docs for the authentication/authorization Moneyhub API",
    "title": "Moneyhub Identity Service",
    "version": "2.0.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "summary": "Retrieve all users created by an API client",
        "description": "Requires **user:read** scope. Default limit is set to 10.",
        "parameters": [
          {
            "description": "The total number of records to retrieve",
            "in": "query",
            "name": "limit",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000
            }
          },
          {
            "description": "The offset at which to start retrieving records",
            "in": "query",
            "name": "offset",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "maximum": 1000000000
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful User Response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "items": {
                        "$ref": "#/components/schemas/User"
                      },
                      "type": "array"
                    },
                    "meta": {
                      "$ref": "#/components/schemas/Meta"
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "403": {
            "description": "Unsuccessful Response - Forbidden - Invalid scopes",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "tags": [
          "users"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://identity.moneyhub.co.uk"
    }
  ],
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "User": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "userId": {
            "description": "User Id",
            "example": "6017e13d58c06e66ad39af16",
            "type": "string",
            "minLength": 24,
            "maxLength": 24
          },
          "clientUserId": {
            "description": "Id specified by API client on user's creation",
            "example": "b3f118e8-93ce-4fa0-814a-7a7d8f6e1d9",
            "maxLength": 256,
            "type": "string"
          },
          "clientId": {
            "description": "API client Id that created the user",
            "example": "b68594a4-aa8c-4d92-ae1d-f39d9d6cc7ec",
            "type": "string",
            "format": "uuid"
          },
          "createdAt": {
            "description": "The date the user was created",
            "example": "2021-02-01T11:08:45.574Z",
            "format": "date-time",
            "type": "string"
          },
          "updatedAt": {
            "description": "The date the user was last updated",
            "example": "2021-02-02T11:08:45.574Z",
            "format": "date-time",
            "type": "string"
          },
          "scopes": {
            "description": "Scope used when the user was created",
            "example": "user:create",
            "type": "string"
          },
          "managedBy": {
            "description": "Represents how the user was created. Managed by client means that the api client created the user before hand according our second use case. Managed by user means that the user was created automatically when creating a connection according our first use case",
            "example": "client",
            "enum": [
              "user",
              "client"
            ],
            "type": "string"
          },
          "lastAccessed": {
            "description": "The date the user was last accessed. This property gets updated everytime a token is issued for this user",
            "example": "2021-02-01T11:08:45.574Z",
            "type": "string",
            "nullable": true
          },
          "deletedAt": {
            "description": "The date the user was deleted",
            "example": "2021-02-01T11:08:45.574Z",
            "type": "string",
            "nullable": true
          },
          "userType": {
            "description": "The type of user",
            "example": "test",
            "enum": [
              "test",
              "demo",
              "live"
            ],
            "type": "string"
          },
          "clientName": {
            "description": "Name of the api client that created the user",
            "example": "My API client",
            "maxLength": 256,
            "type": "string"
          },
          "connectionIds": {
            "description": "List of connection ids for the user",
            "example": [
              "5233db2a04fe41dd01d3308ea92e8bd7:b67c778c-1f31-48e3-a5f5-67e61d604a30"
            ],
            "type": "array",
            "items": {
              "description": "Connection id composed of the bank id and unique connection id",
              "example": "5233db2a04fe41dd01d3308ea92e8bd7:b67c778c-1f31-48e3-a5f5-67e61d604a30",
              "type": "string"
            }
          }
        },
        "required": [
          "userId",
          "clientUserId",
          "clientId",
          "createdAt",
          "updatedAt",
          "scopes",
          "managedBy",
          "lastAccessed",
          "userType",
          "connectionIds"
        ]
      },
      "Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "The error code",
            "type": "string"
          },
          "message": {
            "description": "The error message",
            "type": "string"
          },
          "correlationId": {
            "description": "Id that identifies the request and can be used to ask for more details related to the error",
            "type": "string"
          }
        },
        "required": [
          "code"
        ],
        "type": "object"
      },
      "Meta": {
        "additionalProperties": false,
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000000000
          },
          "total": {
            "type": "integer",
            "minimum": 0
          }
        },
        "type": "object"
      }
    }
  }
}
```