> ## Documentation Index > Fetch the complete documentation index at: https://docs.argyle.com/llms.txt > Use this file to discover all available pages before exploring further. # List All Users > Returns a paginated list of all user objects. ## OpenAPI ````yaml get /v2/users openapi: 3.0.0 info: title: Users API version: 1.0.0 description: | API for managing users. Users connect their payroll accounts using Link. servers: [] security: - basicAuth: [] paths: /v2/users: get: summary: List all users description: Returns a paginated list of all user objects. parameters: - in: query name: limit schema: type: integer description: > Number of user objects returned [per page](/api-guide/overview#pagination). Default: 10. Maximum: 200. - in: query name: external_id schema: type: string description: Filter users by `external_id`. Exact matches only. - in: query name: cursor schema: type: string description: >- The URL returned in `next` or `previous` used to retrieve another [page](/api-guide/overview#pagination) of results. responses: '200': description: '' content: application/json: schema: type: object properties: next: type: string format: uri nullable: true description: URL for the next page of results, if available. previous: type: string format: uri nullable: true description: URL for the previous page of results, if available. results: type: array items: $ref: '#/components/schemas/User' example: next: >- https://api-sandbox.argyle.com/v2/users?cursor=ZXhhbXBsZV9jdXJzb3I previous: null results: - id: 018051aa-f7a9-a0db-2f38-6cfa325e9d69 created_at: '2023-01-30T22:25:38.971Z' items_connected: - item_123456789 - item_987654321 employers_connected: - Whole Goods - Bullseye external_metadata: notes: In stage 3 of loan approval. category: Summer Initiative external_id: July Connection first_name: Sarah last_name: Longfield email: sarah@email.com phone_number: '+12125555555' ssn: null address: city: null line1: null line2: null state: null country: null postal_code: null birth_date: year: null month: null day: null - id: 0186c5b8-8fa1-67b3-39af-14b3e18da8a7 created_at: '2023-01-30T23:25:38.971Z' items_connected: - item_000000001 - item_000000002 employers_connected: - Half Bads - Triple external_metadata: notes: In stage 1 of loan approval. category: Summer Initiative external_id: August Connection first_name: null last_name: null email: null phone_number: null ssn: null address: city: null line1: null line2: null state: null country: null postal_code: null birth_date: year: null month: null day: null components: schemas: User: type: object properties: id: type: string format: uuid description: Unique ID of the user. example: 018051aa-f7a9-a0db-2f38-6cfa325e9d69 created_at: type: string format: date-time description: Timestamp (ISO 8601) when the user object was created. example: '2023-01-30T22:25:38.971Z' items_connected: type: array items: type: string description: >- Items the user has connected through Link. Typically employers or payroll platforms. example: - item_123456789 - item_987654321 employers_connected: type: array items: type: string description: Individual employers associated with the connected Items. example: - Whole Goods - Bullseye external_metadata: type: object description: > Free-text field where additional context for the user can be added. - Can be any valid JSON, such as a string or object. Using `external_id` (see below) is recommended when the ability to filter users by an external value is needed. example: notes: Moved to stage 2 of loan approval. category: Summer Initiative external_id: type: string description: > Free-text field where [additional context](/overview/data-structure/users#external-identifiers) for the user can be added. - Can be any string of 100 characters or less. - Multiple users can have the same `external_id`. Often used to group users, or associate your internal ID's to users. - Can be attached to [invites](/console/flows/email-sms-templates#inviting-new-users) or [shareable URLs](/console/flows/shareable-urls#customizations). - Can be used as a query parameter when [listing users](/api-reference/users#list). (Only exact matches are supported) - Can be used to search for specific users within the [Connections](https://console.argyle.com/connections) section of Console. - Will appear on billing CSVs if associated with a user. example: July_Connection first_name: type: string description: First name of the user. example: Sarah last_name: type: string description: Last name of the user. example: Longfield email: type: string description: Email of the user. example: sarah@email.com phone_number: type: string description: Phone number of the user. E.164 international format. example: '+12125555555' ssn: type: string description: Social Security number of the user. example: null address: type: object description: Address of the user. properties: city: type: string description: Name of the city, town, district, or similar regional entity. example: null line1: type: string description: Address-Line 1, usually street address or P.O. Box information. example: null line2: type: string description: Address-Line 2, usually the apartment or unit number. example: null state: type: string description: State, county, province, region, or equivalent. example: null country: type: string description: Two-letter country code (ISO 3166-1 alpha-2 format). example: null postal_code: type: string description: Zip code, or equivalent. example: null birth_date: type: object description: Date of birth of the user. properties: year: type: integer description: Birth year (1900 or later). example: null month: type: integer description: Birth month (between 1 and 12). example: null day: type: integer description: Birth day (between 1 and 31). example: null securitySchemes: basicAuth: type: http scheme: basic description: Username = api_key_id, Password = api_key_secret ````