Skip to main content
GET
/
offers-exports
Get all export requests
curl --request GET \
  --url https://api.fabric.inc/v3/offers-exports \
  --header 'Authorization: Bearer <token>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
  "query": {
    "size": 10,
    "offset": 10,
    "count": 50
  },
  "data": [
    {
      "exportId": "ab50fe48-5da0-4e77-92d1-bb629eedf19e",
      "startedAt": "2023-05-17T21:24:52.398Z",
      "status": "IN_PROGRESS",
      "type": "REDEMPTION",
      "endedAt": "null",
      "totalDataExported": 0,
      "fileId": "redemption/tenantId/1687294954996-redemption-export.csv"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24
​
x-fabric-channel-id
string

The sales channel ID.

Example:

"12"

​
x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

​
x-fabric-request-id
string

A unique request ID.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Query Parameters

​
size
integer<int32>
default:10

The maximum number of records per page.

Required range: 1 <= x <= 100
​
offset
integer<int32>
default:0

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

Required range: x >= 0
Example:

0

​
sort
string

Field to sort export requests

Example:

"+startedAt"

​
type
enum<string>

Type of data to export

Available options:
REDEMPTION,
CALCULATED_PRICE
Example:

"REDEMPTION"

Response

OK

A paginated response of export requests.

​
query
object

Provides pagination data.

​
data
object[]

The response data.