Get Transactions

get

http://preview.threekit.com/api/transactions

Retrieves all transactions in an org.

Query Params

transactionIdLike

string

Filters the returned transactions by their transaction ID. Supports partial matches: Returns all transactions whose transaction IDs contain the specified text as a substring.

status

string

enum

Filter the transactions by their status. Only supports two values "active" and "closed". If not provided, all transactions are returned.

Allowed:

contactNameLike

string

Filters the returned transactions by contact Name. Supports partial matches: Returns all transactions whose associated contact name contain the specified text as a substring.

variantId

string

Filter transactions by variant ID. This can either be the variant UUID or the customId

startDate

string

endDate

string

page

integer

≥ 1

Defaults to 1

The page number to retrieve.

perPage

integer

1 to 100

Defaults to 50

The number of entities to retrieve per page.

bearer_token

uuid

Public or Private Threekit authentication token. If using a public token the request must originate for a domain added to the authentication token.

jwt_token

string

JSON Web Token (JWT) token used to authorize the request.

Responses

Language

Response

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

application/json

200200

401401

403403

404404