← Tools Reference

Breeze

Breeze integration (Productivity, Communication). Imported from open-connector.

API key5 toolshttps://{subdomain}.breezechms.com
GET
breeze_list_people
List people from Breeze with optional details, pagination, and filter_json criteria.

/people

5 parameters
ParamTypeRequiredDescription
subdomainstringoptionalBreeze church subdomain without the .breezechms.com suffix.
detailsbooleanoptionalWhether to request the full Breeze person details payload.
limitintegeroptionalMaximum number of Breeze people to return. Use 0 to request all records.
offsetintegeroptionalNumber of Breeze people to skip before returning results.
filter_jsonobjectoptionalBreeze filter_json object keyed by official Breeze profile field or filter name…
GET
breeze_get_person
Get one Breeze person by Breeze person ID.

/people/{personId}

4 parameters
ParamTypeRequiredDescription
subdomainstringoptionalBreeze church subdomain without the .breezechms.com suffix.
person_idintegerrequiredBreeze person identifier to read.
detailsbooleanoptionalWhether to request the full Breeze person details payload.
personIdstringrequiredPath parameter: personId
GET
breeze_list_profile_fields
List Breeze profile sections and fields used to construct Breeze people filters.

/profile

1 parameter
ParamTypeRequiredDescription
subdomainstringoptionalBreeze church subdomain without the .breezechms.com suffix.
GET
breeze_list_tags
List Breeze tags, optionally narrowed to one Breeze tag folder.

/tags/list_tags

2 parameters
ParamTypeRequiredDescription
subdomainstringoptionalBreeze church subdomain without the .breezechms.com suffix.
folder_idintegeroptionalBreeze tag folder identifier used to filter tags.
GET
breeze_list_tag_folders
List Breeze tag folders.

/tags/list_folders

1 parameter
ParamTypeRequiredDescription
subdomainstringoptionalBreeze church subdomain without the .breezechms.com suffix.