---
title: "Get a list of memberships"
method: GET
path: "/api/v2/organizations/{orgSlug}/memberships"
tags: ["Memberships"]
---

# Get a list of memberships

`GET /api/v2/organizations/{orgSlug}/memberships`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/memberships`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.community.memberships.read`

Retrieve a list of sets of day memberships based on provided filters 

 Required scopes: `flex.community.memberships.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `_id` string
- `company` string
- `member` string
- `calculatedStatus` 'not_started' | 'active' | 'expired' | 'not_approved': The actual membership status calculated by the platform.
- `location` string
- `plan` string
- `modifiedAt` string
- `createdAt` string
- `properties` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` MembershipResultDto[]
    - `properties` object: An object that contains all custom properties that can be applied to the item.
    - `_id` string: The _id of the membership.
    - `name` string: The name of the membership.
    - `isPersonal` boolean: If true, the membership is billed to the assigned member and not to the company.
    - `status` 'approved' | 'not_approved': The approval status of the membership. This is usually set to approved, but if a member purchases a membership that needs to be approved, the status will be "not_approved".
    - `calculatedStatus` 'not_started' | 'active' | 'expired' | 'not_approved': The actual membership status calculated by the platform.
    - `type` 'month_to_month' | 'fixed': The type of the membership.
    - `location` string: A reference to the location the membership is issued for.
    - `plan` string: A reference to the price plan assigned to the membership. It is used to determine the sales account when generating an invoice.
    - `company` string: The _id of the company with which the membership is associated.
    - `member` string: The _id of the member with which the membership is associated.
    - `startDate` string: The membership starting date.
    - `endDate` string: The last date of membership. If not set, the membership is open-ended.
    - `intervalLength` 'once' | 'hour' | 'day' | 'month': The membership interval. It could be "once", "hour", "day", or "month".
    - `intervalCount` number: The length of the membership interval.
    - `isLocked` boolean: If true, prevents editing the membership.
    - `price` number: The monthly price of the membership.
    - `deposit` number: The deposit of the membership.
    - `discount` string: A reference to a discount definition.
    - `discountAmount` number: Manually granted discount for the specific membership.
    - `calculatedDiscountAmount` number: The actual discount amount coming from a discount defintion or from a manually granted discount.
    - `discountedPrice` number: The final membership unit price after granting the discount.
    - `contract` string: Reference to the contract associated with the membership
    - `source` string: The source of the membership.
    - `createdAt` string, date-time: The date when the membership has been created.
    - `createdBy` string: The user that created the membership.
    - `modifiedAt` string, date-time: The user that did the last modification to the membership. If no update is made this field will match the "createdBy" field.
    - `modifiedBy` string: The user that last updated the membership.

---

[API](https://skmtc.dev/officernd/apis/community-api.md) - [All operations](https://skmtc.dev/officernd/apis/community-api/llms.txt) - [OpenAPI document](https://skmtc.dev/officernd/apis/community-api/revisions/dad1b7912165?raw)