List Segment Members

Paginated members of a segment. Defaults sort `joinedAt` desc.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Segment id.

Pattern: "^[a-f0-9]{24}$"

Query Parameters

pageNumberinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 1Maximum: 200

sortFieldstring

sortDirectionstring

Default: "desc"Value in: "asc" | "desc"

searchstring

GET/v1/segments/{id}/members

curl -X GET "https://api.3common.com/v1/segments/string/members?sortField=string&sortDirection=asc&search=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "segmentId": "string",
      "memberId": "string",
      "joinedAt": "2019-08-24T14:15:22Z",
      "property1": null,
      "property2": null
    }
  ],
  "hasMore": true,
  "pageNumber": 0,
  "pageSize": 0
}

TypeScript

export interface Response {
  data: {
    segmentId: string;
    memberId: string;
    joinedAt: string;
    [k: string]: unknown;
  }[];
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
}