v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Sequence Folders

List sequences in a folder

<small>Requires the sequences:read scope (or a broader one that includes it).</small>

Returns a paginated list of sequences in a folder

get/v3/sequence-folders/{id}/sequences

Path parameters

idstring uuid required

Sequence folder Id

Query parameters

topinteger

Maximum number of items to return

skipinteger

Number of items to skip

sort_bystring

Field to sort by

sort_direction'asc' | 'desc'

Sort direction (asc or desc)

Response

List of sequences in folder retrieved successfully

hasMoreboolean

Indicates if there are more items to fetch

Example response

{
  "items": [
    {
      "id": 12345,
      "ownerUserId": 42,
      "name": "Sales Outreach",
      "status": "active",
      "created": "2024-03-08T10:00:00+00:00",
      "isArchived": false,
      "health": "healthy"
    },
    {
      "id": 12346,
      "ownerUserId": 42,
      "name": "Follow-up Campaign",
      "status": "paused",
      "created": "2024-03-07T14:30:00+00:00",
      "isArchived": false,
      "health": "degraded"
    }
  ],
  "hasMore": true
}