- Introduction
- Core
- Privacy Policy
- Community
- Loyalty Clubs
- Applications
- Branding
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Sender Identities
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- Events
- Games
- Scraper
- Files
- Receipts
- Messaging History
List Member Groups
Pending
GET
https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/members_groups
API Permit:BL:Api:MembersGroups:Index
API Context:Loyalty Club
Authorizations:UserToken
Query Parameters#
| Parameter | Type | Default | Description |
|---|---|---|---|
| per_page | integer | 1000 | Number of results to be returned per request (1000 is the maximum) |
| page_no | integer | 1 | Number of results page |
| name | string | null | When given, returns only group of given name |
| type | string | null | When given, returns only groups of given type |
| automatic | boolean | null | When true, only automatic groups are returned, when false - only manual |
| system | boolean | null | When true, only system groups are returned, when false - only non-system |
| ids | integer[] | null | When given, returns only groups with the given ids |
| audiences_ids | integer[] | null | When given, returns only automatic groups for given audiences |
| search | string | null | When given, returns only groups that have name, type or description matching the query string |
Response Body#
| Key | Type | Description |
|---|---|---|
| members_groups | MembersGroup[] | Array of MembersGroup |
| pagination_info | Object | Pagination object |
Example#
{
"members_groups": [], // List of members groups - see 'MemberGroup model'
"pagination_info": {} // Pagination info - see 'Pagination info'
}Request
Path Params
Query Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v3/infinity-mall/members_groups?name=Espresso House&type=Store&automatic=true&system=true&ids=1&audiences_ids=1&search' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
Example
{}