Query Org
Retrieve a list of Orgs with a complex or simple query.
Body
Multiple query options are supported. You can build a complex query filling out the advancedFilter
section. We also support "simple" queries which used by putting the key you want to filter by in the query
section along with the value you want it to filter for. E.g., nameFirst=John
will return all persons with a first name of John.
Complex filter configuration allowing for multiple conditions with AND/OR operators.
Set to true
to merge requested fields with default response, or false/omit to return only requested fields plus ID
.
Page number for pagination.
Number of items per page. Defaults to 500.
Array of field names to return in the response.
Field name to sort by.
Sort direction: ascending (asc) or descending (desc).
asc
, desc
Additional key-value pairs for simple filtering. Any field from the entity can be used as a filter key. E.g., field=value
will return all records where that field matches the specified value.
Response
Represents the municipality where the organization is located.
Represents the city and state where the organization is located.
Stores the URL of the organization's logo obtained from Clearbit.
Stores the electronic mail address associated with the organization.
Stores the facsimile contact number for the organization.
Identifies the specific fee schedule associated with an organization.
Unique identifier.
Indicates whether the organization is a tenant or not.
Name of org.
Identifies the unique identifier of the parent organization in the Org table.
Stores the contact number for the organization.
Represents the geographical region within a country where the organization is located.
Main street address associated with the organization.
Contains additional address information such as apartment or suite number for the organization.
Stores the postal code for the organization's location.