SupportProduct Documentation
    • Introduction
    • URL Structure
    • API Key
    • Errors
    • Versioning
    • Pagination
    • Replication
    • Performance
    • Rate Limits
    • Webhooks
  • System Services
    • Companies
    • Hello World
  • Accounts
  • Ticketing
    • Getting started
    • Catalog
    • Capacity
    • Tickets
    • Reservations
    • Schedule
  • Memberships
    • Catalog
    • Membership
    • Member
    • Card
    • Payment Method
    • Lifecycle
    • Miscellaneous
    • Points
  • Speedgate
  • Attraction Wallet
  • POS
    • POS Sale
    • POS Unit
    • POS Store
    • Salesperson
    • External POS Sale
    • Global POS Entry
  • Inventory
    • Barcodes
    • Items
    • Item Ledger Entries
    • Item Categories
    • Item Variants
    • Item Translations
  • Coupon
  • Vouchers
    • Vouchers
  • Ecommerce
    • Sales Documents
  • Finance
    • General Ledger Account
    • General Ledger Entries
    • General Ledger Journal
LogoLogo
SupportProduct Documentation
MembershipsMiscellaneous

GET
https://api.npretail.app/:tenant/:environment/:company/membership/list
GET
/:tenant/:environment/:company/membership/list
1curl -G https://api.npretail.app/01234567-89ab-cdef-0123-456789abcdef/production/CRONUS%20International%20Ltd./membership/list \
2 -H "Authorization: Bearer <apiKey>" \
3 -d pageSize=1 \
4 -d membershipCode=GOLD
Try it
200Retrieved
1{
2 "morePages": true,
3 "data": [
4 {
5 "membershipId": "cdef7890-abcd-0123-1234-567890abcdef",
6 "membershipNumber": "MS-DEMO-00152",
7 "communityCode": "RIVERLAND",
8 "membershipCode": "GOLD",
9 "issueDate": "2024-09-17",
10 "blocked": false,
11 "autoRenewalActivated": true,
12 "validFromDate": "2024-09-17",
13 "validUntilDate": "2025-09-16",
14 "customerNumber": "D000188",
15 "attributes": []
16 }
17 ],
18 "nextPageKey": "c29tZSBiYXNlNjQgc3RyaW5n",
19 "nextPageURL": "https://api.npretail.app/tenant/env/company/membership/list?pageKey=c29tZSBiYXNlNjQgc3RyaW5n"
20}
Retrieve a list of memberships. This endpoint supports pagination and filtering. Page size default is 100, maximum is 1000.
Was this page helpful?
Previous

Points

Next
Built with
Points
Retrieve a list of memberships. This endpoint supports pagination and filtering. Page size default is 100, maximum is 1000.
List Memberships

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tenantstringRequired

Your Entra Tenant ID. More details.

environmentstringRequired

Your Business Central Environment. More details.

companystringRequired
Your Business Central Company. [More details.](/paths#3-company)

Headers

x-api-versiondateOptional
Used for API versioning. [More details.](/versioning)

Query parameters

pageSizeintegerOptional
pageKeystringOptional
communityCodestringOptional
membershipCodestringOptional
customerNumberstringOptional
blockedbooleanOptional
issueDatedatetimeOptional
issuedFromDatedatetimeOptional
issuedUntilDatedatetimeOptional

Response

This endpoint returns an object.
morePagesboolean
datalist of objects
nextPageKeystring or null
nextPageURLstring or null

Your Business Central Company. More details.

Used for API versioning. More details.