Skip to main content
GET
/
payments
Retrieve payments list
curl --request GET \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/payments \
  --header 'x-api-key: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://fieldpulse.mintlify.app/llms.txt

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

Authorizations

​
x-api-key
string
header
default:your-api-key-here
required

Query Parameters

​
limit
string

Defaults to 20 items per page, maximum 100 items allowed.

​
page
string

Page number. Starts from 1, defaults to 1.

​
sort_by
string

Allowed values: cuid, method,amount,payment_date

​
sort_dir
string

Allowed values: asc, desc

​
search
string

Search string.

​
calculate_count
string
​
filter
string
​
sort
string
​
rel
string

Response

200 - application/json

Successful response