Get a list of memberships

get

https://app.officernd.com/api/v2/organizations/{orgSlug}/memberships

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

Required scopes: flex.community.memberships.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

Filter by membership id. Supports single id (e.g. id=xxx) or multiple (e.g. id[$in]=id1,id2).

company

string

Filter by company id.

member

string

Filter by member id.

calculatedStatus

string

enum

Filter by the calculated status of the membership (e.g. active, expired, not_started, not_approved).

Allowed:

location

string

Filter by location id.

plan

string

Filter by plan id. Supports single id (e.g. plan=xxx) or multiple (e.g. plan[$in]=id1,id2).

modifiedAt

string

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAt

string

Support date comparison filters: $gt, $gte, $lt, $lte

properties

string

Filter by custom properties. Uses deepObject style in query. Only string values are supported.

$select

string

Select fields to return

$cursorNext

string

$cursorPrev

string

$limit

number

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200