Breeze API

Reference Guide

Getting Started

The Breeze API allows you to build custom applications integrated with the Breeze database. If you have a specific need and programming talent, you can build the solution you're looking for using the data you already have in Breeze. You can use any programming language you'd like. If you'd like to use an API wrapper, you'll find some below (disclaimer: API wrappers are not necessarily created or maintained by Breeze).

People

List People

https://yoursubdomain.breezechms.com/api/people

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$people = $breeze->url('https://yoursubdomain.breezechms.com/api/people/');
Gems
Snakes

Example Response

{
    "id":"157857",
    "first_name":"Thomas",
    "last_name":"Anderson",
    "path":"img\/profiles\/generic\/blue.jpg"
},
{
    "id":"157859",
    "first_name":"Kate",
    "last_name":"Austen",
    "path":"img\/profiles\/upload\/2498d7f78s.jpg"
},
{
    ...
}
Show Details

Description

List people from your database.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/people?limit=50&start=51&details=1
Name Description Example Default
details Option to return all information (slower) or just names. 1 = get all information pertaining to person; 0 = only get id and name 1 0
filter_json Option to filter through results based on criteria (tags, status, etc). Refer to profile field response to know values to search for or if you're hard-coding the field ids, watch the URL bar when filtering for people within Breeze's people filter page and use the variables you see listed. {"2000138015":"226-227","835255370":"Male"} None
limit Number of people to return. If 0 or not present, will return all people. 50 0
offset Number of people to skip before beginning to return results. Can be used in conjunction with limit for pagination. 51 0

Show Person

https://yoursubdomain.breezechms.com/api/people/[PERSON_ID]

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/157857');
Gems
Snakes

Example Response

{
    "id":"157857",
    "first_name":"Thomas",
    "last_name":"Anderson",
    "thumb_path":"",
    "path":"img\/profiles\/generic\/blue.jpg",
    "profile_picture":[

    ],
    "details":{
        "street_address":"123 Test Ave",
        "city":"Grandville",
        "state":"MI",
        "zip":"49123",
        "longitude":"",
        "latitude":""
    }
}
Show Details

Description

Retrieve the details for a specific person by their ID.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/people/[PERSON_ID]?details=0
Name Description Example Default
details Option to return all information (slower) or just names. 1 = get all information pertaining to person; 0 = only get id and name 0 1

List Profile Fields

https://yoursubdomain.breezechms.com/api/profile

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$fields = $breeze->url('https://yoursubdomain.breezechms.com/api/profile');
Gems
Snakes

Example Response

{
    "id":"10098",
    "oid":"2749",
    "section_id":"1",
    "name":"Main",
    "column_id":"1",
    "position":"1",
    "profile_id":"537bf5efc8f96",
    "created_on":"2014-05-20 20:40:15",
    "fields":[
{
            "id":"31025",
            "oid":"2749",
            "field_id":"806926751",
            "profile_section_id":"1",
            "field_type":"name",
            "name":"Name",
            "position":"2",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31026",
            "oid":"2749",
            "field_id":"835255370",
            "profile_section_id":"1",
            "field_type":"gender",
            "name":"Gender",
            "position":"3",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31027",
            "oid":"2749",
            "field_id":"1375466967",
            "profile_section_id":"1",
            "field_type":"relationship",
            "name":"Marital Status",
            "position":"4",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31028",
            "oid":"2749",
            "field_id":"2000138015",
            "profile_section_id":"1",
            "field_type":"multiple_choice",
            "name":"Status",
            "position":"5",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[
{
                    "id":"9690",
                    "oid":"2749",
                    "option_id":"225",
                    "profile_field_id":"2000138015",
                    "name":"Member",
                    "position":"6",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                },
{
                    "id":"9691",
                    "oid":"2749",
                    "option_id":"226",
                    "profile_field_id":"2000138015",
                    "name":"Neighbor",
                    "position":"7",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                }
            ]
        },
{
            "id":"31029",
            "oid":"2749",
            "field_id":"656342607",
            "profile_section_id":"1",
            "field_type":"birthdate",
            "name":"Age",
            "position":"8",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31030",
            "oid":"2749",
            "field_id":"2000138028",
            "profile_section_id":"1",
            "field_type":"multiple_choice",
            "name":"Resturaunt",
            "position":"9",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[
{
                    "id":"9692",
                    "oid":"2749",
                    "option_id":"240",
                    "profile_field_id":"2000138028",
                    "name":"Bob Evans",
                    "position":"10",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                },
{
                    "id":"9693",
                    "oid":"2749",
                    "option_id":"241",
                    "profile_field_id":"2000138028",
                    "name":"Dennys",
                    "position":"11",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                },
{
                    "id":"9694",
                    "oid":"2749",
                    "option_id":"242",
                    "profile_field_id":"2000138028",
                    "name":"Perkins",
                    "position":"12",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                }
            ]
        }
    ]
},
{
    "id":"10099",
    "oid":"2749",
    "section_id":"2",
    "name":"Family",
    "column_id":"1",
    "position":"13",
    "profile_id":"537bf5efc8f96",
    "created_on":"2014-05-20 20:40:15",
    "fields":[
{
            "id":"31031",
            "oid":"2749",
            "field_id":"1594149090",
            "profile_section_id":"2",
            "field_type":"family",
            "name":"Family",
            "position":"14",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        }
    ]
},
{
    "id":"10100",
    "oid":"2749",
    "section_id":"35",
    "name":"Dates",
    "column_id":"1",
    "position":"15",
    "profile_id":"537bf5efc8f96",
    "created_on":"2014-05-20 20:40:15",
    "fields":[
{
            "id":"31032",
            "oid":"2749",
            "field_id":"2000138012",
            "profile_section_id":"35",
            "field_type":"date",
            "name":"Baptized On",
            "position":"16",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31033",
            "oid":"2749",
            "field_id":"2000138013",
            "profile_section_id":"35",
            "field_type":"date",
            "name":"Prof of Faith On",
            "position":"17",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        }
    ]
},
{
    "id":"10101",
    "oid":"2749",
    "section_id":"3",
    "name":"Education & Work",
    "column_id":"2",
    "position":"18",
    "profile_id":"537bf5efc8f96",
    "created_on":"2014-05-20 20:40:15",
    "fields":[
{
            "id":"31034",
            "oid":"2749",
            "field_id":"1334056438",
            "profile_section_id":"3",
            "field_type":"school",
            "name":"School",
            "position":"19",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31035",
            "oid":"2749",
            "field_id":"1394542945",
            "profile_section_id":"3",
            "field_type":"grade",
            "name":"Grade",
            "position":"20",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31036",
            "oid":"2749",
            "field_id":"2000137780",
            "profile_section_id":"3",
            "field_type":"employer",
            "name":"Employer",
            "position":"21",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        }
    ]
},
{
    "id":"10102",
    "oid":"2749",
    "section_id":"4",
    "name":"Contact",
    "column_id":"2",
    "position":"22",
    "profile_id":"537bf5efc8f96",
    "created_on":"2014-05-20 20:40:15",
    "fields":[
{
            "id":"31037",
            "oid":"2749",
            "field_id":"1148898687",
            "profile_section_id":"4",
            "field_type":"phone",
            "name":"Phone",
            "position":"23",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31038",
            "oid":"2749",
            "field_id":"1173210860",
            "profile_section_id":"4",
            "field_type":"campus",
            "name":"Campus",
            "position":"24",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[
{
                    "id":"9695",
                    "oid":"2749",
                    "option_id":"1",
                    "profile_field_id":"1173210860",
                    "name":"North",
                    "position":"25",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                },
{
                    "id":"9696",
                    "oid":"2749",
                    "option_id":"2",
                    "profile_field_id":"1173210860",
                    "name":"Central",
                    "position":"26",
                    "profile_id":"537bf5efc8f96",
                    "created_on":"2014-05-20 20:40:15"
                }
            ]
        },
{
            "id":"31039",
            "oid":"2749",
            "field_id":"1508481877",
            "profile_section_id":"4",
            "field_type":"email",
            "name":"Email",
            "position":"27",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        },
{
            "id":"31040",
            "oid":"2749",
            "field_id":"1537527569",
            "profile_section_id":"4",
            "field_type":"address",
            "name":"Address",
            "position":"28",
            "profile_id":"537bf5efc8f96",
            "created_on":"2014-05-20 20:40:15",
            "options":[

            ]
        }
    ]
}

