> ## Documentation Index > Fetch the complete documentation index at: https://help.privy.com/llms.txt > Use this file to discover all available pages before exploring further. # List segments > Retrieve a paginated list of your customer segments with their mailable/textable member counts. Rows carry each segment's name, prebuilt flag, and reachable-member counts but not its members: `/v1/segments/{id}/contacts` returns them. Nothing in the API reports performance per segment — there is no segment report, so revenue or engagement for a segment cannot be answered from here. **Required scope:** `segments_read` ## OpenAPI ````yaml openapi/privy-api.yaml GET /segments openapi: 3.1.0 info: title: Privy API version: '1.0' description: > The Privy API lets you programmatically manage your contact list and read what you have set up in Privy. Create, update, unsubscribe, and remove contacts; report orders; and read your campaigns, flows, segments, orders, store products, coupon pools, performance reports, and account setup. servers: - url: https://api.privy.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: Retrieve information about the authenticated Privy account. - name: Contacts description: Manage your contact list. - name: Imports description: >- Read your contact import history — CSV uploads, connected-provider syncs, and SMS consent imports. - name: Campaigns description: >- Read your message campaigns — email and SMS newsletters, plus the messages your flows send. - name: Displays description: >- Read your on-site displays (popups, flyouts, banners, embedded forms, landing pages). - name: Coupons description: Read your coupon pools, their code inventory, and individual codes. - name: Reports description: >- Read performance reporting — signups, views, conversion rates, and attributed revenue — for your business, displays, and flows. - name: Flows description: Read your automation flows and their configuration. - name: Segments description: Read your customer segments and their membership. - name: Orders description: Report orders placed in your store and read your order history. - name: Products description: Read the product catalog and collections of your connected store. - name: Events description: Ingest custom events to trigger Flows and other automations. paths: /segments: get: tags: - Segments summary: List segments description: > Retrieve a paginated list of your customer segments with their mailable/textable member counts. Rows carry each segment's name, prebuilt flag, and reachable-member counts but not its members: `/v1/segments/{id}/contacts` returns them. Nothing in the API reports performance per segment — there is no segment report, so revenue or engagement for a segment cannot be answered from here. **Required scope:** `segments_read` operationId: listSegments parameters: - $ref: '#/components/parameters/AccountIdParam' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PerPageParam' responses: '200': description: A paginated list of segments. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Segment' pagination: $ref: '#/components/schemas/PaginationEnvelope' example: data: - id: Rz5T2kW8pB name: VIP Customers prebuilt: false mailable_count: 1240 textable_count: 315 counts: recounting: false refreshed_at: '2026-06-15T08:00:00Z' freshness: >- Counts are refreshed periodically and may be up to an hour old. created_at: '2026-03-01T10:00:00Z' updated_at: '2026-06-01T10:00:00Z' pagination: page: 1 per_page: 40 total_count: 7 total_pages: 1 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientScope' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: AccountIdParam: name: Privy-Account-Id in: header required: false description: > Target a subaccount instead of the main connected account. Pass a subaccount `id` from get_account's `subaccounts` list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself. schema: type: string example: S1U2B3A4C5C6T7 PageParam: name: page in: query description: Page number (starts at 1). schema: type: integer default: 1 minimum: 1 example: 1 PerPageParam: name: per_page in: query description: >- Number of results per page. Values outside 10–100 are clamped to the nearest bound. schema: type: integer default: 40 minimum: 10 maximum: 100 example: 40 schemas: Segment: type: object properties: id: type: string description: >- Stable, unique identifier for the segment. Use this value in `/v1/segments/{id}`. example: Rz5T2kW8pB name: type: string example: VIP Customers prebuilt: type: boolean description: > Whether the segment was created from one of Privy's prebuilt smart segment templates. (All segments are dynamic — membership is computed from criteria, not a static list — so there is no `type` field.) example: false mailable_count: type: - integer - 'null' description: >- Number of members reachable by email, as of `counts.refreshed_at`. `null` if never computed. example: 1240 textable_count: type: - integer - 'null' description: >- Number of members reachable by SMS, as of `counts.refreshed_at`. `null` if never computed. example: 315 counts: type: object properties: recounting: type: boolean description: Whether a membership refresh is currently running. example: false refreshed_at: type: - string - 'null' format: date-time description: >- When membership and counts were last computed. `null` if never computed. example: '2026-06-15T08:00:00Z' freshness: type: string description: Note on how current the counts are. example: Counts are refreshed periodically and may be up to an hour old. created_at: type: string format: date-time example: '2026-03-01T10:00:00Z' updated_at: type: string format: date-time example: '2026-06-01T10:00:00Z' PaginationEnvelope: type: object properties: page: type: integer example: 1 per_page: type: integer example: 25 total_count: type: integer example: 142 total_pages: type: integer example: 6 ErrorResponse: type: object properties: error: type: object required: - code - message properties: code: type: string enum: - invalid_client - invalid_scope - unauthorized - insufficient_scope - paid_plan_required - api_access_required - not_found - no_connected_store - conflict - contacts_not_ready - validation_failed - rate_limited - store_unavailable example: validation_failed message: type: string example: One or more fields are invalid details: type: array items: type: object properties: field: type: string example: email message: type: string example: is required responses: Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: Bearer token is missing or invalid InsufficientScope: description: Token lacks the required scope for this endpoint. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: insufficient_scope message: Token does not have the required scope RateLimited: description: Rate limit exceeded. Retry after the specified time. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 42 X-RateLimit-Limit-Minute: description: Maximum requests allowed per minute. schema: type: integer example: 60 X-RateLimit-Remaining-Minute: description: Requests remaining in the current minute window. schema: type: integer example: 0 X-RateLimit-Reset-Minute: description: Unix timestamp when the minute window resets. schema: type: integer example: 1711929600 X-RateLimit-Limit-Day: description: Maximum requests allowed per day. schema: type: integer example: 10000 X-RateLimit-Remaining-Day: description: Requests remaining in the current day window. schema: type: integer example: 9500 X-RateLimit-Reset-Day: description: Unix timestamp when the day window resets. schema: type: integer example: 1712016000 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limited message: Rate limit exceeded securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API token or OAuth access token description: > Send either an API token or an OAuth access token as `Authorization: Bearer `. See the Authentication page for details. ````