/contracts

get

https://{BaseUrl}/api/v3.0/contracts

Retrieves contract vault records based on provided criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

startTimestamp__lte

date-time

Filter to get only records that have a startTimestamp value that is less than or equal to the given value. If endTimestamp__lte is not provided, this parameter is required.

startTimestamp__gte

date-time

Filter to get only records that have a startTimestamp value that is more than or equal to the given value.

endTimestamp__lte

date-time

Filter to get only records that have an endTimestamp value that is less than or equal to the given value. If startTimestamp__lte is not provided, this parameter is required.

endTimestamp__gte

date-time

Filter to get only records that have an endTimestamp value that is more than or equal to the given value.

id__in

string

Filter to get only records that have an ID that equals one of the given parameter values.

layoutId

string

Filter records by a specific layout ID.

agentFirstName__in

array of strings

Filter to return records where the agent's first name matches any of the provided values. The lookup is exact but case-insensitive.

agentFirstName__in

agentFirstName__contains

string

Filter to return records where the agent's first name contains the provided substring. The lookup is exact but case-insensitive.

agentLastName__in

array of strings

Filter to return records where the agent's last name matches any of the provided values. The lookup is exact but case-insensitive.

agentLastName__in

agentLastName__contains

string

Filter to return records where the agent's last name contains the provided substring. The lookup is exact but case-insensitive.

agentEmail__in

array of strings

Filter records where the agent's email address matches any of the provided values. The lookup is exact but case-insensitive.

agentEmail__in

agentEmail__contains

string

Filter records where the agent's email address contains the provided substring. The lookup is exact but case-insensitive.

managerFirstName__in

array of strings

Filter to return records where the manager's first name matches any of the provided values. The lookup is exact but case-insensitive.

managerFirstName__in

managerFirstName__contains

string

Filter to return records where the manager's first name contains the provided substring. The lookup is exact but case-insensitive.

managerLastName__in

string

Filter to return records where the manager's last name matches any of the provided values. The lookup is exact but case-insensitive.

managerLastName__contains

string

Filter to return records where the manager's last name contains the provided substring. The lookup is exact but case-insensitive.

customerFirstName__in

array of strings

Filter to return records where the customer's first name matches any of the provided values. This can be used to find either the primary or secondary customer associated with the contract. The lookup is exact but case-insensitive.

customerFirstName__in

customerFirstName__contains

string

Filter to return records where the customer's first name contains the provided substring. This can be used to find either the primary or secondary customer associated with the contract. The lookup is exact but case-insensitive.

customerLastName__in

array of strings

Filter to return records where the customer's last name matches any of the provided values. This can be used to find either the primary or secondary customer associated with the contract. The lookup is exact but case-insensitive.

customerLastName__in

customerLastName__contains

string

Filter to return records where the customer's last name contains the provided substring. This can be used to find either the primary or secondary customer associated with the contract. The lookup is exact but case-insensitive.

stockNumber__in

string

Filter to return records where the stock number matches any of the provided values. The number must be an exact match.

pageToken

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSize

integer

1 to 500

Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Responses

200Successful retrieval of contract records.

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

500Something went wrong in the server. Please try again.