Add Person

https://yoursubdomain.breezechms.com/api/people/add

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/add?first=Jiminy&last=Cricket');
Gems
Snakes

Example Response

[
{
        "id":"12345678",
        "first_name":"Jiminy",
        "force_first_name":"Jiminy",
        "last_name":"Cricket",
        "thumb_path":"",
        "path":"img\/profiles\/generic\/gray.png",
        "profile_picture":[

        ],
        "street_address":null,
        "city":null,
        "state":null,
        "zip":null,
        "details":{
            "person_id":12345678
        },
        "family":[

        ]
    }
]
Show Details

Description

Add a new person.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/people/add?first_name=Jiminy&last_name=Cricket
Name Description Example Default
first The first name of the person. Jack
Christina
Jorge
-
last The last name of the person Anderson
Smith
Brown
-
fields_json Additional fields to update. See Update Person for eligible values. -

Update Person

https://yoursubdomain.breezechms.com/api/people/update

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');

// See parameters for all available options
$field = new stdClass();
$field->field_id = "123456789";
$field->field_type = "text";
$field->response = "Testing";
$fields[] = $field;

$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/update?person_id=12345678&fields_json='.json_encode($fields));
Gems
Snakes

Example Response

[
{
        "id":"12345678",
        "first_name":"Jiminy",
        "force_first_name":"Jiminy",
        "last_name":"Cricket",
        "thumb_path":"",
        "path":"img\/profiles\/generic\/gray.png",
        "profile_picture":[

        ],
        "street_address":null,
        "city":null,
        "state":null,
        "zip":null,
        "details":{
            "person_id":12345678
        },
        "family":[

        ]
    }
]
Show Details

Description

Update a person.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/people/update?person_id=12345678&fields_json=[json_string]
Name Description Example Default
person_id The id of the person to update. 15235634
58234234
2485234
-
fields_json Additional fields to update. These fields are passed as a JSON encoded array of fields, each containing a field id, field type, response, and in some cases, more information. The field information itself can be found on List Profile Fields. Code samples are below for the fields that can be updated.
// TEXT
$field = new stdClass();
$field->field_id = "2000138875"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "text";
$field->response = "Testing";
$fields[] = $field;

// MULTIPLE CHOICE
$field = new stdClass();
$field->field_id = "2000138811"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "radio"; // multiple choice uses 'radio' field type
$field->response = "459"; // option id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$fields[] = $field;

// DROPDOWN
$field = new stdClass();
$field->field_id = "2000138746"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "radio"; // dropdown uses 'radio' field type
$field->response = "428"; // option id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$fields[] = $field;

// CHECKBOX
$field = new stdClass();
$field->field_id = "2000138325"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "checkbox";
$field->response = '388'; // option id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$fields[] = $field; // add $field to $fields array

// CHECKBOX (same field, new value)
$field = new stdClass();
$field->field_id = "2000138325"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "checkbox";
$field->response = '390'; // option id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$fields[] = $field; // add $field to $fields array

// DATE
$field = new stdClass();
$field->field_id = "2000138050"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "date";
$field->response = '12/1/2015';
$fields[] = $field; // add $field to $fields array

// TEXTAREA
$field = new stdClass();
$field->field_id = "2000138883"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "textarea ";
$field->response = 'A test here';
$fields[] = $field; // add $field to $fields array

// BIRTHDATE
$field = new stdClass();
$field->field_id = "656342607"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "birthdate";
$field->response = '1/1/2015';
$fields[] = $field; // add $field to $fields array

// EMAIL
$field = new stdClass();
$field->field_id = "1508481877"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "email";
$field->response = true;
$email = new stdClass();
$email->address = 'email@test.com';
$field->details = $email;
$fields[] = $field; // add $field to $fields array

// MOBILE PHONE
$field = new stdClass();
$field->field_id = "1148898687"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "phone";
$field->response = true;
$phone = new stdClass();
$phone->phone_mobile = "111-111-1111";
$field->details = $phone;
$fields[] = $field; // add $field to $fields array

// HOME PHONE
$field = new stdClass();
$field->field_id = "1148898687"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "phone";
$field->response = true;
$phone = new stdClass();
$phone->phone_home = "222-222-2222";
$field->details = $phone;
$fields[] = $field; // add $field to $fields array

