API Reference

Get Contracts by Customer

get
https://{your-totality-url}.com/api/customer/contracts/

Retrieve a paginated list of contracts for a specific customer. Permission: Read Contracts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The UUID of the customer to retrieve contracts for.

Query Params
string
Defaults to page=1

The page number for paginated results. Defaults to 1. Used to traverse the paginated response

string

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description. Used to sort the response in ascending or descending order of an attribute

string

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded. Used to filter the response on an attribute value

Headers
string
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
Defaults to application/json

Must be application/json.

Responses

Updated 20 days ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 20 days ago