Organization

List organizations

Returns a paginated or slim list of organizations with optional filtering by type, contract status, and more

get/api/organization

Request

Query parameters

per_pageinteger
order_bystring
orderstring
namestring
typesstring
contract_statusesstring
contract_payment_typesstring
contract_auto_renewstring
sales_accountstring
account_managerstring
{
  "order_by": "name,types,contract_statuses,contract_payment_types,sales_account,account_manager,contract_onboarding_date,contract_start_date,contract_end_date,contract_auto_renew,properties_count,agencies_count,companies_count,users_count",
  "order": "asc",
  "name": "John",
  "types": "1,2,3",
  "contract_statuses": "1,2,3",
  "contract_payment_types": "1,2,3",
  "contract_auto_renew": "0,1",
  "sales_account": "John",
  "account_manager": "John"
}

Response

A list of organizations with some relations.

Changes

No recorded changes to this operation across all 2 revisions of this API.