Skip to main content
POST
Bonds by Issuer

Authorizations

X-API-KEY
string
header
required

Body

application/json
identifier
SingleIdentifier · object
required

Object specifying which identifier you are using to request the company profile. You must supply one type and its corresponding value.

status
enum<string> | null
default:active

Only return bonds in this status: 'active', 'inactive' or 'defaulted'. Defaults to 'active'; send null to return bonds in every status.

Available options:
active,
inactive,
defaulted
Example:

"active"

cursor
string | null

Token for the next page. Send back 'pagination.cursor' from the previous response, with the same identifier and status. Omit it for the first page.

Response

Successful Response

results
Bond · object[]
required

The company's bonds on this page. A page can hold fewer bonds than others, or none at all, while more remain: keep requesting the next page with 'cursor' until 'pagination.has_cursor' is false.

errors
ErrorDetail · object[] | null
metadata
Metadata · object | null
pagination
Pagination · object | null

Common pagination response for endpoints that support pagination.