GET
/
sales
Get all sales or by ID, affiliate, referral, or external ID
curl --request GET \
  --url https://www.pushlapgrowth.com/api/v1/sales \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referralId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "externalId": "<string>",
    "externalInvoiceId": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "totalEarned": 123,
    "commissionRate": 123,
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
integer

The ID of the sale to retrieve

​
affiliateId
string<uuid>

The affiliate ID associated with the sale

​
affiliateEmail
string<email>

The email of the affiliate associated with the sale

​
referralId
string<uuid>

The referral ID associated with the sale

​
saleExternalId
string

The external ID of the sale

Response

A list of sales or a single sale

The response is of type object[].