Built-in tool

Read an outreach queue

Read an outreach queue: ready leads, days of cover at a daily volume, what is excluded and why, and source yield over time.

Freeno per-call chargeNo API key needed

Endpoint

Parameters

NameTypeRequiredNote
listIdstring · requiredstringrequired

The List to read, from search-lists. A List that is not marked as a queue is read with the default rules.

yieldDaysnumber · optionalnumberoptional

The window, in days, for source yield.

Default: 14

readyLimitnumber · optionalnumberoptional

Return the UUIDs of the first N ready leads, in queue order (for example today's send list). 0 returns counts only.

Default: 0

dailyVolumenumber · optionalnumberoptional

Leads outreach uses per day, to compute days of cover. Defaults to the volume saved on the queue.

includeYieldboolean · optionalbooleanoptional

Include source yield (what each source found, added and what passed review).

Default: true

Response schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "success"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "The List's name (same as listName), under the key a List result is titled by."
    },
    "error": {
      "type": "string"
    },
    "ready": {
      "type": "number",
      "description": "Members that can be contacted now under the queue rules."
    },
    "listId": {
      "type": "string"
    },
    "target": {
      "type": [
        "number",
        "null"
      ],
      "description": "Ready leads the queue should hold. Null when no target is set."
    },
    "isQueue": {
      "type": "boolean"
    },
    "members": {
      "type": "number",
      "description": "Live Records in the List."
    },
    "message": {
      "type": "string"
    },
    "partial": {
      "type": "boolean",
      "description": "True when the List holds more Records than one read covers; counts are for the first part only."
    },
    "success": {
      "type": "boolean"
    },
    "listName": {
      "type": "string"
    },
    "notReady": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "reason",
          "meaning",
          "count",
          "examples"
        ],
        "properties": {
          "count": {
            "type": "number"
          },
          "reason": {
            "enum": [
              "do_not_contact",
              "already_contacted",
              "already_replied",
              "in_another_queue",
              "same_company",
              "sent_from_this_list",
              "on_hold",
              "awaiting_review",
              "failed_review",
              "no_contact_details"
            ],
            "type": "string"
          },
          "meaning": {
            "type": "string"
          },
          "examples": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "recordId"
              ],
              "properties": {
                "name": {
                  "type": "string"
                },
                "detail": {
                  "type": "string"
                },
                "recordId": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "description": "Members that are not ready, by reason, with a few examples each."
    },
    "settings": {
      "type": "object",
      "required": [
        "targetDepth",
        "targetDays",
        "dailyVolume",
        "onePersonPerCompany",
        "excludeOtherQueues",
        "recontactAfterDays",
        "reviewFieldId",
        "reviewPassValues"
      ],
      "properties": {
        "targetDays": {
          "type": [
            "number",
            "null"
          ],
          "description": "Days of cover the queue should hold, when set in days (target = days x daily volume)."
        },
        "dailyVolume": {
          "type": [
            "number",
            "null"
          ],
          "description": "Leads outreach uses per day, as saved on the queue."
        },
        "targetDepth": {
          "type": [
            "number",
            "null"
          ],
          "description": "Ready leads the queue should hold, when set as a number."
        },
        "reviewFieldId": {
          "type": [
            "string",
            "null"
          ]
        },
        "reviewPassValues": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "excludeOtherQueues": {
          "type": "boolean"
        },
        "recontactAfterDays": {
          "type": [
            "number",
            "null"
          ],
          "description": "After this many days a contacted person counts as ready again. Null: never."
        },
        "onePersonPerCompany": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "shortfall": {
      "type": [
        "number",
        "null"
      ],
      "description": "How many more ready leads the target needs. 0 when the queue is at or above it."
    },
    "dailyVolume": {
      "type": [
        "number",
        "null"
      ]
    },
    "daysOfCover": {
      "type": [
        "number",
        "null"
      ],
      "description": "ready / dailyVolume. Null when no daily volume is known."
    },
    "sourceYield": {
      "type": "object",
      "required": [
        "sinceDays",
        "sources"
      ],
      "properties": {
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "source",
              "kind",
              "runs",
              "found",
              "added",
              "alreadyInList",
              "excluded",
              "reviewed",
              "passedReview",
              "firstRunAt",
              "lastRunAt",
              "recentRuns",
              "trend"
            ],
            "properties": {
              "kind": {
                "enum": [
                  "lead_finder",
                  "added_directly"
                ],
                "type": "string"
              },
              "runs": {
                "type": "number"
              },
              "added": {
                "type": "number"
              },
              "found": {
                "type": "number"
              },
              "trend": {
                "enum": [
                  "new",
                  "steady",
                  "falling",
                  "drying",
                  "dry"
                ],
                "type": "string"
              },
              "source": {
                "type": "string"
              },
              "filters": {},
              "excluded": {
                "type": "object",
                "additionalProperties": {
                  "type": "number"
                }
              },
              "reviewed": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "lastRunAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "firstRunAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "recentRuns": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "importId",
                    "at",
                    "found",
                    "added",
                    "newShare"
                  ],
                  "properties": {
                    "at": {
                      "type": "string"
                    },
                    "added": {
                      "type": "number"
                    },
                    "found": {
                      "type": "number"
                    },
                    "importId": {
                      "type": "string"
                    },
                    "newShare": {
                      "type": [
                        "number",
                        "null"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              },
              "passedReview": {
                "type": [
                  "number",
                  "null"
                ]
              },
              "alreadyInList": {
                "type": "number"
              }
            },
            "additionalProperties": false
          }
        },
        "sinceDays": {
          "type": "number"
        }
      },
      "additionalProperties": false
    },
    "readyRecordIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Get started

How to use this tool

  1. Connect your AI

    Add Connie to ChatGPT, Claude or Slack once, and this tool comes with it. There’s no API key or account to set up.

  2. Ask for the outcome

    Describe what you need in plain words. Your AI runs this tool when the job calls for it, along with any others it needs.

  3. Make it a workflow

    Add it as a step in a workflow that runs the same way every time, on a schedule or when something happens.

  4. Stay in control

    Choose whether it runs on its own or asks first. When it asks, you see an Allow or Deny card before any credits are spent.