// WORK PHONE
$field = new stdClass();
$field->field_id = "1148898687"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "phone";
$field->response = true;
$phone = new stdClass();
$phone->phone_work = "333-333-3333";
$field->details = $phone;
$fields[] = $field; // add $field to $fields array

// ADDRESS
$field = new stdClass();
$field->field_id = "1537527569"; // field id (obtainable from https://www.breezechms.com/api#list_profile_fields)
$field->field_type = "address";
$field->response = true;
$address = new stdClass();
$address->street_address = "123 Test St.";
$address->city = "Grand Rapids";
$address->state = "MI";
$address->zip = "49506";
$field->details = $address;
$fields[] = $field; // add $field to $fields array

// UPDATE PERSON
$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/update?person_id=12345678&fields_json='.json_encode($fields));

Delete Person

https://yoursubdomain.breezechms.com/api/people/delete

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/delete?person_id=12345678');
Gems
Snakes

Example Response

true

Show Details

Description

Delete a person.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/people/delete?person_id=12345678
Name Description Example Default
person_id The id of the person to delete. Jack
Christina
Jorge
-

Tags

List Tags

https://yoursubdomain.breezechms.com/api/tags/list_tags

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/list_tags');
Gems
Snakes

Example Response

[
{
        "id":"523928",
        "name":"4th & 5th",
        "created_on":"2013-09-10 09:19:40",
        "folder_id":"1539"
    },
{
        "id":"51994",
        "name":"6th Grade",
        "created_on":"2015-02-06 06:40:40",
        "folder_id":"1539"
    },
{
        "id":"332546",
        "name":"Andrews Group",
        "created_on":"2013-09-10 09:19:40",
        "folder_id":"1538"
    }
]
Show Details

Description

List people from your database.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/tags/list_tags?folder_id=123456
Name Description Example Default
folder_id Numeric ID of a folder. If provided, only tags within that folder will be returned. 123456 -

List Folders

https://yoursubdomain.breezechms.com/api/tags/list_folders

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$folders = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/list_folders');
Gems
Snakes

Example Response

[
{
        "id":"1234567",
        "parent_id":"0",
        "name":"All Tags",
        "created_on":"2015-06-05 18:12:34"
    },
{
        "id":"8234253",
        "parent_id":"120425",
        "name":"Kids",
        "created_on":"2015-06-05 18:12:10"
    },
{
        "id":"1537253",
        "parent_id":"5923042",
        "name":"Small Groups",
        "created_on":"2013-09-10 09:19:40"
    },
{
        "id":"20033",
        "parent_id":"20031",
        "name":"Student Ministries",
        "created_on":"2014-12-15 18:11:31"
    }
]

List People

https://yoursubdomain.breezechms.com/api/people

To view people within a certain tag or tags, use the list people API with the appropriate parameters. An example has been provided below.

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$filter['tag_contains'] = 'y_16681';
$filter_json = json_encode($filter);
$people = $breeze->url("https://yoursubdomain.breezechms.com/api/people/?filter_json=$filter_json");
Gems
Snakes

Example Response

{
    "id":"157857",
    "first_name":"Thomas",
    "last_name":"Anderson",
    "path":"img\/profiles\/generic\/blue.jpg"
},
{
    "id":"157859",
    "first_name":"Kate",
    "last_name":"Austen",
    "path":"img\/profiles\/upload\/2498d7f78s.jpg"
},
{
    ...
}

Add Tag

https://yoursubdomain.breezechms.com/api/tags/add_tag

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/add_tag?name=Students');
Gems
Snakes

Example Response

[
{
        "id":"523928",
        "name":"Students",
        "created_on":"2017-09-10 09:19:40",
        "folder_id":"4912"
    }
]
Show Details

Description

Add a new tag.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/tags/add_tag?name=Students&folder_id=12345
Name Description Example Default
name The name of the tag. Students
Small Groups
Elders
-
folder_id The specific folder to place the tag can be specified. If omitted, the tag will be placed in the top level folder. 12345
1521
12314
Top Level

Add Folder

https://yoursubdomain.breezechms.com/api/tags/add_tag_folder

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/add_tag_folder?name=Youth Group');
Gems
Snakes

Example Response

[
{
        "id":"1234567",
        "parent_id":"1240",
        "name":"Youth Group",
        "created_on":"2017-06-05 18:12:34"
    }
]
Show Details

Description

Add a new tag folder.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/tags/add_tag?name=Youth Group&parent_id=76543
Name Description Example Default
name The name of the folder. Youth Group
Adult Ministries
Leadership
-
parent_id The specific parent folder to place this folder within. If omitted, the folder will be placed on the top level. 5023
1521
7192
Top Level

Delete Tag

https://yoursubdomain.breezechms.com/api/tags/delete_tag

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/delete_tag?tag_id=41231');
Gems
Snakes

Example Response

true

Delete Folder

https://yoursubdomain.breezechms.com/api/tags/delete_tag_folder

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/delete_tag_folder?folder_id=12345');
Gems
Snakes

Example Response

true

Assign

https://yoursubdomain.breezechms.com/api/tags/assign

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/assign?person_id=12345&tag_id=45678');
Gems
Snakes

Example Response

true
Show Details

Description

Assign a tag to a person

Arguments

e.g. https://yoursubdomain.breezechms.com/api/tags/assign?person_id=12345&tag_id=45678
Name Description Example Default
person_id The id of the person to which tag should be assigned to. 12498124
82395235
121821493
-
tag_id The id of the tag that should be assigned 523523
234534
623523
-

Unassign

https://yoursubdomain.breezechms.com/api/tags/unassign

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/tags/unassign?person_id=12345&tag_id=45678');
Gems
Snakes

Example Response

true
Show Details

Description

Assign a tag to a person

Arguments

e.g. https://yoursubdomain.breezechms.com/api/tags/unassign?person_id=12345&tag_id=45678
Name Description Example Default
person_id The id of the person to which tag should be unassigned from. 12498124
82395235
121821493
-
tag_id The id of the tag that should be unassigned 523523
234534
623523
-

Events

List Events

https://yoursubdomain.breezechms.com/api/events

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$events = $breeze->url('https://yoursubdomain.breezechms.com/api/events?start=3-1-2014&end=3-7-2014');
Gems
Snakes

Example Response

