Get a list of orders placed on this platform

You can review and manage previously paced orders using Tango API. Use the following endpoint to get a list of orders placed under your platform:

Endpoint	Purpose
`GET {URI}/orders`	Get a list of Orders placed under this platform.

📘
Note:
GET {URI}/orders currently only returns 10K results. Use Tango API query parameters to better filter your search results.

🚧
Coming soon:
This endpoint will soon be modified to include query parameters: deliveryMethod, recipientMobileNumber , and deliveryStatus. Once released, you can query rewards using delivery methods such as SMS, CARRIER, and EMBEDDED besides EMAIL.

Here is a list of query parameters offered with this endpoint to better filter your search results:

Query params	Data type	Description
accountIdentifier	string	Specify the account to be queried. The string must have 5-100 characters.
customerIdentifier	string	Specify the customer to be queried. The string must have 5-100 characters.
externalRefID	string	Specify the external reference ID to be queried. The string may have up to 100 alphanumeric characters.
startDate	string	Specify the starting date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
endDate	string	Specify the ending date or date time to be queried according to RFC 3339, i.e. "2016-01-01" or "2016-01-01T00:00:00Z". See https://www.ietf.org/rfc/rfc3339.txt
elementsPerBlock	int32	Specify the number of elements in a block.
page	int32	Specify the page number to return.
minAmount	double	Specify the minimum face value of the reward to be queried. 👍 Best practice: When you are searching for an amount, we recommend you to enter a minimum and a maximum amount for the search.
maxAmount	double	Specify the maximum face value of the reward to be queried. 👍 Best practice: When you are searching for an amount, we recommend you to enter a minimum and a maximum amount for the search.
currencyCode	string	Specify the currency code of the reward to be queried. The string must be three characters. We accept AUD, CAD, EUR, GBP, or USD. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified.
utid	string	Specify the unique identifier of the reward to be queried.
ptid	string	Specify the unique identifier of the physical delivery template to be queried. ptid is required for orders where the UTID is Reward Type = Reward Link, Fulfillment Type = Physical.
rewardName	string	Specify the reward name of the reward to be queried.
senderFirstName	string	Specify the sender's first name to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`. The `senderFirstName` may have up to 100 characters. You cannot use < or > or / in the name.
senderLastName	string	Specify the sender's last name to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`. The `senderlastName` may have up to 100 characters. You cannot use < or > or / in the name..
senderEmail	string	Specify the sender email address to be queried. This information is for tracking purposes only and doesn’t change the email address the reward is sent from when `sendEmail: true`.
recipientEmail	string	Specify the recipient’s email address to be queried.
recipientMobileNumber (🚧 Coming soon)	string	Specify the recipient mobile number to be queried. The `recipientMobileNumber` is required if `deliveryMethod=SMS`. The following validation rules apply to mobile numbers for SMS delivery: - Country Code: Must be included. - Format: +CCCPPPPPPPPPPPP (where C is the country code, 1-3 digits, and P is the phone number, up to 12 digits). - Initial Release: Only accepts US phone numbers (Country code = +1) and 10 digits for the phone number. -Standard: Follows ITU E.164, allowing (+) and up to 15 digits for the combined country code and phone number.
deliveryStatus (🚧 Coming soon)	string	Will contain the email, SMS, and physical delivery status.
recipientFirstName	string	Specify the recipient’s first name to be queried. The `recipientFirstName` may have up to 100 characters. You cannot use < or > or / in the name.
recipientLastName	string	Specify the recipient’s last name to be queried. The `recipientLastName` may have up to 100 characters. You cannot use < or > or / in the name.
sendEmail	boolean	Specify if `sendEmail` is true or false to determine whether or not Tango sends email to your recipients: If `sendEmail=false`, Tango does not deliver the reward email. You are responsible for delivering rewards. If `sendEmail=true`, Tango delivers the reward email. -(🚧 Coming soon) sendEmail will be deprecated soon. It will only appear in the payload once the `deliveryMethod` is released.
deliveryMethod (🚧 Coming soon)	string	Specify the delivery method for an order to determine how a reward is sent to a recipient. `deliveryMethod` will replace `sendEmail` once released: -NONE: Tango does not deliver. You are responsible to deliver the rewards to your recipient. This option is similar to `sendEmail=false`. -EMAIL: Tango delivers the reward to the recipient via email. You must include the recipient email. This option is similar to `sendEmail=true`. -SMS: Tango delivers the reward to the recipient via text. You must include the recipient phone number. -CARRIER: Tango delivers the physical rewards via a carriers such as the post office, FexEx, UPS, etc. You must include the recipient address. -EMBEDDED: You will embed Tango's lading page into your application. Tango will not deliver the rewards.
orderStatus	string	Specify the status to be queried. See order status. -COMPLETE -PENDING -FAILED -CANCELLED -PARTIAL
lineItemStatus	string	Specify the status to be queried. See line item status . -COMPLETE -PENDING -FAILED -CANCELLED
campaign	string	Specify the campaign to be queried. The string may have up to 100 characters.
notes	string	Specify the notes to be queried. The string may have up to 150 characters.
lineItemNotes	string	Specify the notes to be queried.
purchaseOrderNumber	string	specify the `purchaseOrderNumber` to be queried.

The following example shows the payload including pagination when you use GET {URI}/orders.

{
  "page": {
    "number": 0,
    "elementsPerBlock": 0,
    "resultCount": 0,
    "totalCount": 0
  },
  "orders": [
    {
      "referenceOrderID": "string",
      "externalRefID": "string",
      "customerIdentifier": "string",
      "accountIdentifier": "string",
      "accountNumber": "string",
      "amountCharged": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "denomination": {
        "value": 0,
        "currencyCode": "string",
        "exchangeRate": 0,
        "fee": 0,
        "total": 0
      },
      "utid": "string",
      "ptid": "string",
      "rewardName": "string",
      "sender": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
      },
      "recipient": {
        "email": "string",
        "mobileNumber": "string",
        "firstName": "string",
        "lastName": "string",
        "address": {
          "streetLine1": "string",
          "streetLine2": "string",
          "city": "string",
          "stateOrProvince": "string",
          "postalCode": "string",
          "country": "string"
        }
      },
      "emailSubject": "string",
      "message": "string",
      "sendEmail": true,
      "deliveryMethod": "NONE",
      "etid": "string",
      "status": "string",
      "orderStatus": "string",
      "lineItemStatus": "string",
      "campaign": "string",
      "createdAt": "2025-05-02T18:25:06.138Z",
      "notes": "string",
      "orderClientSource": "string",
      "purchaseOrderNumber": "string",
      "orderExternalRefIdDupe": true
    }
  ]
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

200 OK
400 Bad request
401 Unauthorized
403 Forbidden

Get a list of orders placed on this platform

📘
Note:

🚧
Coming soon:

📘Note:

🚧Coming soon:

📘
Note:

🚧
Coming soon: