FIfieldpulse
Payments

Retrieve payments list

List payments

get/payments

Request

  • Base URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage
  • URL
    https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/payments
  • Auth
    API key in header x-api-key

Query parameters

limitstring

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

pagestring

Page number. Starts from 1, defaults to 1.

sort_bystring

Allowed values: cuid, method,amount,payment_date

sort_dirstring

Allowed values: asc, desc

searchstring

Search string.

calculate_countstring
filterstring
sortstring
relstring

Response

Successful response

errorboolean

false when the request succeeds.

total_countinteger

Total number of records that match the request, across all pages.

responseobject[]

Example response

{
  "total_count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.