> ## Documentation Index
> Fetch the complete documentation index at: https://docs.versori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List End Users

> ListEndUsers returns a paginated list of all the End Users for the given Hub.




## OpenAPI

````yaml get /hubs/{hub_id}/users
openapi: 3.1.0
info:
  title: Versori Embedded API
  version: 0.0.1
  license:
    name: UNLICENSED
    identifier: UNLICENSED
  description: V1 API for managing embedded integrations
servers:
  - description: Production
    url: https://platform.versori.com/api/embedded/v1
  - description: Staging
    url: https://platform-staging.versori.com/api/embedded/v1/
  - description: Development
    url: http://localhost:8950/embedded/v1
security: []
tags:
  - name: Hubs
  - name: End Users
  - name: Connectors
  - name: Integrations
  - name: Connections
  - name: Embedded
  - name: Miscellaneous
  - name: Internal
paths:
  /hubs/{hub_id}/users:
    parameters:
      - $ref: '#/components/parameters/hub_id'
    get:
      tags:
        - End Users
      summary: List End Users
      description: >
        ListEndUsers returns a paginated list of all the End Users for the given
        Hub.
      operationId: ListEndUsers
      parameters:
        - $ref: '#/components/parameters/first'
        - $ref: '#/components/parameters/before'
        - $ref: '#/components/parameters/after'
        - name: search
          in: query
          description: >
            Search is a string that is used to filter the list of End Users. The
            search string is matched against the

            id, externalId and displayName fields.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndUserPage'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    hub_id:
      name: hub_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ULID'
    first:
      name: first
      in: query
      required: false
      schema:
        type: integer
        default: 20
    before:
      name: before
      in: query
      required: false
      schema:
        type: string
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
  schemas:
    EndUserPage:
      type: object
      allOf:
        - $ref: '#/components/schemas/PageInfo'
        - type: object
          properties:
            users:
              type: array
              items:
                $ref: '#/components/schemas/EndUserSummary'
          required:
            - users
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
          x-go-type-skip-optional-pointer: true
        details:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message
    ULID:
      type: string
      format: ulid
      x-go-type: ulid.ULID
      x-go-type-skip-optional-pointer: true
      x-go-type-import:
        path: versori.dev/vergo/ulid
    PageInfo:
      type: object
      properties:
        totalCount:
          type: integer
        next:
          type: string
          x-go-type-skip-optional-pointer: true
        prev:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - totalCount
    EndUserSummary:
      type: object
      properties:
        id:
          description: >
            ID is the Versori identifier for the user. Most APIs will not use
            this field but instead reference

            users by their externalId.
          type: string
          format: ulid
          x-go-type: ulid.ULID
          x-go-type-skip-optional-pointer: true
          x-go-type-import:
            path: versori.dev/vergo/ulid
          x-go-name: ID
        externalId:
          description: >
            ExternalID is the identifier for the user as determined by the
            organisation. This typically should

            be the same as the user's ID on the Primary Connector for the Hub.
            Regardless of the value, it must 

            be unique within the Hub.
          type: string
          x-go-name: ExternalID
        displayName:
          description: >
            DisplayName is an optional human-readable name for the user. If not
            set, the default is an empty string.
          type: string
        hubId:
          description: The hub ID to which the user belongs to.
          type: string
          format: ulid
          x-go-type: ulid.ULID
          x-go-type-skip-optional-pointer: true
          x-go-type-import:
            path: versori.dev/vergo/ulid
          x-go-name: HubID
        createdAt:
          type: string
          format: date-time
          description: CreatedAt is the time the user was created.
          x-go-type: time.Time
        updatedAt:
          type: string
          format: date-time
          description: UpdatedAt is the time the user was last updated.
          x-go-type: time.Time
      required:
        - id
        - externalId
        - displayName
        - hubId
        - createdAt
        - updatedAt
    ErrorField:
      description: ErrorField denotes a field which has an error.
      type: object
      properties:
        field:
          type: string
          description: >
            Field is the name of the field which has an error, this may be a
            path to a nested field, including array

            elements. The format of this field is of the form:
            "field1.field2[0].field3"
        message:
          type: string
          description: Message is the error message for this specific field.
      required:
        - field
        - message

````