Skip to content
Probatix API Documentation

Retrieves the collection of SpecimenCollectionKit resources.

GET
/sck/v1/kits
curl --request GET \
  --url 'http://api.probatix.localhost/sck/v1/kits?page=1&sort%5BcreatedAt%5D=asc&sort%5Bid%5D=asc&XDEBUG_SESSION=PHPSTORM' \
  --header 'X-API-TOKEN: <X-API-TOKEN>' \
  --header 'accept-language: de'

Retrieves the collection of SpecimenCollectionKit resources.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
accept-language
string
Allowed values: de en fr

Language for Errors and Translatable properties

Example
de

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1

The collection page number

createdAt[gt]
string

Return resources with createdAt greater than the given timestamp.

createdAt[gte]
string

Return resources with createdAt greater than or equal to the given timestamp.

createdAt[lt]
string

Return resources with createdAt less than the given timestamp.

createdAt[lte]
string

Return resources with createdAt less than or equal to the given timestamp.

kit[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

order[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

product[]
Array<string>

Filter by identifier, IRI, or canonical identifier.

sort[createdAt]
string
Allowed values: asc desc ASC DESC

SpecimenCollectionKit sort[createdAt]

sort[id]
string
Allowed values: asc desc ASC DESC

SpecimenCollectionKit sort[id]

XDEBUG_SESSION
string
default: PHPSTORM

Xdebug session for debugging

Example
?XDEBUG_SESSION=PHPSTORM

Responses

Section titled “Responses”

200

Section titled “200”

SpecimenCollectionKit collection

Array<object>
object
id
required
string format: uuid
product
required

IRI of the specimen collection kit product this kit belongs to.

string format: iri-reference
fulfillmentData

Optional fulfillment-specific data. Values must be JSON primitive values.

object | null
createdAt
required
string format: date-time
Example
[
  {
    "product": "/sck/v1/products/00112233-4455-6677-8899-aabbccddeeff",
    "fulfillmentData": {
      "barcode": "PX-123456789",
      "kitId": "KIT-2026-000123",
      "verified": true
    },
    "createdAt": "2026-06-29T10:30:00+00:00"
  }
]

401

Section titled “401”

Unauthorized

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}

403

Section titled “403”

Forbidden

A representation of common errors.

object
@context
One of:
string
@id
required
string
@type
required
string
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string
description
string | null
Example
{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  },
  "status": 400
}