API Reference

Get Contracts

Retrieve specific contract information by loan UUID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Defaults to page=5

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

string
Defaults to sort=+createdAt

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
Defaults to createdAt=eq:2022-01-01

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

string

The IP address of the API caller. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

When the contract was created. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The IP address of the end user. Sortable: Yes. Filter Operators: eq, in, nin, ne, neq, nn, null, se, sw

string

The UUID of the loan this contract belongs to. Sortable: Yes. Filter Operators: eq, ne, neq, nn, null

string

When the contract was last updated. ISO 8601 datetime format. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, neq, nn, null

string

The full name of the customer associated with the contract's loan. Sortable: No. Filter Operators: eq, sw

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

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

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