Skip to main content
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": "[email protected]",
    "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<int64>

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

​
id
integer<int64>

The sale ID

​
affiliateId
string<uuid>

The affiliate ID associated with the sale

​
referralId
string<uuid>

The referral ID associated with the sale

​
externalId
string

The external ID of the sale

​
externalInvoiceId
string

The external invoice ID of the sale

​
name
string

Name of the sale

​
email
string<email>

Email associated with the sale

​
totalEarned
number<float>

Total amount earned from the sale

​
commissionRate
number<float>

Commission rate for the sale

​
createdAt
string<date-time>

Creation timestamp of the sale