- Overview
- Introduction
- Hosts
- Global Headers
- Common HTTP Error Codes
- API Permits
- Authorization
- API Contexts
- Common Concepts
- Common Models
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Loyalty Clubs
- Schema
- Legal Information
- Translations
- Carbon Offset Program
- Cars
- Programs
- Receipts
- 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
Show Loyalty Club
Pending
GET
https://api.mpc.dev.placewise.com/v3/loyalty_clubs/{loyalty_club_slug}
API Permit:BL:Api:LoyaltyClubs:Get
API Context:Loyalty Club
Authorizations:UserToken
community_id
.Query Parameters#
Parameter | Type | Default | Description |
---|---|---|---|
with_mobile_settings | bool | null | When present, returns clubs addding mobile app setting information |
Example#
{
// (...) - see Loyalty Club model
}
Request
Path Params
loyalty_club_slug
stringÂ
required
Example:
infinity-mall
Query Params
with_mobile_settings
booleanÂ
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/loyalty_clubs/infinity-mall?with_mobile_settings' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '
Responses
🟢200OK
application/json
Body
id
integer <uint64>
read-onlyrequired
Example:
1
type
enum<string>Â
required
Allowed values:
MAINTENANT
community_id
integer <uint64>
read-onlyrequired
Example:
1
customer_id
integer <uint64>
read-onlyrequired
Example:
447
main_slug
stringÂ
required
short_slug
stringÂ
required
other_slugs
array[string]
required
name
stringÂ
required
main_language
stringÂ
required
languages
array[string]
required
timezone
stringÂ
required
main_website_domain
stringÂ
required
Example:
https://example.com
website_domains
array[string]
required
member_identifiers
array[string]
required
Allowed values:
msisdnemail
mobile_app_setting
object (LoyaltyClubMobileAppSetting)Â
required
android_app_id
stringÂ
optional
ios_app_id
stringÂ
optional
ios_bundle_id
stringÂ
optional
ios_team_id
stringÂ
optional
app_logo_url
stringÂ
optional
notifications_center_messages_limit
integerÂ
optional
Example
{
"id": 1,
"type": "MAIN",
"community_id": 1,
"customer_id": 447,
"main_slug": "string",
"short_slug": "string",
"other_slugs": [
"string"
],
"name": "string",
"country": "NO",
"main_language": "string",
"languages": [
"string"
],
"timezone": "string",
"main_website_domain": "https://example.com",
"website_domains": [
"string"
],
"member_identifiers": [
"msisdn"
],
"mobile_app_setting": {
"android_app_id": "string",
"ios_app_id": "string",
"ios_bundle_id": "string",
"ios_team_id": "string",
"app_logo_url": "string",
"notifications_center_messages_limit": 0
}
}
Modified at 2024-06-21 10:54:58