> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Members > List members with optional customer ID filter. **Scopes**: `members:read` `members:write` ## OpenAPI ````yaml get /v1/members/ openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/members/: get: tags: - members - public - mcp summary: List Members description: |- List members with optional customer ID filter. **Scopes**: `members:read` `members:write` operationId: members:list_members parameters: - name: customer_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by customer ID. title: Customer Id description: Filter by customer ID. - name: external_customer_id in: query required: false schema: anyOf: - type: string description: The customer external ID. - type: 'null' description: Filter by customer external ID. title: External Customer Id description: Filter by customer external ID. - name: role in: query required: false schema: anyOf: - $ref: '#/components/schemas/MemberRole' - type: 'null' description: Filter by member role. title: Role description: Filter by member role. - name: page in: query required: false schema: type: integer exclusiveMinimum: 0 description: Page number, defaults to 1. default: 1 title: Page description: Page number, defaults to 1. - name: limit in: query required: false schema: type: integer exclusiveMinimum: 0 description: Size of a page, defaults to 10. Maximum is 100. default: 10 title: Limit description: Size of a page, defaults to 10. Maximum is 100. - name: sorting in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/MemberSortProperty' - type: 'null' description: >- Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. default: - '-created_at' title: Sorting description: >- Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListResource_Member_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"github.com/polarsource/polar-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := polargo.New(\n polargo.WithSecurity(os.Getenv(\"POLAR_ACCESS_TOKEN\")),\n )\n\n res, err := s.Members.ListMembers(ctx, operations.MembersListMembersRequest{})\n if err != nil {\n log.Fatal(err)\n }\n if res.ListResourceMember != nil {\n for {\n // handle items\n\n res, err = res.Next()\n\n if err != nil {\n // handle error\n }\n\n if res == nil {\n break\n }\n }\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.members.list_members(page=1, limit=10) while res is not None: # Handle items res = res.next() - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar({ accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await polar.members.listMembers({}); for await (const page of result) { console.log(page); } } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Operations; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $request = new Operations\MembersListMembersRequest(); $responses = $sdk->members->listMembers( request: $request ); foreach ($responses as $response) { if ($response->statusCode === 200) { // handle response } } components: schemas: MemberRole: type: string enum: - owner - billing_manager - member title: MemberRole MemberSortProperty: type: string enum: - created_at - '-created_at' title: MemberSortProperty ListResource_Member_: properties: items: items: $ref: '#/components/schemas/Member' type: array title: Items pagination: $ref: '#/components/schemas/Pagination' type: object required: - items - pagination title: ListResource[Member] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Member: properties: id: type: string format: uuid4 title: Id description: The ID of the member. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. customer_id: type: string format: uuid4 title: Customer Id description: The ID of the customer this member belongs to. email: type: string title: Email description: The email address of the member. examples: - member@example.com name: anyOf: - type: string - type: 'null' title: Name description: The name of the member. examples: - Jane Doe external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of the member in your system. This must be unique within the customer. examples: - usr_1337 role: $ref: '#/components/schemas/MemberRole' description: The role of the member within the customer. examples: - owner type: object required: - id - created_at - modified_at - customer_id - email - name - external_id - role title: Member description: A member of a customer. Pagination: properties: total_count: type: integer title: Total Count max_page: type: integer title: Max Page type: object required: - total_count - max_page title: Pagination ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````