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

url = "https://app.onecodex.com/api/v1/samples/{id}"

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/samples/{id}', 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/samples/{id}",
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/samples/{id}"

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/samples/{id}")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.onecodex.com/api/v1/samples/{id}")

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/samples/0d77065796f8d173",
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {
    "__DOLLAR_REF__": "/api/v1/metadata/a1b2c3d4e5f67890"
  },
  "owner": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  },
  "primary_classification": {
    "__DOLLAR_REF__": "/api/v1/classifications/a1b2c3d4e5f67890"
  },
  "error_msg": "<string>",
  "filename": "<string>",
  "project": {
    "__DOLLAR_REF__": "/api/v1/projects/a1b2c3d4e5f67890"
  },
  "size": 123,
  "tags": [],
  "updated_at": "2023-11-07T05:31:56Z"
}
GET a single sample by its ID.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

Response

200 - application/json

OK

$uri
string
required
read-only
Pattern: ^/api/v1/samples/[a-f0-9]{16}$
Example:

"/api/v1/samples/0d77065796f8d173"

created_at
string<date-time>
required

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

metadata
metadata · object
required

A metadata object.

owner
users · object
required

The owner of the sample.

primary_classification
classifications · object | null
required

A reference to a Classification for the sample. This will typically be the One Codex Database or Targeted Loci Database results as appropriate. Note that samples will not have a primary_classification while they are still importing or being uploaded.

status
enum<string>
required

Enum for user-facing data status.

This is a subset of DataStatus for the status attribute in the APIs.

Available options:
awaiting_data,
importing,
validating,
failed_validation,
available,
deleted
visibility
enum<string>
required

Enum for the v1 API visibility attribute.

Note: this is legacy and only exists for backwards-compatibility in the public v1 API.

Available options:
public,
shared,
private,
importing,
awaiting data
error_msg
string | null

An error message if the sample failed to upload, import, or validate.

filename
string | null

The sample filename.

project
projects · object

The project the sample belongs to (optional).

size
integer | null

The size of the uploaded file in bytes.

tags
tags · object[]

An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.

updated_at
string<date-time> | null

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