> For the complete documentation index, see [llms.txt](https://claimlane-docs.gitbook.io/claimlane-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://claimlane-docs.gitbook.io/claimlane-docs/troubleshooting-and-faqs/raw-data-endpoint-documentation.md).

# Raw Data Endpoint Documentation

Let’s start by looking at how to manually export your data from Claimlane.\
This is a great way to preview the data structure and see exactly what data will be included in the response. It also allows you to generate the API URL you’ll need if you want to automate the export later.

If you are not interested in this step you can skip to [Export Raw Data via API](#h_5a9c246eaf)

### How to Export Data via Claimlane <a href="#h_1e2c026528" id="h_1e2c026528"></a>

1. Log into Claimlane and go to your Inbox.
2. Click the four-square icon in the top-right corner to access your Company Dashboard.

   <img src="https://downloads.intercomcdn.com/i/o/tbixbicd/1565851416/b3419ea1ed420b75f3dfd8f9141d/Captura+de+pantalla+2025-06-11+a+las+13_43_47.png?expires=1759142700&#x26;signature=eb0bf9dc023b43e2f74ae6e004f6353e2b3bad22451a277ca43f5f5d800ab078&#x26;req=dSUhE8F7nIVeX%2FMW1HO4zRVZDon9R1a3QiDn%2BNnltlZc9XG1WA1oZAE82MjE%0A9n5%2B%0A" alt="" width="560">
3. In the left-hand menu, click “Data Export”.

   <img src="https://downloads.intercomcdn.com/i/o/tbixbicd/1565852958/5e129dbf902a2d37da7f0d451b90/Captura+de+pantalla+2025-06-11+a+las+13_44_32.png?expires=1759142700&#x26;signature=c513e5f33466a2671c5c02c09f093bb545f5981a747013578c78e1c79f8ec098&#x26;req=dSUhE8F7n4haUfMW1HO4zR6xApCQ%2F1a4IlIfQboOlYSizYNnerr%2FTiD9TK1S%0AuMFb%0A" alt="" width="560">
4. Choose Organisation type, Data type, Retailers and the time range :
   * Examples: `This month`, `Last 3 months`, `All time`
5. Click the “Export Data” button.

What happens next?\
You’ll receive an email (or multiple emails if the export is large) with your raw data attached.\
​\
We recommend trying this manually at least once to understand the format and content of the data before using the API.\
​

### Accessing the API URL <a href="#h_f18e420ce0" id="h_f18e420ce0"></a>

Once you’ve set up and exported your data:

1. In the Data Export section, click “Show API URL”.
2. You’ll get a custom API URL based on your selection and timeframe.
3. You can use this URL to automate exports using the Claimlane API.\
   ​

### Export Raw Data via API <a href="#h_5a9c246eaf" id="h_5a9c246eaf"></a>

Endpoint: /v2/company/raw-data

Auth: API key will be provided by <support@claimlane.com>\
​

### Query Parameters <a href="#h_0ce477df8c" id="h_0ce477df8c"></a>

* `fromDateUnix` (number)**\*Required**:\
  The start of the date range in Unix timestamp (seconds since 1st January,1970).\
  Example: `fromDateUnix=1748728800`\
  ​
* `toDateUnix` (number)**\*Required**:\
  The end of the date range in Unix timestamp (seconds since 1st January,1970).\
  Example: `toDateUnix=1751320799`\
  ​
* `organizationIds` (string)**\*Required**:\
  You can find your organisation ID in Claimlane's inbox URL: `app.claimlane.com/home/supplier or retailer/yourOrganizationId/`

  ![](https://downloads.intercomcdn.com/i/o/tbixbicd/1565994638/7336171e2167edfa9c6171d4cb64/Captura+de+pantalla+2025-06-11+a+las+15_20_45.png?expires=1759142700\&signature=a679baf9fc8d3ab07067c35689647171e0c4c5d701a4d167f339bec77858c6ff\&req=dSUhE8B3mYdcUfMW1HO4zYyIzS5ZqdKT1h1K3TbDGfrYv8Rcgf3WGH7psa09%0AtKUL%0A)

  \
  One or more organization IDs (comma-separated if multiple).\
  Example: `organizationIds=6156c67d45b7d67ffc34ec45`\
  ​
* `companyId` (string):\
  Your company’s Claimlane ID, you can find it in the URL in your company view:\
  ​`app.claimlane.com/company/yourCompanyId`

  ![](https://downloads.intercomcdn.com/i/o/tbixbicd/1565993466/020ee835b61ad27b82b943ffbbb0/Captura+de+pantalla+2025-06-11+a+las+15_19_46.png?expires=1759142700\&signature=0200111db876d6022ec2283195f1201d39ae182b08dd64a7a6b8b48653370295\&req=dSUhE8B3noVZX%2FMW1HO4zcxyoVaTrFiSn%2FB1BW30oEmka1kMPF6hT0b32uy0%0ACefZ%0A)

  \
  Example: `companyId=5f7eb30eee60d30d43f79c06`\
  ​
* `dataType` (string)**\*Required**:\
  The type of data to export.\
  Examples: `b2cProductData`, `b2bProductData`, `b2cWorkloadData`, `b2cWorkloadData`

  \
  ​
* `organizationType` (string)**\*Required**:\
  Filter by type of organization.\
  Example: `organizationType=retailer`, `organizationType=supplier`\
  ​
* `page` (number):\
  Page number for paginated results (default: 1).\
  Example: `page=2`, `page=3`, `page=4`\
  ​
* `format=map`:

  You can add `format=map` to your request to receive the data in a flattened, map-friendly format.\
  Instead of returning deeply nested arrays or objects, the response is structured in a more Power BI–friendly format that’s easier to parse and visualize.\
  ​

### ⚠️ Common Error Messages <a href="#h_aed3395c31" id="h_aed3395c31"></a>

401 Unauthorized

"Missing or invalid API key."\
Make sure you're including your API key in the `api-key` header. Example:\
​`api-key: sk_live_yourkeyhere`

403 Forbidden

"You do not have access to this resource."\
Your API key is valid but doesn’t have permission to access the requested data (e.g. wrong company or organization).

500 Internal Server Error

"Something went wrong on our end."\
Unexpected issue on the server. Try again later. If the problem persists, contact <support@claimlane.com>.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://claimlane-docs.gitbook.io/claimlane-docs/troubleshooting-and-faqs/raw-data-endpoint-documentation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
