Skip to main content
GET
/
api
/
v1
/
sequencing
/
batches
GET sequencing/batches instances
curl --request GET \
  --url https://app.onecodex.com/api/v1/sequencing/batches \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://app.onecodex.com/api/v1/sequencing/batches"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://app.onecodex.com/api/v1/sequencing/batches', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.onecodex.com/api/v1/sequencing/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.onecodex.com/api/v1/sequencing/batches"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.onecodex.com/api/v1/sequencing/batches")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.onecodex.com/api/v1/sequencing/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "$uri": "/api/v1/sequencing/a1b2c3d4e5f67890",
    "batch_number": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "owner": {
      "type": "<unknown>",
      "pattern": "<unknown>",
      "example": "<unknown>"
    }
  }
]
GET all Sequencing Batch instances. Returns a paginated list of Sequencing Batches.

Authorizations

X-API-Key
string
header
required

Query Parameters

page
integer<int32>
default:1

Page number. Defaults to 1. See Pagination for more details.

per_page
integer<int32>
default:50

Number of requested paginated records. Defaults to 50. See Pagination for more details.

sort
object

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

where
object

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

200 - application/json

Successful operation

$uri
string
Pattern: ^/api/v1/sequencing/batches\/[^/]+$
Example:

"/api/v1/sequencing/a1b2c3d4e5f67890"

batch_number
string

A unique batch number.

created_at
string<date-time>

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

name
string

A human-readable name for the sequencing batch.

owner
object

The user that created the sequencing batch.

status
enum<string>

The current status of the sequencing batch.

Available options:
registered,
shipped_to_lab,
received_at_lab,
extracting,
preparing_library,
done,
canceled