> ## Documentation Index > Fetch the complete documentation index at: https://developers.circle.com/llms.txt > Use this file to discover all available pages before exploring further. # List users > Get all the users under the entity. ## OpenAPI ````yaml openapi/user-controlled-wallets.yaml get /v1/w3s/users openapi: 3.0.3 info: version: '1.0' title: User-Controlled Wallets description: User-Controlled Wallets API documentation. servers: - url: https://api.circle.com security: - BearerAuth: [] tags: - name: Social/ Email Authentication - name: PIN Authentication - name: Users - name: Wallets - name: Transactions - name: Token Lookup - name: Signing paths: /v1/w3s/users: get: tags: - Users summary: List users description: Get all the users under the entity. operationId: listUsers parameters: - $ref: '#/components/parameters/PinStatus' - $ref: '#/components/parameters/SecurityQuestionStatus' - $ref: '#/components/parameters/From' - $ref: '#/components/parameters/To' - $ref: '#/components/parameters/PageBefore' - $ref: '#/components/parameters/PageAfter' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/Order' - $ref: '#/components/parameters/XRequestId' responses: '200': description: Users retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Users' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' Link: $ref: '#/components/headers/PaginationLink' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/NotAuthorized' security: - BearerAuth: [] components: parameters: PinStatus: name: pinStatus description: Filter by the PIN status of the wallet. in: query schema: type: string enum: - ENABLED - UNSET - LOCKED SecurityQuestionStatus: name: securityQuestionStatus description: Filter by the security question status of the wallet. in: query schema: type: string enum: - ENABLED - UNSET - LOCKED From: name: from description: >- Queries items created since the specified date-time (inclusive) in ISO 8601 format. in: query schema: type: string format: date-time example: '2023-01-01T12:04:05Z' To: name: to description: >- Queries items created before the specified date-time (inclusive) in ISO 8601 format. in: query schema: type: string format: date-time example: '2023-01-01T12:04:05Z' PageBefore: name: pageBefore description: > A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter. in: query schema: type: string format: uuid PageAfter: name: pageAfter description: > A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore. in: query schema: type: string format: uuid PageSize: name: pageSize description: > Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. in: query schema: type: integer default: 10 maximum: 50 minimum: 1 Order: name: order description: | Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default). in: query schema: type: string enum: - ASC - DESC default: DESC XRequestId: name: X-Request-Id in: header description: > Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems. schema: $ref: '#/components/schemas/XRequestId' schemas: Users: title: UsersResponse type: object required: - data properties: data: type: object required: - users properties: users: type: array items: $ref: '#/components/schemas/EndUser' XRequestId: type: string format: uuid description: >- A unique identifier, which can be helpful for identifying a request when communicating with Circle support. example: 2adba88e-9d63-44bc-b975-9b6ae3440dde EndUser: type: object properties: id: $ref: '#/components/schemas/Id' createDate: $ref: '#/components/schemas/CreateDate' pinStatus: $ref: '#/components/schemas/PinStatus' status: $ref: '#/components/schemas/EndUserStatus' securityQuestionStatus: type: string enum: - ENABLED - UNSET - LOCKED example: ENABLED pinDetails: allOf: - $ref: '#/components/schemas/PinSecurityDetails' securityQuestionDetails: allOf: - $ref: '#/components/schemas/PinSecurityDetails' Id: type: string format: uuid description: System-generated unique identifier of the resource. example: c4d1da72-111e-4d52-bdbf-2e74a2d803d5 CreateDate: type: string format: date-time description: Date and time the resource was created, in ISO-8601 UTC format. example: '2023-01-01T12:04:05Z' PinStatus: type: string enum: - ENABLED - UNSET - LOCKED description: >- Status of the user PIN code. PIN must be in ENABLED state to authorize requests. example: ENABLED EndUserStatus: type: string enum: - ENABLED - DISABLED example: ENABLED PinSecurityDetails: type: object properties: failedAttempts: type: integer description: | FailedAttempts the number of times a user has entered an invalid pin code. lockedDate: format: date-time type: string description: The date and time when the pin code has been locked. example: '2023-01-01T12:04:05Z' lockedExpiryDate: type: string format: date-time description: The date and time when the pin code will be unlocked. example: '2023-01-01T12:04:05Z' lastLockOverrideDate: type: string format: date-time description: >- This is the last date and time when the lock was unlocked by admin manually. example: '2023-01-01T12:04:05Z' headers: XRequestId: description: > Developer-provided header parameter or Circle-generated universally unique identifier (UUID v4). Useful for identifying a specific request when communicating with Circle Support. schema: $ref: '#/components/schemas/XRequestId' PaginationLink: description: > Pagination cursor information. Format includes the following link relations: - self: URL pointing to the current page. - first: URL pointing to the first page. - next: URL pointing to the next page (omitted on the last page). - prev: URL pointing to the previous page (omitted on the first page). It's important to form calls with Link header values instead of constructing your own URLs. schema: type: string example: >- ; rel="next" responses: BadRequest: content: application/json: schema: type: object title: BadRequestResponse required: - code - message properties: code: type: integer description: Code that corresponds to the error. message: type: string description: Message that describes the error. example: code: 400 message: Bad request. description: Request cannot be processed due to a client error. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' NotAuthorized: content: application/json: schema: type: object title: NotAuthorizedResponse required: - code - message properties: code: type: integer description: Code that corresponds to the error. message: type: string description: Message that describes the error. example: code: 401 message: Malformed authorization. description: >- Request has not been applied because it lacks valid authentication credentials. headers: X-Request-Id: $ref: '#/components/headers/XRequestId' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: PREFIX:ID:SECRET description: >- Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request. ````