Skip to main content
GET
/
outreach-sequences
List outreach sequences
curl --request GET \
  --url https://api.gospott.com/outreach-sequences \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "PENDING",
      "purpose": "GENERIC",
      "vacancy": {
        "id": "<string>"
      },
      "candidate": {
        "id": "<string>"
      },
      "createdBy": {
        "id": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "modifiedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Query Parameters

​
limit
number
default:25

Number of outreach sequences to return per page (min: 1, max: 100, default: 25)

Required range: 1 <= x <= 100
​
searchQuery
string

Filter outreach sequences by name (case-insensitive partial match). Must be at least 3 characters when provided.

Minimum string length: 3
​
cursor
string

Base64-encoded cursor for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

Response

Outreach sequences retrieved successfully

​
items
object[]
required

Sequences in the current page, sorted by modifiedAt desc.

​
pagination
object
required

Cursor pagination metadata.