{
    "id":"40984",
    "oid":"2749",
    "event_id":"736",
    "name":"Jr High Youth Group",
    "category_id":"0",
    "settings_id":"0",
    "start_datetime":"2014-03-05 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2013-09-09 23:09:08"
},
{
    "id":"56104",
    "oid":"2749",
    "event_id":"949",
    "name":"Elementary Class1",
    "category_id":"1553",
    "settings_id":"0",
    "start_datetime":"2014-03-02 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2013-10-25 14:33:06"
},
{
    "id":"68124",
    "oid":"2749",
    "event_id":"1830",
    "name":"Sunday AM",
    "category_id":"1553",
    "settings_id":"0",
    "start_datetime":"2014-03-02 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2013-11-25 17:30:25"
},
{
    "id":"71429",
    "oid":"2749",
    "event_id":"2056",
    "name":"Men's Bible Study",
    "category_id":"7232",
    "settings_id":"0",
    "start_datetime":"2014-03-04 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2013-12-03 09:25:58"
},
{
    "id":"125540",
    "oid":"2749",
    "event_id":"4377",
    "name":"Small Group Check In",
    "category_id":"7232",
    "settings_id":"0",
    "start_datetime":"2014-03-07 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2014-03-06 22:39:12"
},
{
    "id":"125538",
    "oid":"2749",
    "event_id":"4375",
    "name":"Group Test",
    "category_id":"7232",
    "settings_id":"0",
    "start_datetime":"2014-03-07 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2014-03-06 22:03:43"
},
{
    "id":"123017",
    "oid":"2749",
    "event_id":"4219",
    "name":"Test",
    "category_id":"0",
    "settings_id":"0",
    "start_datetime":"2014-03-05 00:00:00",
    "end_datetime":"0000-00-00 00:00:00",
    "is_modified":"0",
    "created_on":"2014-03-04 22:34:10"
}
Show Details

Description

Retrieve a list of events based on search criteria.
Name Description Example Default
start Events on or after (DD-MM-YYYY) 20-1-2015 The first day of the current month/year
end Events on or before (DD-MM-YYYY) 31-1-2018 The last day of the current month/year
calendar_id If supplied, only events on the specified calendar will be returned. Note that external calendars are not available via this call. If you need to pull in external calendars, we recommend parsing the calendar's ical feed accessible via List Calendars. 14924
912315
63293
n/a
details If set to 1, additional event details will be returned (e.g. description, check in settings, etc) 1
0
0

List Event

https://yoursubdomain.breezechms.com/api/events/list_event

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$events = $breeze->url('https://yoursubdomain.breezechms.com/api/events/list_event?instance_id=123456');
Gems
Snakes

Example Response

{
    "id":"1234567",
    "oid":"1234",
    "event_id":"9876",
    "name":"Youth Group",
    "category_id":"0",
    "settings_id":"0",
    "start_datetime":"2016-06-25 18:00:00",
    "end_datetime":"2016-06-23 20:00:00",
    "is_modified":"0",
    "created_on":"2016-06-23 13:06:16"
}
Show Details

Description

Retrieve a list of events based on search criteria.
Name Description Example Default
instance_id The id of the event instance that should be returned 29034243
92340243
8923424
-
schedule If other instances in the same series should be included. Note that if set to true, response will be an array of events, each element only containing the id and starting timestamp. true
1
-
schedule_direction If including the schedule, should it include events before the instance_id or after the instance_id before
after
before
schedule_limit If including the schedule, how many events in the series should be returned 5
20
50
unlimited
details If set to 1, additional event details will be returned (e.g. description, check in settings, etc) 1
0
0

List Calendars

https://yoursubdomain.breezechms.com/api/events/calendars/list

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$calendars = $breeze->url('https://yoursubdomain.breezechms.com/api/events/calendars/list');
Gems
Snakes

Example Response

[
{
        "id":0,
        "name":"Main",
        "color":"b2cd92",
        "address":"https://yoursubdomain.breezechms.com/events/feed/eXGoxSB6C234ksdfkjf02jfklsdfjklf23lkjsd,fdHT8xFNnsPyXGm3"
    },
{
        "id":"905",
        "oid":"2749",
        "name":"Staff",
        "color":"d1ba39",
        "address":"https://yoursubdomain.breezechms.com/events/feed/kfj032fkdsfkjl23fj9fdsijfkl2fj90fjklsdkfmvndm23k",
        "created_on":"2016-01-20 11:38:18"
    },
{
        "id":"1291",
        "oid":"2749",
        "name":"Students",
        "color":"a773b8",
        "address":"https://yoursubdomain.breezechms.com/events/feed/vs92k3kdfsdkfJFkdfwodlkfweLFKLDF3sdfewklfjweoflkj23ifjlksdfjksdsfkljinsl35jo",
        "created_on":"2016-03-03 08:28:34"
    },
{
        "id":"1283",
        "oid":"2749",
        "name":"Google Calendar",
        "color":"b2cd92",
        "address":"webcal://path/to/external/calendar.ics",
        "created_on":"2016-03-02 14:11:32"
    }
]

List Attendance

https://yoursubdomain.breezechms.com/api/events/attendance/list

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$attendance = $breeze->url('https://yoursubdomain.breezechms.com/api/events/attendance/list?instance_id=12345&details=true');
Gems
Snakes

Example Response

[
{
        "instance_id":"3778451",
        "person_id":"824512",
        "check_out":"0000-00-00 00:00:00",
        "created_on":"2015-12-09 11:01:33",
        "details":{
            "id":"824512",
            "first_name":"Carol",
            "force_first_name":"Carol",
            "last_name":"Adams",
            "thumb_path":"img\/profiles\/upload\/thumbnails\/123456789.jpg",
            "path":"img\/profiles\/upload\/123456789.jpg",
            "profile_picture":[

            ],
            "details":{
                "gender":"Female",
                "birthdate":"2013-12-26",
                "age_years":"1",
                "age_months":"11",
                "age_days":"14",
                "mobile":"123-123-1234",
                "email_primary":"email@address.com",
                "street_address":"123 Test St",
                "city":"Holland",
                "state":"MI",
                "zip":"49424",
                "longitude":"",
                "latitude":""
            }
        }
    },
{
        "instance_id":"3778451",
        "person_id":"981238123",
        "check_out":"0000-00-00 00:00:00",
        "created_on":"2015-12-09 11:01:34",
        "details":{
            "id":"1291272",
            "first_name":"Luther",
            "force_first_name":"Luther",
            "last_name":"Anderson",
            "thumb_path":"",
            "path":"img\/profiles\/generic\/blue.jpg",
            "profile_picture":[

            ],
            "details":{
                "gender":"Male",
                "birthdate":"2001-08-21",
                "age_years":"14",
                "age_months":"3",
                "age_days":"19",
                "school_id":"4743",
                "school":[

                ],
                "graduation_year":"2019",
                "grade_name":"9th",
                "home":"(616) 555-5555",
                "mobile":"(616) 555-5555",
                "work":"555-5555",
                "email_primary":"luther_anderson@breezechms.com",
                "street_address":"450 Fulton Ave SE",
                "city":"Grand Rapids",
                "state":"MI",
                "zip":"49503",
                "longitude":"-85.6581776129543",
                "latitude":"42.9629853284722"
            }
        }
    }
]
Show Details

