---
title: "List members"
method: GET
path: "/v2/members"
tags: ["Members"]
---

# List members

`GET /v2/members`

## Request

- Base URL: `https://api.zenzap.co`
- URL: `https://api.zenzap.co/v2/members`
- Auth: one of:
  - HTTP bearer and API key in header `X-Signature`
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.zenzap.co/oauth/token` scopes: `member:read`
- TypeScript: <https://skmtc.dev/zenzap/apis/zenzap-external-integration-api/docs/v2/members/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a paginated list of all members in your organization. Only returns active members.

Pagination:
- `limit`: default `50`, max `100`
- `cursor`: opaque cursor from the previous response (`nextCursor`)

## Query parameters

- `limit` integer
- `cursor` string
- `emails` string

## Headers

- `X-Signature` string
- `X-Timestamp` integer

## Response `200`

Members list retrieved successfully

- MembersListResponse
  - `members` MemberResponse[]: Array of member objects
    - `id` string: The member ID
    - `name` string: The member's name
    - `email` string, email: The member's email address
    - `phone` string: The member's phone number
    - `externalId` string: Optional external identifier if set by your integration
    - `createdAt` integer: Unix timestamp in milliseconds when the member was created
    - `updatedAt` integer: Unix timestamp in milliseconds when the member was last updated
    - `status` 'Pending' | 'Active' | 'Deleted' | 'Archived': The member's status
  - `nextCursor` string: Cursor for the next page. Omitted when there are no more results.
  - `hasMore` boolean: Whether there are more members available.

## Other responses

- `401`: Unauthorized - invalid or missing API token
- `500`: Internal server error

---

[API](https://skmtc.dev/zenzap/apis/zenzap-external-integration-api.md) - [All operations](https://skmtc.dev/zenzap/apis/zenzap-external-integration-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zenzap/apis/zenzap-external-integration-api/revisions/37faae2c2036?raw)
