Overview

The LoudCrowd Brand API lets you retrieve order and attribution data for your LoudCrowd programs. Version 1 is read-only and returns a paginated list of orders attributed to program members.

For interactive request examples, see the Brand API reference.

Base URL

https://api.loudcrowd.com/api/v1/brand

Create an API token

An account owner can create and revoke API tokens from Settings → API Keys in the LoudCrowd app.

Select Create API Token.
Enter a descriptive name.
Select the scopes required by the endpoints you plan to call.
Select Create Token, then select Copy Token when the token is shown.

The token is shown only once. Store it in a secret manager. If it is exposed, delete it in LoudCrowd and create a replacement.

Authenticate requests

Send the API token unchanged in the X-LC-Account-Key header:

X-LC-Account-Key: YOUR_API_TOKEN

Never place an API token in a URL, log it, commit it to source control, or expose it in browser code.

Find your Account ID and Program ID

The Settings → API Keys page lists the account and program IDs to use in Brand API paths under API identifiers.

YOUR_ACCOUNT_ID: the Account ID shown under API identifiers.
YOUR_PROGRAM_ID: the Program ID shown next to the program under API identifiers.

Use these values exactly as shown. The API token is not an Account ID or Program ID.

List program orders

GET /api/v1/brand/YOUR_ACCOUNT_ID/programs/YOUR_PROGRAM_ID/orders

Use this endpoint to retrieve orders attributed to members of a LoudCrowd program. Each result identifies the program member and includes attribution methods, financial values, and platform timestamps.

Required scopes

This endpoint requires the Read orders and Read programs scopes.

Query parameters

limit (optional): maximum number of orders to return. The default is 50; valid values are 1 through 100.
cursor (optional): the opaque nextCursor returned by the preceding response.

Example request

curl --get \
  'https://api.loudcrowd.com/api/v1/brand/YOUR_ACCOUNT_ID/programs/YOUR_PROGRAM_ID/orders' \
  --header 'X-LC-Account-Key: YOUR_API_TOKEN' \
  --data-urlencode 'limit=50'

Which orders are returned

An order is included when:

The member was approved for the program when the order was placed.
The order came from the program's connected store.
The order uses the program's currency.
The order was placed on or after the program was created.

Cancelled and fully refunded orders are included.

Pagination and ordering

Orders are returned in the order LoudCrowd received them, with the most recent first.

When another page is available, the response includes nextCursor and a Link response header with rel="next". Send nextCursor unchanged as the next request's cursor value, or follow the URL in the Link header.

On the final page, nextCursor is null and the Link header is absent. Do not construct or decode cursors.

Example response

{
  "data": [
    {
      "orderId": "ORDER-123",
      "ambassadorLcId": "Y3VzdG9tZXI6MTIz",
      "attributionTypes": ["LANDED"],
      "commissionAmount": "10.00",
      "amount": "100.00",
      "tax": "8.00",
      "shipping": "5.00",
      "refundAmount": "0.00",
      "refundTax": "0.00",
      "currency": "USD",
      "cancelledAt": null,
      "orderedAt": "2026-06-01T12:00:00Z",
      "lastUpdatedAt": "2026-06-02T08:30:00Z"
    }
  ],
  "nextCursor": null
}

Response fields

Field	Type	Description
`orderId`	string	Order identifier from the connected ecommerce platform.
`ambassadorLcId`	string	LoudCrowd ID for the selected program member.
`attributionTypes`	string array	Distinct attribution methods recorded for the order. It may contain more than one value.
`commissionAmount`	decimal string or null	Commission currently recorded for the selected program member. It is null only when commission has not been calculated yet.
`amount`	decimal string	Order total before refunds. It includes tax and shipping.
`tax`	decimal string	Tax before refunds. It is included in `amount`.
`shipping`	decimal string	Shipping. It is included in `amount`.
`refundAmount`	decimal string	Processed refund total. It includes `refundTax`.
`refundTax`	decimal string	Tax included in `refundAmount`.
`currency`	string	ISO 4217 currency code for every monetary field in the order.
`cancelledAt`	date-time or null	UTC cancellation timestamp from the ecommerce platform. It is null when unavailable.
`orderedAt`	date-time	UTC timestamp when the order was placed on the ecommerce platform.
`lastUpdatedAt`	date-time or null	UTC timestamp of the latest ecommerce-platform update. It is null when unavailable.
`nextCursor`	string or null	Opaque cursor for the next page, or null on the final page.

Attribution types

Each order appears once. ambassadorLcId identifies the selected program member. attributionTypes lists every distinct attribution method recorded for the order.

Value	Meaning
`LANDED`	The purchase followed a tracked visit.
`AFFILIATE_CODE`	The customer used an ambassador's affiliate or discount code.
`LINK_DISCOUNT`	An automatic discount associated with an ambassador link was applied.
`EXTERNAL`	An external affiliate network supplied the attribution.
`MANUAL`	The attribution was assigned manually.

Monetary values

All monetary values use the order's three-letter currency code. They are returned as exact decimal strings, so parse them with a decimal or fixed-point number type.

amount is the order total before refunds. It includes tax and shipping.
refundAmount is LoudCrowd's processed refund total. It includes refundTax.
refundTax is the tax portion of refundAmount, not an additional refund.

Cancelled orders

Cancelled orders remain in the response. Their financial values depend on when the cancellation occurs:

If the order is cancelled before commission is paid, amount, tax, shipping, refundAmount, refundTax, and commissionAmount are all "0.00".
If the order is cancelled after commission is paid, those values remain as recorded when the commission was paid.

currency is still returned.

Sample calculations

Given amount = "115.00", tax = "10.00", shipping = "5.00", refundAmount = "23.00", and refundTax = "3.00":

Order amount after refunds: 115.00 - 23.00 = 92.00
Tax after refunds: 10.00 - 3.00 = 7.00
Non-tax portion of the refund: 23.00 - 3.00 = 20.00
Amount before refunds, excluding tax and shipping: 115.00 - 10.00 - 5.00 = 100.00

Do not subtract refundTax from amount again. It is already included in refundAmount.

Errors

Status	Meaning
`400`	The `limit` or `cursor` value is invalid.
`401`	The API token is missing or invalid, lacks a required scope, or cannot access the requested Account ID or Program ID.
`500`	LoudCrowd encountered an unexpected error.

Complete API reference

See List program orders for the interactive request and response contract.

LoudCrowd Brand API for attributed order data