Description

List attendance from a given event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/events/attendance/list?instance_id=1521321&type=person
Name Description Example Default
instance_id The ID of the instance you'd like to return the attendance for 190152081
25982342
-
details If set to true, details of the person will be included in the response true
false
false
type Determines if result should contain people or anonymous head count by setting to either 'person' or 'anonymous' person
anonymous
person

List Locations

https://yoursubdomain.breezechms.com/api/events/locations

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$locations = $breeze->url('https://yoursubdomain.breezechms.com/api/events/locations');
Gems
Snakes

Example Response

[
{
        "id":"190",
        "name":"Adult Ministries Room"
    },
{
        "id":"188",
        "name":"Auditorium"
    },
{
        "id":"189",
        "name":"Gathering Space"
    },
{
        "id":"850",
        "name":"Room 301"
    },
{
        "id":"187",
        "name":"Student Room"
    }
]

Add Event

https://yoursubdomain.breezechms.com/api/events/add

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/events/add?name=Bonfire&starts_on=1467161100');
Gems
Snakes

Example Response

[
{
        "id":"8324092",
        "oid":"1234",
        "event_id":"4567",
        "name":"Bonfire",
        "category_id":"0",
        "start_datetime":"2016-06-28 19:45:00",
        "end_datetime":"2016-06-23 20:45:00",
        "created_on":"2016-06-23 15:40:06"
    }
]
Show Details

Description

Add a new event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/events/add?name=Bonfire&starts_on=1467161100
Name Description Example Default
name The name of the event. Bonfire
Service
Small Group
-
starts_on The numeric timestamp for when the event should start (more details on this format can be found here). 1467161100
1466711372
1498247371
-
ends_on The numeric timestamp for when the event should end (more details on this format can be found here). 1467161100
1466711372
1498247371
One hour after starts_on
all_day If set, event will be all day and only the date from starts_on will be used, time will be ignored. 1
0
0
description The description of the event. HTML can be used. Come to this event wearing a windsuit! -
calendar_id The id of the calendar this event should be placed on 1234
2344
0
event_id The id of an existing event for this event to be in the same series with 1251
2923
New series

Delete Event

https://yoursubdomain.breezechms.com/api/events/delete

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$tags = $breeze->url('https://yoursubdomain.breezechms.com/api/events/delete?instance_id=12345');
Gems
Snakes

Example Response

true

Show Details

Description

Delete an Event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/events/delete?instance_id=12345
Name Description Example Default
instance_id The id of the instance that should be deleted. 235324
8543239
82539230
-

Add Attendance Record

https://yoursubdomain.breezechms.com/api/events/attendance/add

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$add = $breeze->url('https://yoursubdomain.breezechms.com/api/events/attendance/add?person_id=1234567&instance_id=7654321');
Gems
Snakes

Example Response

true

Remove Attendance Record

https://yoursubdomain.breezechms.com/api/events/attendance/delete

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$remove = $breeze->url('https://yoursubdomain.breezechms.com/api/events/attendance/delete?person_id=1234567&instance_id=7654321');
Gems
Snakes

Example Response

true

Contributions

List Contributions

https://yoursubdomain.breezechms.com/api/giving/list

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$contributions = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/list?start=2015-1-15&end=2015-6-15');
Gems
Snakes

Under Development

{
    "id":"378477",
    "paid_on":"2014-03-05 00:00:00",
    "num":"144",
    "created_on":"2015-06-05 21:37:50",
    "method":"check",
    "method_id":"41",
    "amount":"32.00",
    "note":"",
    "person_id":"157823",
    "first_name":"Frodo",
    "last_name":"Baggins",
    "envelope_number":"105",
    "meta":null,
    "funds":[
{
            "id":"19399",
            "oid":"2749",
            "payment_id":"378477",
            "fund_id":"28",
            "amount":"32.00",
            "created_on":"2014-02-25 08:04:36",
            "fund_name":"General Fund",
            "tax_deductible":"1"
        }
    ]
},
{
    "id":"376786",
    "paid_on":"2014-05-06 00:00:00",
    "num":"143",
    "created_on":"2015-06-05 21:37:54",
    "method":"check",
    "method_id":"41",
    "amount":"75.00",
    "note":"",
    "person_id":"157828",
    "first_name":"Andy",
    "last_name":"Bernard",
    "envelope_number":"106",
    "meta":null,
    "funds":[
{
            "id":"17708",
            "oid":"2749",
            "payment_id":"376786",
            "fund_id":"28",
            "amount":"75.00",
            "created_on":"2014-02-24 06:25:38",
            "fund_name":"General Fund",
            "tax_deductible":"1"
        }
    ]
},
{
    "id":"376785",
    "paid_on":"2014-03-07 00:00:00",
    "num":"143",
    "created_on":"2015-06-05 21:37:54",
    "method":"check",
    "method_id":"41",
    "amount":"78.00",
    "note":"",
    "person_id":"254576",
    "first_name":"Mickey",
    "last_name":"Mouse",
    "envelope_number":null,
    "meta":null,
    "funds":[
{
            "id":"17707",
            "oid":"2749",
            "payment_id":"376785",
            "fund_id":"28",
            "amount":"78.00",
            "created_on":"2014-02-24 06:25:20",
            "fund_name":"General Fund",
            "tax_deductible":"1"
        }
    ]
}
Show Details

Description

