# List payments `GET /api/v1/payments` Lists payment records in the workspace. ## Permissions Send your API key in `X-API-Key`. Required permissions are **Payments → Read**. ## Query parameters - `payment_type` (string) — Use incoming or outgoing. - `status` (string or array) — Filter by one or more statuses. For incoming payments, a paid filter also includes refunded. - `sport_id` (integer) — Limit results to an active sport. - `subject_type` (string or null) — Use athlete, coach, staff, or manager. - `subject_id` (integer or null) — ID of the associated person. - `athlete_id` (integer) — Filter by athlete ID. - `payer_parent_id` (integer) — Filter by payer parent. - `supplier_id` (integer) — Filter by supplier. - `subscription_id` (integer) — Filter by subscription. - `year` (integer) — Calendar year when no date range is supplied. Defaults to the current year. - `from_date` (date string) — Inclusive start date in YYYY-MM-DD format. - `to_date` (date string) — Inclusive end date in YYYY-MM-DD format. - `context` (string) — Use athlete_detail, parent_detail, coach_detail, or staff_detail to include the full history. - `coach_id` (integer) — Filter by coach when context is coach_detail. - `accounting_category_id` (integer) — Filter by accounting category. - `tag_id` (integer) — Filter by tag. - `include_readable` (integer) — Use 1 to include formatted payment information. Alias expand_readable. - `expand_subject` (integer) — Use 1 to include the related subject record. - `expand_athlete` (integer) — Use 1 to include the related athlete record. - `expand_parent` (integer) — Use 1 to include the related parent record. - `expand_subscription` (integer) — Use 1 to include the related subscription record. - `q` (string) — Search payment text and readable names. - `length` (integer) — Number of records to return. - `start` (integer) — Zero-based offset. - `draw` (string) — Optional request marker echoed in the response. - `sort` (string) — Sort by id, tsc, tsu, due_at_ts, receipt_at_ts, payment_at_ts, receipt_number, status, payment_type, amount, reason, or readable classification and payment method fields. Prefix the field name with a minus sign for descending order. - `order` (string) — Direction for unprefixed sort fields. Use asc or desc. API key access to this operation depends on the workspace’s payment sport access. A request can return `403` even when the key has Payments read permission. ## Request Set ASDINCLOUD_API_KEY and any variables named in the example before running it. ```sh curl --get \ --url "https://api.asdincloud.com/api/v1/payments" \ --header "X-API-Key: $ASDINCLOUD_API_KEY" \ --data-urlencode "year=2026" \ --data-urlencode "payment_type=incoming" \ --data-urlencode "length=25" ``` ## Response **200 OK** Returns matching payments and their classification in `data`. Example with fictional data and selected fields. ```json { "status": "success", "data": [ { "id": 19, "sport_id": null, "payment_type": "incoming", "status": "paid", "currency": "EUR", "amount": 2500, "accounting_category_id": 8, "accounting_category": { "id": 8, "name": "Club income", "tag_type": "accounting_category", "direction": "incoming" }, "tag_ids": [], "tags": [], "payment_at_ts": 1794564000, "receipt_at_ts": 1794564000, "due_at_ts": null, "receipt_number": 14, "fiscal_year": 2026, "receipt_display_number": "14", "document_origin": "system" } ], "records_total": 1, "records_filtered": 1, "draw": null } ``` ## Errors - `401` — The API key is missing or invalid. - `403` — The API key lacks the required permission. - `400` — The supplied fields or payment state do not allow this action.