---
title: "List sources"
method: GET
path: "/agency/source"
tags: ["Source"]
---

# List sources

`GET /agency/source`

Retrieves sources within the current agency.

## Query parameters

- `pageSize` integer
- `page` integer
- `query` string
- `category` string
- `order` string
- `forceTokenRefresh` boolean

## Response `200`

Success

- SourceDtoPaginated
  - `total` integer
  - `results` SourceDto[], nullable
    - `agencyId` string, nullable
    - `sourceId` string, nullable
    - `name` string, nullable
    - `category` string, nullable
    - `key` string, nullable
    - `accessToken` string, nullable
    - `address` string, nullable
    - `connected` boolean
    - `autoShutoff` boolean
    - `gracefulGoodbye` boolean
    - `bots` SourceBotDto[], nullable
      - `id` string, nullable
      - `botName` string, nullable
      - `tags` ContactTag[], nullable
        - `name` string, nullable
        - `approveDeny` boolean
        - `id` string, nullable
      - `tagFilterConfig` TagFilterConfig
        - `operator` string, nullable
        - `groups` TagFilterGroup[], nullable
          - `operator` string, nullable
          - `rules` TagFilterRule[], nullable
            - `tagName` string, nullable
            - `tagId` string, nullable
            - `condition` string, nullable
      - `channels` string[], nullable
      - `personaNameOverride` string, nullable
      - `enabled` boolean
    - `accountsWithAccess` string[], nullable
    - `isAvailabilityContactTimezone` boolean
    - `respondWindows` SourceAvailabilityDto[], nullable
      - `dayOfWeekUtc` string, nullable
      - `startTimeUtc` string, nullable
      - `duration` string, nullable
    - `doNotRespondWindows` SourceDoNotRespondWindowDto[], nullable
      - `start` string, date-time
      - `end` string, date-time
    - `botRespondWindows` BotSourceAvailabilityDto[], nullable
      - `dayOfWeekUtc` string, nullable
      - `startTimeUtc` string, nullable
      - `duration` string, nullable
      - `channel` string, nullable
    - `isBotRespondWindowsQuietHours` boolean
    - `summarizeAttachments` boolean
    - `respondToReactions` boolean
    - `markConversationAsUnread` boolean
    - `webhookCallback` string, nullable
    - `scriptInstalled` boolean
    - `scriptLastSeenAt` string, date-time, nullable
    - `scriptLastSeenDomain` string, nullable
    - `scriptLastSeenEndpoint` string, nullable
    - `scriptDomainAllowList` string[], nullable
    - `wallet` SourceWalletDto
      - `reBilling` boolean
      - `autoRefill` boolean
      - `topUpAmount` integer
      - `refillThreshold` integer
      - `stripeCustomerId` string, nullable
      - `currency` string, nullable
      - `responseUnitCostOverride` string, nullable
      - `storageUnitCostOverride` string, nullable
      - `userUnitCostOverride` string, nullable
    - `hubSpotOwnerId` string, nullable
  - `page` integer
  - `pageSize` integer

---

[API](https://skmtc.dev/closebot/apis/closebot-api.md) · [All operations](https://skmtc.dev/closebot/apis/closebot-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/closebot/closebot-api/revisions/da5f5fb58534/schema)