Retrieve a list of contributions based on search criteria.
Name Description Example Default
start Contributions on or after (DD-MM-YYYY) 20-1-2015 n/a
end Contributions on or before (DD-MM-YYYY) 31-1-2018 n/a
person_id ID of person's contributions to fetch 9023482 n/a
include_family Include family members of person_id (must have person_id populated to take effect) 1
0
0
amount_min Amount is equal or greater than 1
2000.00
5.00
n/a
amount_max Amount is equal or less than 15
40.00
2
n/a
method_ids Method IDs. Multiple ids separated by a dash (-) 234-236-237
234
n/a
fund_ids Fund IDs. Multiple ids separated by a dash (-) 9234-9235-9238
9234
n/a
envelope_number Envelope number 101
125
n/a
batches Batch numbers. Multiple numbers separated by a dash (-) 101-102-103
101
n/a
forms Form IDs. Multiple ids separated by a dash (-) 7890-7891
7890
n/a
pledge_ids Pledge Campaign IDs. IDs accessible from list pledges query. Multiple ids separated by a dash (-) 7890-7891
7890
n/a

Add Contribution

https://yoursubdomain.breezechms.com/api/giving/add

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');

$response = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/add?date=31-5-2015&person_id=&person_json={"name":"John Doe","email":"john_doe@example.com","street_address":"42 Wallaby Way"}&uid=29348292423&processor=Penguin Payments&method=Check&funds_json=[{"name":"General Fund","amount":"100.00"}]&amount=100.00&group=&batch_number=100&batch_name=API Test&note=Confirmation: 10023142');

Gems
Snakes

Example Response

{
    "success":true,
    "errors":null,
    "payment_id":1320278
}
Show Details

Description

Add a contribution to Breeze
Name Description Examples
date DD-MM-YYYY 24-5-2017
person_id The Breeze ID of the donor. If unknown, use person_json or UID instead of person id 1234567
person_json A json object containing person's information. Breeze uses this data to match the donation with the donor's Breeze profile (if no person_id present). If name and email or name and street_address match, the association will be automatically assigned.

The additional information (city, state, gender, phones, etc) allows the API to create a profile with more complete information if no match is found. (Note: The API does not yet create this profile; this is for a future update - we plan on letting churches decide if new profiles should be created for unmatched donations)
{
  "name": "Captain Crunch",
  "email": "ccrunch@test.com",
  "street_address": "123 Test St",
  "city": "Grand Rapids",
  "state": "MI",
  "postal": "49506",
  "gender": "male",
  "home_phone": "555-555-5555",
  "mobile_phone": "555-555-5555",
  "work_phone": "555-555-5555",
  "birthdate": "1995-10-25"
}
uid The unique id of the person sent from the giving platform. This should be used when the Breeze ID is unknown. Within Breeze a user will be able to associate this ID with a given Breeze ID. In the future this UID will then be automatically matched to the correct profile. 9876543
processor The name of the processor used to send the payment. Used in conjunction with UID. Not needed if using Breeze ID. SimpleGive
BluePay
Stripe
method The method name. "Check"
"Cash"
"Credit/Debit Online"
"Credit/Debit Offline"
"Donated Goods (FMV)"
"Stocks (FMV)"
"Direct Deposit"
funds_json JSON string containing fund names and amounts. This allows split fund giving. The ID is optional. If present, it must match an existing fund ID and it will override the fund name. [{"id":"12345","name":"General Fund","amount":"100.00"},{"name":"Missions Fund","amount":"150.00"}]
amount Total amount given. Must match sum of amount in Funds JSON 250.00
group This will create a new batch and enter all contributions with the same group into the new batch. Previous groups will be remembered and so they should be unique for every new batch. Use this if wanting to import into the next batch number in a series. 235092347
g239kvpx925d
isdkfjfwldfx
batch_number The batch number to import contributions into. Use group instead if you want to import into the next batch number. 100
101
102
batch_name The name of the batch. Can be used with batch number or group. Sunday Giving
API Giving
note An optional note. Can be used for adding a note about the contribution. Missionary Fund: Mary Jones
Confirmation: 10023142

Edit Contribution

https://yoursubdomain.breezechms.com/api/giving/edit

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/edit?payment_id=56789123&date=31-5-2015&name=John Doe&person_id=1234567&uid=&processor=&method=Check&funds_json=[{"name":"General Fund","amount":"100.00"}]&amount=100.00&group=&batch_number=100&batch_name=API Test');
Gems
Snakes

Example Response

{
    "success":true,
    "errors":null,
    "payment_id":1320278
}
Show Details

Description

Edit an existing contribution
Name Description Examples
Payment ID The ID of the payment that should be modified. Note that the returned (modified) contribution will have a new payment ID. 56789123
All Others Same as "Add Contribution". See add contribution fields for details.

Delete Contribution

https://yoursubdomain.breezechms.com/api/giving/delete

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/delete?payment_id=56789123');
Gems
Snakes

Example Response

{
    "success":true,
    "errors":null
}
Show Details

Description

Delete an existing contribution
Name Description Examples
Payment ID The ID of the payment that should be deleted. 56789123

View Contribution

https://yoursubdomain.breezechms.com/api/giving/view

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/view?payment_id=56789123');
Gems
Snakes

Example Response

{
    "success":true,
    "errors":null,
    "payment_id":"1244773",
    "payment":{
        "id":"1244773",
        "oid":"2749",
        "person_id":"523533",
        "amount":"100.00",
        "batch_id":"197430",
        "method":"Check",
        "paid_on":"2015-02-05 00:00:00",
        "note":"Breeze Online Payment (Stripe)",
        "created_on":"2015-02-08 21:31:14",
        "batch_num":"6026",
        "person":[

        ],
        "funds":[

        ],
        "meta":[

        ]
    }
}
Show Details

Description

View an existing contribution
Name Description Examples
Payment ID The ID of the payment to view. 56789123

List Funds

https://yoursubdomain.breezechms.com/api/funds/list

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$funds = $breeze->url('https://yoursubdomain.breezechms.com/api/funds/list');
Gems
Snakes

Example Response

[
{
        "id":"12345",
        "name":"Adult Ministries",
        "tax_deductible":"1",
        "is_default":"0",
        "created_on":"2014-09-10 02:19:35"
    },
{
        "id":"12346",
        "name":"General Fund",
        "tax_deductible":"1",
        "is_default":"1",
        "created_on":"2014-02-04 22:50:01"
    },
{
        "id":"12347",
        "name":"Men's Retreat",
        "tax_deductible":"0",
        "is_default":"0",
        "created_on":"2014-09-10 02:19:35"
    }
]
Show Details

