Pre-release — content may change.

Memberships

List organization memberships

GET
/organization_memberships

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.

filter?

Filter predicates on organization-membership attributes. Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.

Common predicates by attribute type:

  • String / text / uuid: eq, not_eq, cont, not_cont, matches, start, end, present, blank, null, not_null, in, not_in
  • Integer / decimal / date / datetime: eq, not_eq, gt, gteq, lt, lteq, present, blank, null, not_null, in, not_in
  • Boolean: eq, not_eq, present, blank, null, not_null

_in / _not_in accept comma-separated values or repeated keys.

The reserved key filter[with_deleted]=true includes soft-deleted entries (requires elevated permission).

Example: ?filter[ends_at_gteq]=2026-01-01

fields[organization_memberships]?array<>

Sparse-fieldset selection.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/organization_memberships"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "organization_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,        "max_assignments": 0,        "active_assignments_count": 0,        "unlimited_assignments": 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",        "is_cascadeable": true,        "cascade_type": "string",        "cascadeable_resource_types": [          "string"        ],        "membership_category": "string"      },      "relationships": {        "membership": {          "data": {            "type": "memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/membership",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/membership"          }        },        "organization": {          "data": {            "type": "organizations",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/organization",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/organization"          }        },        "fusebill_subscription": {          "data": {            "type": "fusebill_subscriptions",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/fusebill_subscription",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/fusebill_subscription"          }        },        "owner": {          "data": {            "type": "people",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/owner",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/owner"          }        },        "previous_membership_entry": {          "data": {            "type": "organization_memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/previous_membership_entry",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/previous_membership_entry"          }        },        "next_membership_entry": {          "data": {            "type": "organization_memberships",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/next_membership_entry",            "related": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e/next_membership_entry"          }        }      },      "links": {        "self": "/organization_memberships/7247ad7d-9275-454b-9e3a-0570e403739e"      }    }  ],  "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"      }    }  ]}