Pre-release — content may change.

Memberships

Query person memberships

POST
/person_memberships/query

Identical to GET /person_memberships but accepts the filter set as a JSON request body instead of query-string parameters. Returns the same paginated index shape.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

include?string

Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.

sort?string

Comma-separated list of attributes to sort by. Prefix with - for descending order (-created_at,family_name).

page?

Offset pagination parameters.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Filter predicates on person-membership attributes, keyed the same way as the filter query parameter on GET /person_memberships (e.g. { "filter": { "ends_at_gteq": "2026-01-01" } }).

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/person_memberships/query" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "person_memberships",      "attributes": {        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",        "starts_at": "2019-08-24T14:15:22Z",        "ends_at": "2019-08-24T14:15:22Z",        "expires_at": "2019-08-24T14:15:22Z",        "grace_period_days": 0,        "in_grace": true,        "status": "string",        "active": true,        "data": {},        "external_id": "string",        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "deleted_at": "2019-08-24T14:15:22Z",        "membership_category": "string"      },      "relationships": {        "membership": {          "data": {            "type": "memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/membership",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/membership"          }        },        "person": {          "data": {            "type": "people",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/person",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/person"          }        },        "organization_membership": {          "data": {            "type": "organization_memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/organization_membership",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/organization_membership"          }        },        "membership_bundle": {          "data": {            "type": "membership_bundles",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/membership_bundle",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/membership_bundle"          }        },        "fusebill_subscription": {          "data": {            "type": "fusebill_subscriptions",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/fusebill_subscription",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/fusebill_subscription"          }        },        "previous_membership_entry": {          "data": {            "type": "person_memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/previous_membership_entry",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/previous_membership_entry"          }        },        "next_membership_entry": {          "data": {            "type": "person_memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/next_membership_entry",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/next_membership_entry"          }        },        "member_history": {          "data": {            "type": "person_member_histories",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/member_history",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/member_history"          }        },        "category_member_history": {          "data": {            "type": "person_member_histories",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/category_member_history",            "related": "/person_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/category_member_history"          }        }      }    }  ],  "meta": {    "page": {      "total_items": 0,      "total_pages": 0,      "number": 0,      "size": 0    }  }}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}
{  "errors": [    {      "status": 0,      "title": "string",      "source": {        "pointer": "string",        "parameter": "string"      },      "meta": {        "error": "string",        "field": "string"      }    }  ]}