Skip to main content
GET
List authorizations

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

situation
enum<string>

Filter by authorization status.

Available options:
CREATED,
APPROVING,
APPROVED,
REJECTED,
EXPIRED,
CANCELLING,
CANCELLED,
ACTIVE,
CONCLUDED
Example:

"ACTIVE"

payerName
string

Filter by the payer's name.

initialDate
string<date>

Filter by start date (format YYYY-MM-DD).

finalDate
string<date>

Filter by end date (format YYYY-MM-DD).

page
integer
default:0

Page number for the query.

maxPageResults
integer
default:20

Maximum number of results per page.

sortBy
enum<string>
default:updatedAt

Field to sort the results by.

Available options:
updatedAt,
creation,
payerName
order
enum<string>
default:DESC

Sort order.

Available options:
ASC,
DESC

Response

List of authorizations returned successfully.

status
integer
message
string
totalElements
integer
totalPages
integer
resultSize
integer
results
object[]