> ## 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 list of all the End Users for the given organisation.




## OpenAPI

````yaml /openapi/platform-api.yaml get /o/{organisation_id}/users
openapi: 3.1.0
info:
  title: Versori Platform API
  version: 0.0.1
  license:
    name: UNLICENSED
servers:
  - description: Production
    url: https://platform.versori.com/api/v2
  - description: Staging
    url: https://platform-staging.versori.com/api/v2
  - description: Development
    url: http://localhost:8901
security:
  - bearerToken: []
  - cookie: []
paths:
  /o/{organisation_id}/users:
    parameters:
      - $ref: '#/components/parameters/organisation_id'
    get:
      tags:
        - end_users
      summary: List End Users
      description: >
        ListEndUsers returns a list of all the End Users for the given
        organisation.
      operationId: ListEndUsers
      parameters:
        - 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
        - name: activated
          in: query
          description: >
            Filter users by their activation status. Must be used together with
            environment_id.

            If not provided, returns all users regardless of activation status.
          schema:
            type: boolean
        - name: environment_id
          in: query
          description: >
            Filter users by activations in a specific environment. Must be used
            together with the 'activated' parameter.

            When combined with 'activated=true', it returns users that are
            activated in the specified environment.

            When combined with 'activated=false', it returns users that are not
            activated in this specific environment.

            If not provided, returns users from all environments.
          schema:
            type: string
            format: uuid
      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:
    organisation_id:
      name: organisation_id
      in: path
      required: true
      schema:
        type: string
        format: ulid
        x-go-type: ulid.ULID
        x-go-name: OrganisationID
        x-go-type-import:
          path: versori.dev/vergo/ulid
  schemas:
    EndUserPage:
      type: object
      allOf:
        - $ref: '#/components/schemas/PageInfo'
        - type: object
          properties:
            users:
              type: array
              items:
                $ref: '#/components/schemas/EndUser'
          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
    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
    EndUser:
      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 organisations system. Regardless
            of the value, it must

            be unique within the Organisation.
          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
        organisationId:
          description: The organisation 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: OrganisationID
        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
        - organisationId
        - 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
  securitySchemes:
    bearerToken:
      description: >
        Bearer token authentication used by the Versori Platform. External
        consumers must provide an API key, however

        internal consumers must provide a JWT id_token issued by our IdP.
      type: http
      scheme: bearer
    cookie:
      description: Cookie authentication used by the Versori Platform.
      type: apiKey
      in: cookie
      name: cookie

````