Skip to main content
GET
List sample types

Headers

X-Delogue-Api
string

Query Parameters

Free-text search across sample type names.

Ids
integer<int64>[]

Filter to sample types with any of these identifiers.

Names
string[]

Filter to sample types whose name exactly matches any of these values.

State
enum<string>

Filter by lifecycle state. A deleted value is rejected because sample types have no soft-delete state. Lifecycle state of the sample type. An inactive sample type cannot be selected when creating new sample requests.

Available options:
active,
inactive,
deleted
CommentDeadline

Filter to sample types whose comment deadline matches this number of days after the sample is received.

Properties
string[]

Extensibility presence-set filter. Currently supports isLocked to return only sample types locked by a season milestone.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, Position.

pageSize

Number of items per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

Opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.