/api/v3/transactions/records

get

https://api.sisu.co/api/v3/transactions/records

Get transactions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

context

string

required

Transaction context to use when searching

locked_filter

string

enum

Defaults to null

Whether to view locked transactions or unlocked transactions only

Allowed:

include_lost

boolean

Defaults to false

Whether to include lost transactions or not

type_filter

string

enum

Defaults to all

Type of transactions to search for; "all" includes everything, "b" for buyer transactions only, "s" for seller transactions only

Allowed:

client_filter

string

enum

Defaults to null

Transaction status to search for; use status_start_date and status_end_date to define the date range for this status

date_filter_key

string

Defaults to null

Transaction date field to search over; use start_date and end_date to define date range to search over

start_date

string

Defaults to null

The start date used to search over the date field in date_filter_key, format is MM-DD-YYYY

end_date

string

Defaults to null

The end date used to search over the date field in date_filter_key, format is MM-DD-YYYY

lost_reason_filters

integer

Defaults to null

ID of the lost reason to filter transactions by

client_stage_id

integer

Defaults to null

ID of the client stage to filter transactions by

name_filter

string

Defaults to null

Search over first and last names in transactions

email_filter

string

Defaults to null

Search over emails in transactions

street_address_filter

string

Defaults to null

Search over address in transactions

city_filter

string

Defaults to null

Search over city in transactions

state_filter

string

Defaults to null

Search over state in transactions

postal_code_filter

string

Defaults to null

Search over postal code in transactions

lead_type_filter

integer

Defaults to null

Lead sources ID to filter transactions by

vendor_filter

string

Defaults to null

Vendor ID to filter transactions by

split_filter

string

enum

Defaults to null

Split type to filter transactions by

Allowed:

appt_set_by_filter

string

Defaults to null

Appointment set by agent ID to filter transactions by

tc_filter

integer

Defaults to null

ID of TC to filter transactions by

yn_key

string

Defaults to null

Yes/No field to filter transactions by; used with yn_value parameter

yn_value

string

enum

Defaults to null

Value in yn_key field; Y = yes, N = no, X = not set

Allowed:

amount_filter_key

string

Defaults to null

Amount field to filter transactions by; used with range_start and range_end parameters

range_start

number

Defaults to null

Starting amount to filter amount_filter_key field by

range_end

number

Defaults to null

Ending amount to filter amount_filter_key field by

string_filter_key

string

Defaults to null

String field to filter transactions by; used with string_filter_value parameter

string_filter_value

string

Defaults to null

Value in string_filter_key field

number_filter_key

string

Defaults to null

Number field to filter transactions by; used with filter_number parameter

number_range_start

number

Defaults to null

Starting number to filter number_filter_key field by

number_range_end

number

Defaults to null

Ending number to filter number_filter_key field by

tag_filter_id

integer

Defaults to null

ID of the tag to filter transactions by; used with tag_filter_modifier parameter

tag_filter_modifier

string

enum

Defaults to null

If exists, filters to transactions with the tag with the ID in tag_filter_id; if not, filters to transactions that don't have that tag

Allowed:

select_filter_key

string

Defaults to null

Select field to filter transactions by; used with select_filter_value parameter

select_filter_value

string

Defaults to null

Value for select_filter_key parameter

external_service_id

string

external service ID to filter by (requires external_id)

external_id

string

external transaction ID to filter by (requires external_service_id)

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success