---
title: "List CustomerSegmentMembers"
method: GET
path: "/shop/customers/customer-segments/{customerSegmentId}/members"
tags: ["CustomerSegmentMembers"]
---

# List CustomerSegmentMembers

`GET /shop/customers/customer-segments/{customerSegmentId}/members`

Returns a paginated list of members belonging to the given `CustomerSegment`.

## Query parameters

- `query` string
- `subscribed` boolean
- `page` integer
- `per_page` integer

## Response `200`

The segment members were successfully retrieved.

- object
  - `data` CustomerSegmentMember[], required
    - `id` string, uuid, required — The unique identifier of the segment membership record.
    - `segment_id` string, uuid, required — The ID of the segment this membership belongs to.
    - `unsubscribed_at` string, date-time, nullable, required — The datetime at which the customer unsubscribed from this segment's communications, or `null` if they are currently subscribed.
    - `customer` CustomerSummary, required — A summary of the `Customer` this order belongs to.
      - `id` string, uuid, required — The ID of the customer.
      - `email` string, nullable, required — The email address of the customer. The case of the email address is not preserved, so you'll always see this in lowercase.
      - `first_name` string, nullable, required — The first name of the customer.
      - `full_name` string, nullable, required — The customer's full name
      - `labels` Label[], required
        - `id` string, required
        - `color` string, nullable, required
        - `name` string, required
      - `last_name` string, nullable, required — The last name of the customer.
      - `phone` string, nullable, required — The customer's phone number in E.164 format, or `null` if not provided.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.
- `404` — The resource couldn't be found

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)