List workspace sales

Minimum role: VIEWER. Active workspace via the X-Workspace-Id header.

GET/sales

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters

statusstring

PENDING|CONFIRMED|ABANDONED|CANCELLED|REFUNDED

Allowed:PENDINGCONFIRMEDABANDONEDCANCELLEDREFUNDED

channelstring

WEB|MOBILE|POS|ADMIN

Allowed:WEBMOBILEPOSADMIN

eventstring

event id

eventDatestring

event date id

referencestring

sale reference/code (partial match)

buyerstring

buyer name or email (partial match)

fromstring

start date (ISO 8601, applied to created_at)

tostring

end date (ISO 8601, applied to created_at)

limitinteger

1-100, default 20

default: 20

cursorstring

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataSale[]required

Show properties

Array of Sale

idstringrequired

referencestringrequired

statusstringrequired

Allowed:PENDINGCONFIRMEDABANDONEDCANCELLEDREFUNDED

channelstringrequired

subtotalnumberrequired

discountAmountnumberrequired

serviceFeenumberrequired

ivanumberrequired

totalnumberrequired

currencystringrequired

buyerNamestringrequired

buyerEmailstringrequired

buyerPhonestring | nullrequired

Show properties

Any of:

string

string

null

null

buyerDocumentTypestring | nullrequired

Show properties

Any of:

string

string

null

null

buyerDocumentNumberstring | nullrequired

Show properties

Any of:

string

string

null

null

organizationIdstring | nullrequired

Show properties

Any of:

string

string

null

null

paymentProviderstring | nullrequired

Show properties

Any of:

string

string

null

null

paymentRefstring | nullrequired

Show properties

Any of:

string

string

null

null

confirmedAtstring | nullrequired

Show properties

Any of:

string

string

null

null

createdAtstringrequired

failureReasonstring | nullrequired

Show properties

Any of:

string

string

null

null

paymentStatusstring | nullrequired

Status of the latest payment event. Usually the payment gateway's RAW status in its own vocabulary. Values prefixed with FT_ come from FreeTicket, not the gateway: currently FT_SALE_APPROVED_POST_CONFIRM, which marks that the gateway re-notified an already-confirmed charge — this is how Bold reports its refunds. A CONFIRMED sale with this status may have money refunded that is not yet recorded.

Show properties

Any of:

string

string

null

null

declineCodestring | nullrequired

Show properties

Any of:

string

string

null

null

pagePagerequired

Show properties

nextCursorstring | nullrequired

Show properties

Any of:

string

string

null

null

hasMorebooleanrequired

totalinteger

min -9007199254740991 · max 9007199254740991

warningsWarning[]

Show properties

Array of Warning

codestringrequired

messagestringrequired

fieldstring

activeWorkspaceIdstring

activeWorkspaceNamestring

accessibleWorkspacesinteger

min -9007199254740991 · max 9007199254740991

suggestedWorkspaceIdstring

suggestedWorkspaceNamestring

400

Bad request: malformed parameters.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

statusqueryPENDING|CONFIRMED|ABANDONED|CANCELLED|REFUNDEDchannelqueryWEB|MOBILE|POS|ADMINeventqueryevent ideventDatequeryevent date idreferencequerysale reference/code (partial match)buyerquerybuyer name or email (partial match)fromquerystart date (ISO 8601, applied to created_at)toqueryend date (ISO 8601, applied to created_at)limitquery1-100, default 20cursorqueryX-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/sales' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/sales", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/sales",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "reference": "string",
      "status": "PENDING",
      "channel": "string",
      "subtotal": 0,
      "discountAmount": 0,
      "serviceFee": 0,
      "iva": 0,
      "total": 0,
      "currency": "string",
      "buyerName": "string",
      "buyerEmail": "string",
      "buyerPhone": "string",
      "buyerDocumentType": "string",
      "buyerDocumentNumber": "string",
      "organizationId": "string",
      "paymentProvider": "string",
      "paymentRef": "string",
      "confirmedAt": "string",
      "createdAt": "string",
      "failureReason": "string",
      "paymentStatus": "string",
      "declineCode": "string"
    }
  ],
  "page": {
    "nextCursor": "string",
    "hasMore": true,
    "total": -9007199254740991
  },
  "warnings": [
    {
      "code": "string",
      "message": "string",
      "field": "string",
      "activeWorkspaceId": "string",
      "activeWorkspaceName": "string",
      "accessibleWorkspaces": -9007199254740991,
      "suggestedWorkspaceId": "string",
      "suggestedWorkspaceName": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}