GET
/
v5
/
app
/
memberships
curl --request GET \
  --url https://{defaultHost}/v5/app/memberships \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "user_id": "<string>",
      "plan_id": "<string>",
      "page_id": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "renewal_period_start": 123,
      "renewal_period_end": 123,
      "quantity": 123,
      "status": "trialing",
      "valid": true,
      "cancel_at_period_end": true,
      "license_key": "<string>",
      "metadata": {},
      "checkout_id": "<string>",
      "affiliate_username": "<string>",
      "manage_url": "<string>",
      "company_buyer_id": 123,
      "marketplace": true,
      "custom_field_responses": [
        {
          "id": "<string>",
          "created_at": 123,
          "updated_at": 123,
          "question": "<string>",
          "answer": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
company_id
string

An ID of a company to filter by, which will look like biz_*************

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
user_id
string

An ID of a user to filter by, which will look like user_*************

​
experience_id
string

An ID of an experience to filter by, which will look like exp_*************

​
license_key
string

A license key to filter by.

​
statuses
enum<string>[]

An array of statuses to filter by.

​
valid
boolean
default:true

A boolean to filter by valid memberships

​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

memberships retrieved

The response is of type object.