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

# List Company Members

> Lists every **member** of the company: the people the app's **Users**
settings page lists, each with their role. A member's `id` is the user ID
that other operations take for another person — `assignees` on
[Create Task](/api-reference/tasks/create-task) and
[Update Task](/api-reference/tasks/update-task), and `ownerUserId` on the
export-preset operations such as
[List Export Presets For Member](/api-reference/entities/list-export-presets-for-member).
Every listed `id` passes their membership check, and a user who is not
listed fails it.

The list is not paginated. Members are ordered by `name`, then `email`,
then `id`.

**Required permission:** `member.view`




## OpenAPI

````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/members
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/members:
    get:
      tags:
        - Companies
      summary: List Company Members
      description: >
        Lists every **member** of the company: the people the app's **Users**

        settings page lists, each with their role. A member's `id` is the user
        ID

        that other operations take for another person — `assignees` on

        [Create Task](/api-reference/tasks/create-task) and

        [Update Task](/api-reference/tasks/update-task), and `ownerUserId` on
        the

        export-preset operations such as

        [List Export Presets For
        Member](/api-reference/entities/list-export-presets-for-member).

        Every listed `id` passes their membership check, and a user who is not

        listed fails it.


        The list is not paginated. Members are ordered by `name`, then `email`,

        then `id`.


        **Required permission:** `member.view`
      operationId: listCompanyMembers
      parameters:
        - $ref: '#/components/parameters/companyId'
      responses:
        '200':
          description: The company's members.
          content:
            application/json:
              schema:
                type: object
                required:
                  - members
                properties:
                  members:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyMember'
              examples:
                success:
                  summary: Two members
                  value:
                    members:
                      - id: 3f2b8c1e-6d4a-4b7e-9a15-2c8e0f4d7b91
                        name: Jane Doe
                        email: jane@example.com
                        role:
                          key: admin
                          name: Admin
                      - id: 8a1d5e2f-4c3b-4e9a-b7d6-1f0e2c3a4b5d
                        name: Sam Underwriter
                        email: sam@example.com
                        role:
                          key: underwriter
                          name: Underwriter
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    CompanyMember:
      type: object
      description: A member of the company.
      required:
        - id
        - name
        - email
        - role
      properties:
        id:
          type: string
          format: uuid
          description: >-
            The member's user ID: the value task `assignees` and export-preset
            `ownerUserId` take.
        name:
          type: string
          nullable: true
          description: The member's display name, or `null` when unset.
        email:
          type: string
          nullable: true
          description: The member's email, or `null` when unset.
        role:
          type: object
          description: The member's role in this company.
          required:
            - key
            - name
          properties:
            key:
              type: string
              description: The role's stable key, such as `admin`.
            name:
              type: string
              description: The role's display name.
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  code:
                    type: string
                    description: Stable problem code for this individual validation failure
                    example: BLANK_LIST_ELEMENT
                  reason:
                    type: string
                    description: Stable reason the value violates its canonical contract
                    example: blank-list-element
                  expected:
                    type: string
                    description: The expected canonical value contract
                    example: nonblank trimmed string
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0
        access token (audience = the app API audience) as `Authorization: Bearer
        <jwt>`. The request resolves to the user's identity and is authorized by
        their Role on the `{companyId}` in the path — the same role-based
        permissions the web app enforces. This is the path the MCP connector
        uses to act on a user's behalf; endpoints that accept it list both
        `BearerAuth` and `ApiKeyAuth`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.