---
title: "Lists sources"
method: GET
path: "/sources"
tags: ["Source"]
---

# Lists sources

`GET /sources`

## Request

- Base URL: `http://localhost:3001/api`
- URL: `http://localhost:3001/api/sources`
- Auth: none declared

## Query parameters

- `page` integer
- `limit` integer
- `url` string
- `access_token` string

## Response `200`

OK

- SourceArray
  - `sources` Source[]
    - `name` string: Human readable name of a source
    - `origin` object
      - `url` string: Source location, can be http, https, or s3 schemes. This must be the link to the source data download.
      - `license` string: The license under which we have the right to ingest the data. Ideally a SPDX identifier (https://spdx.org/licenses/).
      - `providerName` string: The organisation or individual who collects the data in this source.
      - `providerWebsiteUrl` string: The provider's website, or where possible their specific site for information about this outbreak (including the source data used here).
    - `format` string: Format of the source to be ingested, useful when automated ingestion
    - `dateFilter` object
      - `numDaysBeforeToday` number
      - `op` 'EQ' | 'GT' | 'LT'
    - `notificationRecipients` string[]: List of addresses to be notified of important changes to the source.
    - `excludeFromLineList` boolean: Whether cases from this source should be left out of the line list feed.
    - `hasStableIdentifiers` boolean: Whether the source includes identifiers for individual cases that remain the same over time.
    - `automation` object
      - `parser` object
        - `awsLambdaArn` string
      - `regexParsing` object
        - `fields` object[]
          - `name` string
          - `regex` string
      - `schedule` object
        - `awsRuleArn` string
        - `awsScheduleExpression` string, required
    - `uploads` Upload[]
      - `status` 'IN_PROGRESS' | 'SUCCESS' | 'ERROR'
      - `summary` object
        - `numCreated` integer
        - `numUpdated` integer
        - `error` 'INTERNAL_ERROR' | 'SOURCE_CONFIGURATION_ERROR' | 'SOURCE_CONFIGURATION_NOT_FOUND' | 'SOURCE_CONTENT_NOT_FOUND' | 'SOURCE_CONTENT_DOWNLOAD_ERROR' | 'PARSING_ERROR' | 'VALIDATION_ERROR' | 'DATA_UPLOAD_ERROR' | 'TIMEOUT'
      - `created` union
        - string
        - object
        - number
  - `nextPage` integer
  - `total` integer

## Other responses

- `400`: Malformed request
- `403`: Forbidden
- `422`: Unprocessable entity
- `500`: Internal server error

## Changes

- **2022-04-19** `7b73390be316`: 1 info
  - added the media type `application/json` for the response with the status `403`
- **2022-02-24** `b0740a7c62bb`: 4 info
  - added the optional property `items/origin/providerName` to the response with the `200` status
  - added the optional property `items/origin/providerWebsiteUrl` to the response with the `200` status
  - added the optional property `sources/items/origin/providerName` to the response with the `200` status
  - added the optional property `sources/items/origin/providerWebsiteUrl` to the response with the `200` status
- **2021-06-16** `7684749a2389`: 2 info
  - added the optional property `items/hasStableIdentifiers` to the response with the `200` status
  - added the optional property `sources/items/hasStableIdentifiers` to the response with the `200` status
- **2021-03-05** `3c824ebb2004`: 4 warning, 2 info
  - added the new `TIMEOUT` enum value to the `items/uploads/items/summary/error` response property for the response status `200`
  - added the new `TIMEOUT` enum value to the `sources/items/uploads/items/summary/error` response property for the response status `200`
  - added the new `XLSX` enum value to the `items/format` response property for the response status `200`
  - added the new `XLSX` enum value to the `sources/items/format` response property for the response status `200`
  - …2 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/changes/sources/get.md)

---

[API](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api.md) - [All operations](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/globaldothealth/apis/global-health-curator-service-api/revisions/5b1151265235?raw)