Sign in
Sample

Queries all samples of a participant.

get/participant/{participantId}/samples

Path parameters

participantIdstring required

The id of the participant to query samples for.

Query parameters

fillMissingboolean

Whether to fill missing samples with placeholders.

tagsstring[]

The tags to filter the samples by; a sample matches when any of its prompt tags is in this list.

pageinteger

The 1-based page index.

page_sizeinteger

The number of items per page.

sortstring[]

Sort fields. Prefix with - for descending order (e.g. -created_at).

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by identifier.

eqstring
neqstring
gtstring
gtestring
ltstring
ltestring
containsstring
starts_withstring
ends_withstring
instring[]
not_containsstring

Filter by created_at.

logic'and' | 'or'

How to combine the field filters: "and" (default) requires every filter to match, "or" requires any of them to match.

Response

OK

totalinteger required
pageinteger required
pageSizeinteger required
totalPagesinteger

Changes

Changed in 1 of the 6 revisions of this API.5

  • fdb89a6eb2fb5See the full diff
    • ▲

      the response property items/items/oneOf[GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput]/organizationId became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/items/oneOf[GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput]/ownerId became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/items/oneOf[GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput]/ownerMail became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property items/items/oneOf[GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput]/organizationId became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/items/oneOf[GetSamplesByParticipantEndpoint_ISampleOutputGetSamplesByParticipantEndpoint_SampleOutput]/ownerMail became optional for the status 200

      response-property-became-optional

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog