v1
latestSwagger 2.02026-08-043765135.6 KBtransactions
Get Transactions
Retrieve all existing transactions. A transaction is a purchase made by a customer.
get/transactions
Query parameters
mockboolean
Return mock data
idstring[]
organizationIdstring uuid
Query by organization UUID
customerIdstring uuid
Query by customer uuid
appointmentIdstring[]
Query by appointment UUID
perPageinteger
Query parameter to set the number of results per page
pageAfterstring
Query parameter to set the token for the next page of results
order'asc' | 'desc'
Specify the order of the returned data based on the field specified in "orderBy".
orderBystring
Field by which to order results
Response
Return an array of data responses
Example response
{
"data": [
{
"attributes": {
"currency": "USD",
"createdAt": "2018-02-03T10:30:00Z",
"updatedAt": "2018-02-03T10:30:00Z"
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
}
},
"customer": {
"data": {
"data": {
"type": "customers",
"id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
}
}
},
"appointment": {
"data": {
"data": {
"type": "appointments",
"id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
}
}
}
}
}
]
}