Breezz RestAPI

This is an up-to-date wrapper for the Breezz.io REST API. Initially, we found it quite frustrating working with the API - hopefully this wrapper will make everything easier for you.

Find more information about the Breezz REST API at http://breezz.io/Support

Please email support@breezz.io if you find any bugs.

Index

• Create
• Update
• Delete
• Query

Authentication

To make a REST API call, you must include request headers including the Authorization header ==> Find your TOKENID

Create

URL:

https://app.breezz.io/api/record/{ObjectID}

Method:

POST

Json exemple:

{
 "accountname" : "jhon",
 "telephone1" : "+4406339060",
 "idnumber" : "123456",
 "billingcity" : "London"
}

More exemple in PHP | python | ASP.NET |

Update

URL:

https://app.breezz.io/api/record/{ObjectID}/{id}

Method:

PUT

Json exemple:

{
 "accountname" : "jhon",
 "telephone1" : "+4406339060",
 "idnumber" : "123456",
 "billingcity" : "London"
}

More exemple in PHP | python | ASP.NET |

Delete

URL:

https://app.breezz.io/api/record/{ObjectID}/{id}

Method:

DELETE

More exemple in PHP | python | ASP.NET |

Query

URL:

https://app.breezz.io/api/query

Method:

POST

Json exemple:

{
"objecttype": 1,
"page_size": 50,
"page_number": 1,
"fields": "accountname,idnumber,telephone1",
"query": "(idnumber  = 12345678) AND (accountname = 'john')",
"sort_by": "accountname",
"sort_type": "desc"
} 

More exemple in PHP | python | ASP.NET |

Field	Description	Example
objecttype	The number of the object	Accounts=1, Contact=2,Deals=4 (See more..)
page_size	The number of results per page	Min:1 Max:500
page_number	The page of the result	start at: 1
fields	Which fields to show on the result	for all field: *
query	The query you want to search	((idnumber = 1234) AND (idnumber = 5678))
sort_by	Select field to sort by	accountname/idnumber/telephone1
sort_type	Select type to sort	desc/asc

Type of query:

Operator	Description	Example
=	Find result equal to	"query": "(idnumber = 1234)"
!=	Find result not equal to	"query": "(idnumber != 1234)"
>	Greater than	"query": "(age1 > age2)"
<	Less than	"query": "(age1 < age2)"
<=	Greater than or equal to	"query": "(age1 <= age2)"
>=	Less than or equal to	"query": "(age1 >= age2)"
OR	Performs a logical-OR of its bool operands	"query": "((idnumber = 1234) OR (idnumber = 456789))"
AND	Performs a logical-AND of its bool	"query": "((idnumber = 1234) AND (accountname = 'משה'))"
is-null	Look for NULL values	"query": "(idnumber is-null 1234567)"
is-not-null	Look for not NULL values	"query": "(idnumber is-not-null 1234567)"
start-with	Find if the string starts with the string	"query": "(idnumber start-with 1234567)"
end-with	Find if the string ends with the string	"query": "(idnumber end-with 1234567)"
not-start-with	Find if the string does not start with the string	"query": "(idnumber not-start-with 1234567)"
not-end-with	Find if the string does not end with the string	"query": "(idnumber not-end-with 1234567)"

You can combine the AND and OR Conditions

Note

• AND & OR conditions allow you to test multiple conditions.
• Don't forget the order of the operation parentheses!

Go to your Breezz account and let's start!