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

# List sources

> List sources through the Towbar REST API.

Required permissions: repository.read. Personal keys are capped by their owner’s current team role.

See [request conventions](/docs/api/overview) and [automation workflows](/docs/api/workflows). MCP clients use the task-oriented [tool catalogue](/docs/api/mcp-tools).


## OpenAPI

````yaml api-reference/openapi.json GET /sources
openapi: 3.1.0
info:
  title: Towbar API
  version: 2.0.0
  description: >-
    Manage your Towbar control plane with a bearer API key. Keys inherit current
    workspace permissions.
servers:
  - url: https://api.example.com/v1/api
security: []
paths:
  /sources:
    get:
      tags:
        - Repositories / Overview
      summary: List sources
      description: >-
        Required permissions: repository.read. Personal keys are capped by the
        current member role; team keys use explicit grants.
      operationId: get_sources
      parameters:
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
        - name: view
          in: query
          required: false
          schema:
            default: all
            type: string
            enum:
              - all
              - attention
        - name: sync
          in: query
          required: false
          schema:
            type: string
            enum:
              - never
              - queued
              - running
              - succeeded
              - failed
        - name: autoDeploy
          in: query
          required: false
          schema:
            type: string
            enum:
              - enabled
              - paused
      responses:
        '200':
          description: JSON object containing sources.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response_368'
                  - type: object
                    properties:
                      localization:
                        $schema: https://json-schema.org/draft/2020-12/schema
                        type: object
                        properties:
                          dateFormat:
                            type: string
                            enum:
                              - day-short-month-year
                              - short-month-day-year
                              - year-month-day
                              - day-month-year
                              - month-day-year
                          timeFormat:
                            type: string
                            enum:
                              - 24-hour
                              - 12-hour
                              - 24-hour-seconds
                              - 12-hour-seconds
                          timeZone:
                            type: string
                          timestamps:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: object
                              properties:
                                date:
                                  type: string
                                time:
                                  type:
                                    - string
                                    - 'null'
                                dateTime:
                                  type:
                                    - string
                                    - 'null'
                                timeZone:
                                  type: string
                                zoneLabel:
                                  type: string
                                epochMilliseconds:
                                  type: number
                                inputDateTime:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - date
                                - time
                                - dateTime
                                - timeZone
                                - zoneLabel
                                - epochMilliseconds
                                - inputDateTime
                              additionalProperties: false
                        required:
                          - dateFormat
                          - timeFormat
                          - timeZone
                          - timestamps
                        additionalProperties: false
                    required:
                      - localization
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '404':
          $ref: '#/components/responses/ApiError'
        '409':
          $ref: '#/components/responses/ApiError'
        '413':
          $ref: '#/components/responses/ApiError'
        '422':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ApiError'
      security:
        - bearerAuth: []
components:
  schemas:
    Response_368:
      type: object
      properties:
        sources:
          type: array
          items:
            $ref: '#/components/schemas/Response_369'
        counts:
          $ref: '#/components/schemas/Response_370'
      required:
        - sources
        - counts
    Response_369:
      type: object
      properties:
        latestSyncStatus:
          type: string
        autoDeployPaused:
          type: boolean
        createdAt:
          type: string
          format: date-time
        id:
          type: string
        provider:
          anyOf:
            - type: string
              const: github
            - type: string
              const: gitlab
        repositoryName:
          type: string
        repositoryOwner:
          type: string
        status:
          anyOf:
            - type: string
              const: active
            - type: string
              const: archived
        updatedAt:
          type: string
          format: date-time
      required:
        - latestSyncStatus
        - autoDeployPaused
        - createdAt
        - id
        - provider
        - repositoryName
        - repositoryOwner
        - status
        - updatedAt
    Response_370:
      type: object
      properties:
        all:
          type: number
        attention:
          type: number
      required:
        - all
        - attention
  responses:
    ApiError:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
    RateLimited:
      description: Request failed. The error object contains code, message, and requestId.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - requestId
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  requestId:
                    type: string
      headers:
        Retry-After:
          description: Seconds before retrying
          schema:
            type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Towbar API key

````