Description

List all funds.
Name Description Examples
include_totals If the total amount given to the fund should be returned or not. 1 is yes, 0 is no. 1
0

Pledges

List Campaigns

https://yoursubdomain.breezechms.com/api/pledges/list_campaigns

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$campaigns = $breeze->url('https://yoursubdomain.breezechms.com/api/pledges/list_campaigns');
Gems
Snakes

Example Response

[
{
        "id":"12731",
        "oid":"2749",
        "name":"Building Campaign",
        "created_on":"2015-08-15 04:41:10",
        "number_of_pledges":65,
        "total_pledged":13030
    },
{
        "id":"253242",
        "oid":"2749",
        "name":"2017 Pledge Campaign",
        "created_on":"2015-07-28 14:14:11",
        "number_of_pledges":143,
        "total_pledged":147532
    }
]

List Pledges

https://yoursubdomain.breezechms.com/api/pledges/list_pledges

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$pledges = $breeze->url('https://yoursubdomain.breezechms.com/api/pledges/list_pledges?campaign_id=12345');
Gems
Snakes

Example Response

[
{
        "id":"12731",
        "oid":"2749",
        "name":"Building Campaign",
        "created_on":"2015-08-15 04:41:10",
        "number_of_pledges":65,
        "total_pledged":13030
    },
{
        "id":"253242",
        "oid":"2749",
        "name":"2017 Pledge Campaign",
        "created_on":"2015-07-28 14:14:11",
        "number_of_pledges":143,
        "total_pledged":147532
    }
]

List Pledged Contributions

To list contributions given to a specific campaign, please see List Contributions using the campaign_ids parameter.

Volunteers

List Volunteers

https://yoursubdomain.breezechms.com/api/volunteers/list

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$volunteers = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/list?instance_id=123456');
Gems
Snakes

Example Response

[
{
        "id":"12345678",
        "oid":"1234",
        "instance_id":"123456",
        "person_id":"3008467",
        "response":"0",
        "comment":"",
        "rsvped_on":"0000-00-00 00:00:00",
        "created_on":"2016-09-06 03:07:32",
        "role_ids":null
    },
{
        "id":"23051231",
        "oid":"2749",
        "instance_id":"123456",
        "person_id":"3349681",
        "response":"0",
        "comment":"",
        "rsvped_on":"0000-00-00 00:00:00",
        "created_on":"2016-09-06 03:07:32",
        "role_ids":[
            "9627",
            "9628"
        ]
    },
{
        "id":"3248759",
        "oid":"2749",
        "instance_id":"123456",
        "person_id":"3248759",
        "response":"0",
        "comment":"",
        "rsvped_on":"0000-00-00 00:00:00",
        "created_on":"2016-09-06 03:26:53",
        "role_ids":null
    }
]
Show Details

Description

List volunteers from a specific event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/list?instance_id=123456
Name Description Example Default
instance_id The id of the event instance you want to list the volunteers for. 123456 -

Add Volunteer

https://yoursubdomain.breezechms.com/api/volunteers/add

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/add?instance_id=123456&person_id=654321');
Gems
Snakes

Example Response

true

Show Details

Description

Schedule a volunteer for a specific event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/add?instance_id=123456&person_id=654321
Name Description Example Default
instance_id The id of the event instance you want to schedule the volunteer for. 123456 -
person_id The id of the person you wish to schedule. 654321 -

Remove Volunteer

https://yoursubdomain.breezechms.com/api/volunteers/remove

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/remove?instance_id=123456&person_id=654321');
Gems
Snakes

Example Response

true

Show Details

Description

Unschedule a volunteer from a specific event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/remove?instance_id=123456&person_id=654321
Name Description Example Default
instance_id The id of the event instance you want to unschedule the volunteer from. 123456 -
person_id The id of the person you wish to unschedule. 654321 -

Update Volunteer

https://yoursubdomain.breezechms.com/api/volunteers/update

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$role_ids_json = json_encode(Array(523, 524));
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/update?instance_id=123456&person_id=5182132&role_ids_json='.$role_ids_json);
Gems
Snakes

Example Response

true

Show Details

Description

Update the volunteer role(s) for a person in a given event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/list?instance_id=123456
Name Description Example Default
instance_id The id of the event instance containing the person you wish to update. 123456 -
person_id The id of the person you wish to update. 9520342 -
role_ids_json The id(s) of the role(s) you wish the person to have. Note that this replaces current values, so if a volunteer currently has a role and this command is run and does not pass in that same role_id, the current role will be removed and replaced with the passed role(s). If excluded, the volunteer will be assigned no role. {563, 564}
empty
-

List Volunteer Roles

https://yoursubdomain.breezechms.com/api/volunteers/list_roles

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$roles = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/list_roles?instance_id=123456');
Gems
Snakes

Example Response

[
{
        "id":"9627",
        "name":"Teacher"
    },
{
        "id":"9628",
        "name":"Greeter"
    },
{
        "id":"9629",
        "name":"Small Group Leader"
    }
]

Show Details

Description

List the volunteer roles for a specific event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/list_roles?instance_id=123456
Name Description Example Default
instance_id The id of the event instance you want to retrieve the volunteer roles for. 123456 -

Add Volunteer Role

https://yoursubdomain.breezechms.com/api/volunteers/add_role

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/add_role?instance_id=123456&name=Teacher');
Gems
Snakes

Example Response

{
    "id":9631,
    "name":"Small Group Leader"
}

Show Details

Description

Add a role to an event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/add_role?instance_id=123456&name=Teacher
Name Description Example Default
instance_id The id of the event instance you want to retrieve the volunteer roles for. Note that if the event is part of a series, the role will become available on all events within the series. 123456 -
name The name of the role you'd like to add. Small Group Leader
Greeter
Usher
-

Remove Volunteer Role

https://yoursubdomain.breezechms.com/api/volunteers/remove_role

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/volunteers/remove_role?instance_id=123456&role_id=567');
Gems
Snakes

Example Response

true

Show Details

Description

Remove a role from an event.

Arguments

