Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Membership Hold Reason

Search Membership Hold Reasons

Search a list of Membership Hold Reasons.

get/memberships/holds/reasons/search

Query parameters

qstring required

Search query. See the Search section for guidance on how to build a query.

sortstring

Specifies the order in which the list will be returned. Default order is ascending. Default sort attribute is Id. Specify desc_ to sort descending format: "sort=desc_snake_cased_attribute_name" OR "sort=snake_cased_attribute_name" ex. sort=desc_updated_on

pageinteger

Specifies the page of records to be returned. Defaults to 1.

page_sizeinteger

Number of records to return per page. Maximum and default are 100 records.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

membership hold reasons

Example response

{
  "hold_reasons": [
    {
      "created": {
        "created_by_id": 1234567891234567,
        "created_on_datetime": "2014-12-31T23:59:59.938Z"
      },
      "updated": {
        "updated_by_id": 1234567891234567,
        "updated_on_datetime": "2014-12-31T23:59:59.938Z"
      }
    }
  ]
}