POST
/
publisher.v1
/
member
/
list
List
curl --request POST \
  --url http://localhost/publisher.v1/member/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "member_base_id": "<string>",
  "pagination": {
    "limit": 500,
    "cursor": "<string>",
    "skip": 2
  },
  "filters": [
    {
      "or": "<array>"
    }
  ]
}
'
{
  "data": [
    {
      "id": "<string>",
      "member_base_id": "<string>",
      "ref": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "page_size": 123,
    "cursor": "<string>",
    "total": 123,
    "more": true
  }
}
The list members endpoint retrieves members belonging to a specific memberbase. You can filter results by member ref to retrieve a targeted subset.

​
Filtering

Pass a filters array to narrow results. The ref filter supports exact match (eq), inclusion (in), and exclusion (nin) operators. When no filters are provided, all members in the memberbase are returned.

​
Pagination

Results are returned in pages. For memberbases with large member counts, use the cursor returned in the response to fetch subsequent pages.

Body

application/json
​
member_base_id
string
required
​
pagination
ListMembersPagination · object
​
filters
(ListMembersOrFilter · object | ListMembersAndFilter · object | ListMembersIdFilter · object | ListMembersRefFilter · object)[]

Response

Successful response

​
data
Member · object[]
required
​
page
ResultPageInfo · object
required