---
title: "List all sources"
method: GET
path: "/api/v1/external/sources"
tags: ["Sources"]
---

# List all sources

`GET /api/v1/external/sources`

## Request

- Base URL: `https://api.wove.com`
- URL: `https://api.wove.com/api/v1/external/sources`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/wove/apis/wove-external-api/docs/api/v1/external/sources/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of all rate sheet sources for your organization.

Sources can be filtered by status and sorted by various fields.

## Query parameters

- `status` 'awaiting_upload' | 'pending' | 'processing' | 'complete' | 'failed'
- `carrierId` string
- `limit` integer
- `offset` integer

## Response `200`

Sources retrieved successfully

- object
  - `success` boolean
  - `data` object
    - `sources` ExternalSourceSummary[]
      - `id` string: Source ID
      - `filename` string: Original filename
      - `status` 'awaiting_upload' | 'pending' | 'processing' | 'complete' | 'failed': Processing status
      - `sourceType` 'contract' | 'spot' | 'tariff'
      - `carrierId` string
      - `carrierName` string
      - `rateCount` integer: Number of rates extracted from this source
      - `effectiveDate` string, date
      - `expiryDate` string, date
      - `createdAt` string, date-time
      - `processedAt` string, date-time
    - `total` integer: Total number of sources matching the filter

## Other responses

- `401`: Authentication required

---

[API](https://skmtc.dev/wove/apis/wove-external-api.md) - [All operations](https://skmtc.dev/wove/apis/wove-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wove/apis/wove-external-api/revisions/37290e267e07?raw)
