Skip to main content
GET
List samples

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

scope
enum<string>
default:mine
Available options:
mine,
public,
all
limit
integer
default:48
Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned as nextCursor; not bound to page size.

Minimum string length: 1
q
string

Case-insensitive substring match against the sample's display name or filename. The only facet a public release can answer.

Required string length: 1 - 200
status
enum<string>[]

Repeatable lifecycle-status filter. Values compose with OR.

Maximum array length: 5
Available options:
ready,
preprocessing,
uploading,
upload_failed,
preprocess_failed
uploaded_from
string<date>

Inclusive lower bound on upload date in years 0001-9999, as a UTC calendar day. Must not be later than uploaded_to.

Pattern: ^(?!0000-)\d{4}-\d{2}-\d{2}$
uploaded_to
string<date>

Inclusive upper bound on upload date in years 0001-9999, as a UTC calendar day: the whole day is matched.

Pattern: ^(?!0000-)\d{4}-\d{2}-\d{2}$
workflow
enum<string>[]

Repeatable run-state filter: ready_no_job (preprocessed, never submitted), in_flight (a non-terminal job exists), has_results (a completed marker prediction exists). Values compose with OR.

Maximum array length: 3
Available options:
ready_no_job,
in_flight,
has_results
marker
string[]

Repeatable per-marker state filter of the form NAME:state, where state is requested or completed. Marker names cannot contain : or ,. Values compose with AND.

Maximum array length: 20
Pattern: ^[^,:]{1,100}:(requested|completed)$
field
string[]

Repeatable custom-field filter of the form DEFINITION_UUID:op[:VALUE]. op is one of eq, contains, gte, lte, is_empty, is_not_empty; the first four carry a value that is JSON-encoded and then URL-encoded (so "high", 3, true). Operators are checked against the definition's type. Org-defined fields have no meaning on the public cohort. Under scope=all a field facet returns matching organization-owned samples and suppresses public rows; under scope=public it is rejected. Values compose with AND.

Maximum array length: 20
Pattern: ^[0-9a-fA-F-]{36}:(eq|contains|gte|lte)(:.+)$|^[0-9a-fA-F-]{36}:(is_empty|is_not_empty)$

Response

A scoped sample page

items
object[]
required
nextCursor
string | null
required

Opaque cursor for the next item, or null when exhausted.

appUrl
string<uri>
required

Canonical browser URL for this exact scope and filter; pagination omitted.