e.g. https://yoursubdomain.breezechms.com/api/volunteers/remove_role?instance_id=123456&role_id=567
Name Description Example Default
instance_id The id of the event instance you want to remove the role from. Note that if the event is part of a series, the role will be removed on all events within the series. 123456 -
role_id The id of the role to be removed. 567 -

Account

Account Summary

https://yoursubdomain.breezechms.com/api/account/summary

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');

// get all breeze ids for people updated since 2016-1-25
$summary = $breeze->url('https://yoursubdomain.breezechms.com/api/account/summary');
Gems
Snakes

Example Response

{
    "id":"1234",
    "name":"Grace Church",
    "subdomain":"gracechurchdemo",
    "status":"1",
    "created_on":"2013-09-10 09:19:35",
    "details":{
        "timezone":"America\/New_York",
        "country":{
            "id":"2",
            "name":"United States of America",
            "abbreviation":"USA",
            "abbreviation_2":"US",
            "currency":"USD",
            "currency_symbol":"$",
            "date_format":"MDY",
            "sms_prefix":"1"
        }
    }
}

List Account Log

https://yoursubdomain.breezechms.com/api/account/list_log

Example Request

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');

// get all breeze ids for people updated since 2016-1-25
$logged_actions = $breeze->url('https://yoursubdomain.breezechms.com/api/account/list_log?action=person_updated&start=2016-1-25');
Gems
Snakes

Example Response

[
{
        "id":"112",
        "oid":"123",
        "user_id":"261",
        "action":"person_updated",
        "object_json":"\"5023943\"",
        "created_on":"2016-08-15 04:41:10"
    },
{
        "id":"113",
        "oid":"123",
        "user_id":"261",
        "action":"person_updated",
        "object_json":"\"5023253\"",
        "created_on":"2016-08-15 04:44:25"
    },
{
        "id":"114",
        "oid":"123",
        "user_id":"261",
        "action":"person_updated",
        "object_json":"\"5023129\"",
        "created_on":"2016-08-15 04:49:31"
    }
]
Show Details

Description

Retrieve a list of events based on search criteria.
Name Description Example Default
action A required parameter indicating which type of logged action should be returned. Communications
email_sent
text_sent

Contributions
contribution_added
contribution_updated
contribution_deleted
batch_updated
batch_deleted

Events
event_updated
event_deleted
event_instance_deleted
event_future_deleted
events_calendar_created
events_calendar_updated
events_calendar_deleted
attendance_deleted

People
person_created
person_updated
person_deleted
person_merged
people_updated
bulk_update_people
bulk_people_deleted
bulk_import_people

Tags
tag_created
tag_updated
tag_deleted
tag_folder_created
tag_folder_updated
tag_folder_deleted
tag_bulk_assign
tag_bulk_unassign

Forms
form_created
form_updated
form_deleted
form_entry_updated
form_entry_deleted

Users
user_created
user_updated
user_deleted
-
start The start date range for actions that should be returned. If not provided, logged items will be fetched from as long ago as the log is storing. 2016-10-25
2013-11-15
-
end The end date range for actions that should be returned. If not provided, logged items will be fetched up until the current moment. 2017-04-25
2017-12-17
-
user_id The user_id of the user who made the logged action. If not provided, all users' actions will be returned. 145
420
250
-
details If details about the logged action should be returned. Note that this column is not guaranteed to be standardized and should not be relied upon for anything more than a description. 1
0
0
limit The number of logged items to return. Max is 3,000. 50
1000
500

Examples

Display Person

This example shows how to fetch all profile fields and then, for a given person, iterate through each profile field, outputting the data for that field for that person.

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key');

// get person information
$person_id = 3959584;
$person = $breeze->url('https://yoursubdomain.breezechms.com/api/people/'.$person_id);
$person = json_decode($person);
$person_details = $person->details;

// get all profile fields
$field_sections = $breeze->url('https://yoursubdomain.breezechms.com/api/profile');
$field_sections = json_decode($field_sections);

// output person's name
echo "<h1>" . $person->first_name . " " . $person->last_name . "</h1><hr />";

// for each profile field section
foreach($field_sections as $field_section) {
    
    // include the section name
    echo "<h2>" . $field_section->name . "</h2>";
    
    // for each field in that section
    foreach($field_section->fields as $field) {
     
        // output the field name and ID
        echo "<h4>" . $field->name . " (".$field->field_id.")</h4>";
        
        // and output the person's details for that field
        var_dump($person_details->{$field->field_id});
        
    }
    
}
          
Gems
Snakes

Payment Integration

This example shows a typical integration a third party payment processor might use to store processed payments within Breeze.

require_once('breeze/breeze.php');
$breeze = new Breeze('your_api_key ');

$date = "2017-1-25"; // date gift was given

$processor = "Acme Corp"; // name of 3rd party giving platform

$method = "Check"; // method name; can be any string as if it does not already exist, it will be auto-created

$amount = 100; // full contribution amount

$funds = Array(); // list of funds that the gift is given to (can accept more than one for split fund gifts)

// designate $70 to General Fund
$fund = new stdClass();
$fund->name = "General Fund";
$fund->amount = 70;
$funds[] = $fund;

// designate $30 to Missions Fund
$fund = new stdClass();
$fund->name = "Missions Fund";
$fund->amount = 30;
$funds[] = $fund;

$funds_json = json_encode($funds); // store as json to pass in URL

$group = date('YW'); // all contributions with the same group will be put into the same batch - by creating a group out of the date('YW'), we effectively create a new batch for each week

$batch_name = $processor . " Giving";

// Pass along person's information.  If person is not already matched in Breeze, this will help the Breeze user either create or match the gift with the correct profile
$person = new stdClass();
$person->name = "John Doe";
$person->email = "john.doe@example.com";
$person_json = json_encode($person); // store as json to pass in URL

// A unique ID for the person as defined by the giving platform, not Breeze (i.e. this can be whatever you'd like).  After the Breeze user initially matches this gift, all future gifts with this same unique ID will automatically connect to the correct profile
$uid = "123f3d5g62";

// store payment
$response = $breeze->url('https://yoursubdomain.breezechms.com/api/giving/add?date=' . $date . '&person_json=' . $person_json . '&uid=' . $uid . '&processor=' . $processor . '&method=' . $method . '&funds_json=' . $funds_json . '&amount=' . $amount . '&group=' . $group . '&batch_name=' . $batch_name);
          
Gems
Snakes