List sequences

Returns sequences from all experiments the caller has access to. Results are sorted by creation date (newest first). Filter by experiment_id to retrieve sequences for a specific experiment, or use search to match against sequence names or amino acid content.

GET /api/v1/sequences

List sequences

cURL

curl --request GET \
  --url https://foundry-api-public.adaptyvbio.com/api/v1/sequences \
  --header 'Authorization: Bearer <token>'

200

{
  "count": 123,
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "experiment_code": "<string>",
      "experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_control": true,
      "length": 1,
      "aa_preview": "<string>",
      "name": "<string>"
    }
  ],
  "offset": 123,
  "total": 123
}

Authorizations

Authorization · string · header · required

Biscuit-based bearer token. Obtain tokens from the Adaptyv Portal or via the /tokens endpoint. Tokens encode organization membership and role-based capabilities; the API verifies the token's cryptographic signature and authorization claims before processing requests. Use /tokens/attenuate to create restricted tokens for delegation.

Query Parameters

limit · integer<int64>

Maximum number of items to return (1-100, default 50).

offset · integer<int64>

Number of items to skip (default 0).

search · string

Free-text search term applied to searchable columns.

sort · string

Sort expression. Supports multi-column sort (comma-separated, up to 8), JSONB path access, and type casts.

Three accepted surface forms produce the same ordering:

• Canonical — desc(field) / asc(field); also wraps casts and at(...) JSONB path access. Example: asc(date(at(metadata,start_date))).
• Prefix short form — -field (descending), +field or bare field (ascending). GitHub / Stripe / Jira convention. Bare field only; no casts.
• Suffix short form — field:asc / field:desc. Also bare field.

Examples: -created_at, -created_at,+name, created_at:desc, desc(created_at),asc(name), asc(at(metadata,score)).

experiment_id · string

Filter by experiment UUID

Response

200

application/json

Sequence list

Paginated list response with offset-based navigation metadata.

All list endpoints return this shape. Use offset and limit query parameters to page through results; total reports how many items match the query across all pages.

count · integer<int64> · required

Number of items in this response.

items · object[] · required

The page of results.

Show child attributes

offset · integer<int64> · required

Offset used for this page (mirrors the offset query parameter).

total · integer<int64> · required

Total number of items matching the query (across all pages).