> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reelevant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List datasources



## OpenAPI

````yaml /api-reference/openapi/datasources-api.json get /
openapi: 3.0.0
info:
  title: datasources-api
  version: 0.0.0
  description: |-
    # Errors
    | Error code | Message | HTTP status code | Payload |
    | :--- | :--- | :--- | :--- |
    | number | string | 409 |  |
servers:
  - url: https://api.reelevant.com/v2/datasources/
    description: production
security: []
paths:
  /:
    get:
      tags:
        - Datasource
      summary: List datasources
      operationId: list-datasource
      parameters:
        - name: ids
          in: query
          schema:
            type: array
            items:
              type: string
            description: Filter on datasources that have on of those ids
          required: false
        - name: name
          in: query
          schema:
            type: string
            description: Filter on datasources that contains that string in the name
          required: false
        - name: mode
          in: query
          schema:
            allOf:
              - $ref: '#/components/schemas/DatasourceMode'
            description: Filter on datasource mode
          required: false
        - name: resourceGroupIds
          in: query
          schema:
            type: array
            items:
              type: string
            description: Filter on datasources with on of those resource groups
          required: false
        - name: typeName
          in: query
          schema:
            type: array
            items:
              $ref: '#/components/schemas/DatasourceType'
            description: Filter on datasource type name
          required: false
        - name: excludedTypeName
          in: query
          schema:
            type: array
            items:
              $ref: '#/components/schemas/DatasourceType'
            description: Ignore those datasource type name
          required: false
        - name: subtype
          in: query
          schema:
            type: array
            items:
              oneOf:
                - type: string
                  enum:
                    - reelevant
                - type: string
                  enum:
                    - google_tag_manager
                - type: string
                  enum:
                    - workflow_events
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - purchases
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - TOP_ATTRIBUTES
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - localized
                - type: string
                  enum:
                    - best_product
                - type: string
                  enum:
                    - bought_together
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - google_my_business
                - type: string
                  enum:
                    - partoo
                - type: string
                  enum:
                    - weather
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - email
            description: Filter on datasource type subtype
          required: false
        - name: excludedSubtypes
          in: query
          schema:
            type: array
            items:
              oneOf:
                - type: string
                  enum:
                    - reelevant
                - type: string
                  enum:
                    - google_tag_manager
                - type: string
                  enum:
                    - workflow_events
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - purchases
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - TOP_ATTRIBUTES
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - localized
                - type: string
                  enum:
                    - best_product
                - type: string
                  enum:
                    - bought_together
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - user
                - type: string
                  enum:
                    - google_my_business
                - type: string
                  enum:
                    - partoo
                - type: string
                  enum:
                    - weather
                - type: string
                  enum:
                    - mutable
                - type: string
                  enum:
                    - email
            description: Ignore those datasource type name
          required: false
        - name: includeLiveOnly
          in: query
          schema:
            type: boolean
            default: null
            description: >-
              Filter on datasources with live data (that can be queried).

              Note: when using this option, the `status` in datasource will
              always be `PUBLISHED` or `PAUSED`
          required: false
        - name: includeGlobals
          in: query
          schema:
            type: boolean
            default: null
            description: Filter on global datasources (no company id nor resource group)
          required: false
        - name: status
          in: query
          schema:
            type: array
            items:
              $ref: '#/components/schemas/DatasourceStatus'
            description: Filter on datasource with one of those statuses
          required: false
        - name: includeArchived
          in: query
          schema:
            type: boolean
            default: null
            description: Display archived datasources
          required: false
        - name: select
          in: query
          schema:
            type: array
            items:
              type: string
            description: >-
              List of fields you want to get, by default the whole datasource
              with versions is returned.

              But you can choose to return only ['name'] to have data: [{ id:
              'bar', name: 'foo' }].

              Note: `id` is always returned
          required: false
        - name: sortBy
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - configurationUpdatedAt
              - type: string
                enum:
                  - createdAt
            default: configurationUpdatedAt
          required: false
        - name: sortOrder
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - asc
              - type: string
                enum:
                  - desc
            default: desc
          required: false
        - name: hierarchy
          in: query
          schema:
            type: array
            items:
              type: string
            description: >-
              Filter on datasources with a specific hierarchy path.

              Pass an array of strings representing the folder path (e.g.,
              ["Marketing", "Q4"] for Marketing > Q4).

              Empty array returns root-level datasources.
          required: false
        - name: page
          in: query
          schema:
            type: number
            default: 1
            minimum: 1
          required: false
        - name: perPage
          in: query
          schema:
            type: number
            default: 10
            minimum: 1
          required: false
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      paginationCount:
                        type: number
                      paginationPage:
                        type: number
                      paginationLimit:
                        type: number
                    required:
                      - paginationCount
                      - paginationPage
                      - paginationLimit
                    additionalProperties: false
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - success
                    required:
                      - status
                    additionalProperties: false
                  - $ref: >-
                      #/components/schemas/InternalResponse_Array_Union_PushDatasource_WorkerDatasource_ProxyDatasource_IngesterDatasource_PubsubDatasource
      security:
        - password_auth: []
components:
  schemas:
    DatasourceMode:
      type: string
      enum:
        - ingester
        - worker
        - proxy
        - pubsub
        - push
    DatasourceType:
      type: string
      enum:
        - generic
        - location
        - product
        - analytics
        - crm
        - push
    DatasourceStatus:
      type: string
      enum:
        - draft
        - published
        - updating
        - paused
        - error
    InternalResponse_Array_Union_PushDatasource_WorkerDatasource_ProxyDatasource_IngesterDatasource_PubsubDatasource:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/PushDatasource'
              - $ref: '#/components/schemas/WorkerDatasource'
              - $ref: '#/components/schemas/ProxyDatasource'
              - $ref: '#/components/schemas/IngesterDatasource'
              - $ref: '#/components/schemas/PubsubDatasource'
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    PushDatasource:
      $ref: '#/components/schemas/AnyValue'
    WorkerDatasource:
      $ref: '#/components/schemas/AnyValue'
    ProxyDatasource:
      $ref: '#/components/schemas/AnyValue'
    IngesterDatasource:
      $ref: '#/components/schemas/AnyValue'
    PubsubDatasource:
      $ref: '#/components/schemas/AnyValue'
    AnyValue:
      description: Can be any value
      nullable: true
  securitySchemes:
    password_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.reelevant.com/v1/auth/token
          refreshUrl: https://api.reelevant.com/v1/auth/token
          scopes: {}

````