- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- SMS Sender Identities
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Pages
- Components
- Website
- Website Domains
- Venue Info
- Landing Pages
- Landing Page Templates
- Articles
- Events
- Events Groups
- Job Postings
- Press Releases
- Tags
- Service Messages
- Content Prototypes
- ContentPrototype Model
- List Content Prototypes
- Show Content Prototype
- Create Content Prototype
- Update Content Prototype
- Destroy Content Prototype
- List Organization Content Prototypes
- Show Organization Content Prototype
- Create Organization Content Prototype
- Update Organization Content Prototype
- Destroy Organization Content Prototype
- Mixed Content
- Attachments
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
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
loyalty_club_slug
stringÂ
required
Example:
infinity-mall
Query Params
name
stringÂ
optional
Example:
Espresso House
type
stringÂ
optional
Example:
Store
automatic
booleanÂ
optional
Example:
true
system
booleanÂ
optional
Example:
true
ids
array[string]
optional
Example:
["1"]
audiences_ids
array[string]
optional
Example:
["1"]
search
stringÂ
optional
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
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;' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2025-02-12 11:26:38