Pre-release — content may change.

Memberships

Query organization membership histories

POST
/organization_membership_histories/query

Identical to GET /organization_membership_histories 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 OrganizationMembershipHistory attributes, keyed the same way as the filter query parameter on GET /organization_membership_histories (e.g. { "filter": { "status_eq": "active" } }).

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/organization_membership_histories/query" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": [    {      "type": "organization_membership_histories",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "attributes": {        "category": "string",        "status": "string",        "member_since": "2019-08-24T14:15:22Z",        "current_starts_at": "2019-08-24T14:15:22Z",        "current_ends_at": "2019-08-24T14:15:22Z",        "current_expires_at": "2019-08-24T14:15:22Z",        "latest_created_at": "2019-08-24T14:15:22Z",        "latest_updated_at": "2019-08-24T14:15:22Z",        "continuous_starts_at": "2019-08-24T14:15:22Z",        "continuous_ends_at": "2019-08-24T14:15:22Z",        "max_ends_at": "2019-08-24T14:15:22Z",        "previous_continuous_ends_at": "2019-08-24T14:15:22Z",        "previous_lapsed_duration_days": 0      },      "relationships": {        "organization": {          "data": {            "type": "string",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"          },          "links": {            "self": "../dictionary",            "related": "../dictionary"          }        },        "latest_membership_entries": {          "data": [            {              "type": "string",              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"            }          ],          "links": {            "self": "../dictionary",            "related": "../dictionary"          }        },        "membership_entries": {          "data": [            {              "type": "string",              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"            }          ],          "links": {            "self": "../dictionary",            "related": "../dictionary"          }        }      },      "links": {        "property1": "/organization_membership_histories/7247ad7d-9275-454b-9e3a-0570e403739e",        "property2": "/organization_membership_histories/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"      }    }  ]}