v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Sequence APIs

List sequences created within Recruiterflow.

<br/>Returns a paginated, filterable list of sequences with per-sequence<br/>performance stats and a recipient_status breakdown.<br/><br/>Pagination is required: current_page is 1-based and items_per_page may be<br/>at most 100.<br/><br/>Optional filters is a list of objects. Supported keys (valid ids come from<br/>the /api/external/sequences/reference-data endpoint):<br/> - status (values: list of status ids)<br/> - sequence_type_ids (values: list of sequence type ids)<br/><br/>Optional q searches by sequence name. Optional sort is an object with<br/>on (one of sequence_name, sequence_type, sequence_status, created_at)<br/>and order (ASC or DESC); it defaults to newest first.<br/>

post/api/external/sequences/list

Headers

RF-Api-Keystring
content-typestring

Request body

current_pageinteger required

1-based page number.

items_per_pageinteger required

Records per page (maximum 100).

qstring

Optional case-insensitive search on the sequence name.

Example request

{
  "current_page": 1,
  "filters": [
    {
      "key": "status",
      "values": [
        2,
        3
      ]
    }
  ],
  "items_per_page": 10,
  "q": "Outbound",
  "sort": {
    "on": "created_at",
    "order": "DESC"
  }
}

Response

Paginated list of sequences

{"stackTrail":"paths:/api/external/sequences/list:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"created_at":"2026-06-01 10:15:00","id":42,"name":"Outbound - Senior Engineers","owner":{"id":3264,"name":"Jane Recruiter"},"recipient_status":{"detail":[],"total":12},"sequence_status":{"id":2,"name":"In Progress"},"sequence_type":{"id":1,"name":"Candidate"},"stats":[]}],"total_items":1}}

Example response

{
  "data": [
    {
      "created_at": "2026-06-01 10:15:00",
      "id": 42,
      "name": "Outbound - Senior Engineers",
      "owner": {
        "id": 3264,
        "name": "Jane Recruiter"
      },
      "recipient_status": {
        "detail": [],
        "total": 12
      },
      "sequence_status": {
        "id": 2,
        "name": "In Progress"
      },
      "sequence_type": {
        "id": 1,
        "name": "Candidate"
      },
      "stats": []
    }
  ],
  "total_items": 1
}