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

# List sources



## OpenAPI

````yaml https://api.arklow.io/swagger/ui/json get /v1/orgs/{org_id}/sources/
openapi: 3.1.0
info:
  title: Arklow
  description: Arklow's API
  version: 0.1.0
servers:
  - url: https://api.arklow.io
    description: Production
  - url: http://localhost:3123
    description: Local development
security:
  - apiKey: []
tags:
  - name: actions
  - name: api_keys
  - name: billing
  - name: config
  - name: credentials
  - name: destinations
  - name: invites
  - name: members
  - name: metrics
  - name: notifications
  - name: orgs
  - name: rules
  - name: sources
  - name: users
  - name: ingress
externalDocs:
  url: https://api.arklow.io/swagger/ui
paths:
  /v1/orgs/{org_id}/sources/:
    get:
      tags:
        - sources
      summary: List sources
      operationId: get_v1_orgs_by_org_id_sources
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 50
          in: query
          name: take
          required: false
        - schema:
            type: integer
            minimum: 0
          in: query
          name: skip
          required: false
        - schema:
            anyOf:
              - anyOf:
                  - type: object
                    required:
                      - col
                      - op
                    properties:
                      col:
                        type: string
                      op:
                        anyOf:
                          - type: string
                            enum:
                              - eq
                          - type: string
                            enum:
                              - neq
                          - type: string
                            enum:
                              - starts_with
                          - type: string
                            enum:
                              - contains
                          - type: string
                            enum:
                              - not_contains
                          - type: string
                            enum:
                              - is_null
                          - type: string
                            enum:
                              - is_not_null
                      value:
                        type: string
                  - type: array
                    items:
                      type: object
                      required:
                        - col
                        - op
                      properties:
                        col:
                          type: string
                        op:
                          anyOf:
                            - type: string
                              enum:
                                - eq
                            - type: string
                              enum:
                                - neq
                            - type: string
                              enum:
                                - starts_with
                            - type: string
                              enum:
                                - contains
                            - type: string
                              enum:
                                - not_contains
                            - type: string
                              enum:
                                - is_null
                            - type: string
                              enum:
                                - is_not_null
                        value:
                          type: string
              - type: string
          in: query
          name: search
          required: false
        - schema:
            type: string
          in: query
          name: field
          required: false
        - schema:
            type: string
          in: query
          name: value
          required: false
        - schema:
            anyOf:
              - type: string
                enum:
                  - eq
              - type: string
                enum:
                  - neq
              - type: string
                enum:
                  - starts_with
              - type: string
                enum:
                  - contains
              - type: string
                enum:
                  - not_contains
              - type: string
                enum:
                  - is_null
              - type: string
                enum:
                  - is_not_null
          in: query
          name: op
          required: false
        - schema:
            type: boolean
          in: query
          name: count_only
          required: false
        - schema:
            anyOf:
              - type: string
                enum:
                  - aws_sqs
              - type: string
                enum:
                  - google_pubsub
          in: query
          name: type
          required: false
        - schema:
            anyOf:
              - type: string
                enum:
                  - active
              - type: string
                enum:
                  - paused
          in: query
          name: status
          required: false
        - schema:
            type: string
            pattern: ^[0-9]+$
          in: query
          name: credential_id
          required: false
        - schema:
            type: string
            pattern: ^[0-9]+$
          in: path
          name: org_id
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - errors
                properties:
                  data:
                    anyOf:
                      - type: object
                        required:
                          - items
                          - count
                        properties:
                          items:
                            type: array
                            items:
                              allOf:
                                - type: object
                                  required:
                                    - id
                                    - org_id
                                    - name
                                    - status
                                    - ingest
                                    - runtime
                                    - version
                                    - applied_version
                                    - generation
                                    - updated_at
                                  properties:
                                    id:
                                      type: string
                                    org_id:
                                      type: string
                                    name:
                                      type: string
                                    status:
                                      anyOf:
                                        - type: string
                                          enum:
                                            - active
                                        - type: string
                                          enum:
                                            - paused
                                    ingest:
                                      type: object
                                      required:
                                        - variant
                                      properties:
                                        variant:
                                          type: string
                                        version:
                                          type: integer
                                          minimum: 1
                                      additionalProperties: false
                                    runtime:
                                      type: object
                                      required:
                                        - min_shards
                                        - max_shards
                                        - desired_shards
                                        - max_inflight
                                        - poll_wait_seconds
                                        - lease_ttl_seconds
                                        - heartbeat_seconds
                                      properties:
                                        min_shards:
                                          type: integer
                                          minimum: 1
                                        max_shards:
                                          type: integer
                                          minimum: 1
                                        desired_shards:
                                          type: integer
                                          minimum: 1
                                        max_inflight:
                                          type: integer
                                          minimum: 1
                                        poll_wait_seconds:
                                          type: integer
                                          minimum: 1
                                        lease_ttl_seconds:
                                          type: integer
                                          minimum: 1
                                        heartbeat_seconds:
                                          type: integer
                                          minimum: 1
                                    version:
                                      type: string
                                      pattern: ^[0-9]+$
                                    applied_version:
                                      type: string
                                      pattern: ^[0-9]+$
                                    generation:
                                      type: string
                                      pattern: ^[0-9]+$
                                    planner_updated_at:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                          format: date-time
                                    updated_at:
                                      type: string
                                      format: date-time
                                    deleted_at:
                                      anyOf:
                                        - type: 'null'
                                        - type: string
                                          format: date-time
                                - type: object
                                  properties:
                                    credential_id:
                                      anyOf:
                                        - type: string
                                          pattern: ^[0-9]+$
                                        - type: 'null'
                                - anyOf:
                                    - type: object
                                      required:
                                        - type
                                        - config
                                      properties:
                                        type:
                                          type: string
                                          enum:
                                            - aws_sqs
                                        config:
                                          type: object
                                          required:
                                            - queue_url
                                            - region
                                          properties:
                                            queue_url:
                                              type: string
                                              format: uri
                                            region:
                                              type: string
                                    - type: object
                                      required:
                                        - type
                                        - config
                                      properties:
                                        type:
                                          type: string
                                          enum:
                                            - google_pubsub
                                        config:
                                          type: object
                                          required:
                                            - project_id
                                            - subscription_id
                                          properties:
                                            project_id:
                                              type: string
                                            subscription_id:
                                              type: string
                          count:
                            type: integer
                      - type: 'null'
                  errors:
                    anyOf:
                      - type: array
                        items:
                          type: object
                          required:
                            - code
                            - message
                          properties:
                            code:
                              type: string
                            message:
                              type: string
                      - type: 'null'
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-arklow-auth
      in: header

````