DocumentationAPI Reference
Log In
API Reference

Search Contracts

get
https://api.helloextend.com/contracts/search

This endpoint allows search via querystring params.

The search queries include:

  • typeFilter
  • contractId
  • customerEmail
  • customerPhone
  • productSerialNumber
  • productTransactionId
  • sellerId
  • status
  • transactionId

The search term sellerId can be paired with any of the other terms to limit contracts by seller.

sellerId is a required querystring parameter.

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

Filter for including contract types. NOTE - PCRS is the contract type for extended warranty contracts.

uuid

Unique identifier for an Extend contract.

string

Email of customer who purchased the contract.

string

Phone number of customer who purchased the contract.

string

Unique identifier for the customer in the merchant’s system.

string

Serial number of product purchased.

string

Unique identifier provided by merchant for transaction associated to the product covered by the Extend contract.

uuid

Unique identifier for merchant’s store in Extend’s system.

string
enum

Status of contract.

string

Unique identifier provided by merchant for transaction associated to Extend contract purchased.

boolean

Use the value true to return all the product info and plan details.

Headers
string
required

An Extend private API key used to authenticate requests.

Responses

Updated 27 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago

Did this page help you?