Home
Bronto APIUnderstand REST and SOAP API clients.
SOAP APIThe Bronto API was built on the SOAP web service, so most of the interactions you have with Bronto’s API will be SOAP-based.
SOAP Read FunctionsRead functions allow you to retrieve information. Often you may need to use a read function to get data that you will need to use to complete an API task.
readBouncesThe readBounces function attempts to return bounce data that matches the passed in filter.

readBounces

The readBounces function attempts to return bounce data that matches the passed in filter.

Results

The readBounces function may return 1 or many bounce objects. See the documentation on the bounceObject for a list of the data fields that could potentially be returned.

Syntax

bounceObject[] bounces = bApi.readBounces(filter bounceFilter, pageNumber);

Parameters


Name	Type	Required	Comments
`filter`	bounceFilter	Yes	The filter used to return specific bounce data.
`pageNumber`	int	Yes	Retrieves the next “batch” of objects as the value specified increases from 1. In order to obtain an entire set of objects for a given call, you should increase the number value assigned to pageNumber until no more objects are returned.