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

# List members

> Lists the members of one of your accounts, oldest first. The account itself is not in the list. Requires the `PARTNER` scope.

<Note>
  **Required scope:** `PARTNER`
</Note>

Lists the members of one of your accounts, oldest first, with their role, their numbers and whether they have signed in. The account itself is not in the list.

* `page` starts at 1 and `size` defaults to 20, up to 100. The response carries the usual `pagination` object, see [Pagination](/en/v2/api-reference/guides/pagination).
* Each member's `id` is the `holder_id` to send to [Order eSIM](/en/v2/api-reference/partner/order-esim) for that member's number.
* `activated` is `true` once the member has signed in on a device.
* An account your API key did not create, or one already deactivated, returns `404 PARTNER_ACCOUNT_NOT_FOUND`.

To add a member, call [Add member](/en/v2/api-reference/partner/add-member).


## OpenAPI

````yaml GET /v2/api/partner/accounts/{id}/members
openapi: 3.0.3
info:
  title: Allo API
  description: >-
    Allo API provides programmatic access to your Allo account, allowing you to
    manage webhooks, retrieve calls and contacts, and send SMS messages.


    All requests to `/v1/api/**` endpoints automatically go through quota
    checking and scope validation.
  version: 1.0.0
  contact:
    name: Allo Support
servers:
  - url: https://api.withallo.com
    description: Production server
security: []
tags:
  - name: Summary Templates
    description: >-
      Manage call summary templates that control how AI-generated call summaries
      are structured for your team.
  - name: Webhooks
    description: >-
      Manage webhook endpoints to receive real-time notifications about events
      in your Allo account. Each endpoint subscribes to one or more event topics
      and is verified with a signing secret.
  - name: Calls
    description: >-
      Retrieve and search call records with filtering and pagination. Filter
      calls by your Allo phone number.
  - name: Contacts
    description: >-
      Search and retrieve contact information with sorting and pagination.
      Includes engagement level tracking.
  - name: SMS
    description: Send SMS messages to phone numbers using your Allo numbers.
  - name: Phone Numbers
    description: Retrieve information about your Allo phone numbers.
  - name: Analytics
    description: Pre-computed call metrics, team performance, and outbound dial funnel
  - name: CRM
    description: Manage people, companies, and deals in your CRM.
  - name: Notes
    description: >-
      Internal team notes on conversations and CRM people, with @mention
      support. Notes are never visible to the contact.
  - name: Threads
    description: >-
      Team discussion threads attached to a conversation item (call, SMS, or
      conversation note). One thread per item.
  - name: AI Receptionist
    description: >-
      Read and write the AI receptionist configuration of a phone line: business
      details, voice, prompt, capabilities, business hours, transfer rules,
      scheduling calendars and knowledge sources.
paths:
  /v2/api/partner/accounts/{id}/members:
    get:
      tags:
        - Partner
      summary: List members
      description: >-
        Lists the members of one of your accounts, oldest first. The account
        itself is not in the list. Requires the `PARTNER` scope.
      operationId: listPartnerAccountMembers
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The account id returned by Create account (`usr-*`).
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Size'
      responses:
        '200':
          description: The account's members
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            The member's user id (`usr-*`). Pass it as
                            `holder_id` to Order eSIM to register the member's
                            eSIM to the member.
                          example: usr-8C1B2E7F4A9D3C6B0E5F1A2D7C4B9E3F6A0D8C21
                        account_id:
                          type: string
                          description: The account the member was added to.
                          example: usr-575966AF3661061265263C58882BC409D2A427B8
                        email:
                          type: string
                          description: The member's login.
                          example: paul@example.com
                        name:
                          type: string
                          example: Paul Martin
                        role:
                          type: string
                          enum:
                            - ADMIN
                            - MANAGER
                            - MEMBER
                          example: MEMBER
                        phone_numbers:
                          type: array
                          items:
                            type: string
                          description: The member's own numbers.
                          example:
                            - '+33745805111'
                        status:
                          type: string
                          example: ACTIVE
                        activated:
                          type: boolean
                          description: True once the member has signed in on a device.
                          example: false
                  pagination:
                    $ref: '#/components/schemas/ApiPagination'
              example:
                data:
                  - id: usr-8C1B2E7F4A9D3C6B0E5F1A2D7C4B9E3F6A0D8C21
                    account_id: usr-575966AF3661061265263C58882BC409D2A427B8
                    email: paul@example.com
                    name: Paul Martin
                    role: MEMBER
                    phone_numbers:
                      - '+33745805111'
                    status: ACTIVE
                    activated: false
                pagination:
                  page: 1
                  size: 20
                  total_count: 1
                  total_pages: 1
                  has_more: false
        '401':
          $ref: '#/components/responses/ApiUnauthorized'
        '403':
          description: The API key lacks the PARTNER scope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '404':
          description: >-
            No account with this id was provisioned by your API key, or the
            account is deactivated (PARTNER_ACCOUNT_NOT_FOUND).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
        '429':
          $ref: '#/components/responses/ApiRateLimited'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    Page:
      name: page
      in: query
      description: Page number (1-indexed)
      schema:
        type: integer
        default: 1
        minimum: 1
    Size:
      name: size
      in: query
      description: Results per page
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
  schemas:
    ApiPagination:
      type: object
      properties:
        page:
          type: integer
          example: 1
        size:
          type: integer
          example: 20
        total_count:
          type: integer
          format: int64
          example: 1
        total_pages:
          type: integer
          example: 1
        has_more:
          type: boolean
          example: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            request_id:
              type: string
            retry_after_seconds:
              type: integer
              nullable: true
  responses:
    ApiUnauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ApiRateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````

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