Skip to main content
GET
/
refunds
List refund requests
curl --request GET \
  --url https://api.guile.app/refunds \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "appointmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "requestedAmount": "456.78",
      "reason": "<string>",
      "state": "pending",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "approvedAmount": "456.78",
      "responseNote": "<string>",
      "refundPaymentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 1
}

Query Parameters

​
state
enum<string>[]

Filter by refund request state

Valid states of a refund request.

Available options:
pending,
approved,
denied,
processed
​
appointmentId
string<uuid>

Filter by specific appointment The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

A list response for paginated resources.

​
items
object[]
required
​
count
integer<int16>
required
Required range: x >= 0
​
offset
integer<int16>
required

The offset of list results for the current page.

Required range: x >= 0
​
limit
integer<int16>
required

The maximum number of results included in items.

Required range: x >= 0