Boleto Holmes

List Boleto Holmes

Get a list of non-deleted boletos in chunks of at most 100. If you need smaller chunks, use the limit parameter.

get/v2/boleto-holmes

Request

  • Base URL
    https://api.starkbank.com
  • URL
    https://api.starkbank.com/v2/boleto-holmes
  • Auth
    API key in header Digital-Signature

Query parameters

afterstring date

Filter entities created after this date.

beforestring date

Filter entities created before this date.

boletoIdstring

String to get boletos holmes that refer to a specific boleto ID.

cursorstring

String used to get the next batch of results. Our SDKs handle this for you.

fieldsstring[]

List of strings to filter response JSON keys. Not available in the SDKs.

idsstring[]

List of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']

limitinteger

Number of results per cursor. Max = 100.

statusstring

Filter holmes by the specified status.

tagsstring[]

Filter entities that contain the specified tags.

Response

Successful operation

object required

Changes

No recorded changes to this operation across all 1 revision of this API.