Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pipevest.com/llms.txt

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

All GET requests that return a list can be paginated and sorted.
NameDefinition
pageThe current page for offseting the returned list
limitMaximum number of items to return per request. Maximum value is 1000
sortOrder in which to return the list. Either ascending(ASC) or descending(DESC)
Sorting only applies to createdAt date

​
Example Request

  curl --request GET \
    --url https://api.pipevest.com/v1/customers?page=1&limit=100&sort=ASC \
    --header 'Authorization: Bearer 123456' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("Authorization" "X-Client-Id" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
The above request would result in something similar to: 
{
  "data": [...], // List of customers
  "meta": {
    "previousPage": 0,
    "currentPage": 1,
    "nextPage": 2,
    "limit": 100,
    "currentCount": 100,
    "totalCount": 1000,
    "sort": "ASC"
  },
  "message": "Successfully retrieved customers",
  "code": 200
}

​
Meta

NameDefinition
previousPageThe previous page offset
currentPageThe current page offset
nextPageThe next page offset
limitThe return limit set on this request
currentCountTotal number of results returned with this request
totalCountTotal number of returnable results
sortOrder in which the list was returned