Skip to main content
GET
/
agency
/
source
List sources
curl --request GET \
  --url https://api.closebot.com/agency/source \
  --header 'X-CB-KEY: <api-key>'
{
  "total": 123,
  "results": [
    {
      "agencyId": "<string>",
      "sourceId": "<string>",
      "name": "<string>",
      "category": "<string>",
      "key": "<string>",
      "accessToken": "<string>",
      "address": "<string>",
      "connected": true,
      "autoShutoff": true,
      "gracefulGoodbye": true,
      "bots": [
        {
          "id": "<string>",
          "botName": "<string>",
          "tags": [
            {
              "name": "<string>",
              "approveDeny": true,
              "id": "<string>"
            }
          ],
          "channels": [
            "<string>"
          ],
          "personaNameOverride": "<string>",
          "enabled": true
        }
      ],
      "accountsWithAccess": [
        "<string>"
      ],
      "isAvailabilityContactTimezone": true,
      "respondWindows": [
        {
          "dayOfWeekUtc": "<string>",
          "startTimeUtc": "<string>",
          "duration": "<string>"
        }
      ],
      "doNotRespondWindows": [
        {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        }
      ],
      "summarizeAttachments": true,
      "respondToReactions": true,
      "markConversationAsUnread": true,
      "webhookCallback": "<string>",
      "wallet": {
        "reBilling": true,
        "autoRefill": true,
        "topUpAmount": 123,
        "refillThreshold": 123,
        "stripeCustomerId": "<string>",
        "currency": "<string>",
        "responseUnitCostOverride": "<string>",
        "storageUnitCostOverride": "<string>",
        "userUnitCostOverride": "<string>"
      }
    }
  ],
  "page": 123,
  "pageSize": 123
}

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Query Parameters

pageSize
integer<int32>
default:20

Size of each page (max 100)

page
integer<int32>
default:0

The page number. For example, page 5 with page size of 20 would start at offset 100.

query
string

Search by source name

category
string

Search by only specific categories (GHL, HubSpot, WebHook, etc)

order
string
default:+id

How results should be ordered. "+" or "-" prefix to specific ascending or descending.

forceTokenRefresh
boolean
default:false

When true, access token for all returned sources are refreshed.

Response

Success

total
integer<int32>
results
object[] | null
page
integer<int32>
pageSize
integer<int32>