Skip to main content

Lists account agreement statuses

Request

Account agreements for given account number.

Security
BearerAuth
Path
accountNumberstring^\d+$required

Number of account to search by

Example:100013200
Query
ibxstring^[A-Z]{2,3}[1-9]?[0-9]{0,2}[a-zA-Z]?$required

Agreement IBX

Example:ibx=WA1
offsetinteger, >= 0

Pagination offset

Default:0
Example:offset=0
limitinteger, >= 0

Max number of returned results

Default:50
Example:limit=50
Payload
// No request payload

Responses

Account object

Bodyapplication/json
paginationobject(Pagination)required
dataArray of objects(AccountAgreements_data)required
Response
{ "pagination": { "offset": 0, "limit": 20, "total": 2, "next": "string", "previous": "string" }, "data": [ { … } ] }
Was this page helpful?