Skip to main content
GET
/
v1
/
platform
/
transactions
List transactions for the organization
curl --request GET \
  --url https://api.1club.ai/v1/platform/transactions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "description": "<string>",
    "transactionType": "<string>",
    "bookingId": 123,
    "membershipId": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "date": "2023-11-07T05:31:56Z",
    "amount": 123,
    "taxAmount": 123,
    "totalAmount": 123
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.1club.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Customer API key obtained from the admin portal (e.g. 1club_sk_live_...)

Query Parameters

​
startDate
string<date-time>

Inclusive lower bound on transaction createdAt. Defaults to endDate - 24h.

​
endDate
string<date-time>

Inclusive upper bound on transaction createdAt. Defaults to now.

​
paymentStatus
enum<string>

Filter by payment status. When omitted, all statuses are returned.

Available options:
pending,
paid,
void,
failed,
settled,
overdue,
partially_paid,
refunded,
cancelled
​
limit
integer
default:100

Maximum number of transactions to return.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of transactions to skip.

Required range: x >= 0

Response

List of transactions

​
id
integer
​
description
string | null
​
transactionType
string | null

TransactionType enum value (e.g. booking_creation, membership_creation, product_sale, membership_recurrence, etc.).

​
bookingId
integer | null
​
membershipId
integer | null
​
createdAt
string<date-time>
​
date
string<date-time>
​
paymentStatus
enum<string>
Available options:
pending,
paid,
void,
failed,
settled,
overdue,
partially_paid,
refunded,
cancelled
​
amount
number<decimal>

Pre-tax amount. Serialized as a decimal string on the wire (e.g. "25.00") to preserve precision - parse rather than relying on JSON number behavior.

​
taxAmount
number<decimal>

Tax portion. Serialized as a decimal string on the wire to preserve precision.

​
totalAmount
number<decimal>

Total billed amount (amount + taxAmount). Serialized as a decimal string on the wire to preserve precision.