Introduction

The Benchling In Vivo API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The Benchling In Vivo API uses OAuth 2.0 access tokens to authenticate requests. These Bearer tokens are the predominant type of access token used with OAuth 2.0.

The Client Credentials grant type is used by clients to obtain an access token outside of the context of a user.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Data Model

The diagram below provides a high-level overview of the entities in the In Vivo API and their relationships.

Data Model

Errors

Benchling In Vivo uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a request failed, etc.). Codes in the 5xx range indicate an error with the In Vivo servers (these are rare).

Metadata

Benchling In Vivo entities have a metadata parameter. You can use this parameter to attach key-value data to these In Vivo entities.

Supported metadata types: cage, group, sample, study, animal, project, project_role, attachment, user, treatment, disease.

Metadata filtering

You can perform filtering of List API responses on metadata that you’ve added to entities that support it.

You can use the metadata query param so the filter term only looks up metadata values. To filter for a specific metadata key-value pair, use the metadata key name as a query param, such as study-internal-id=STUDY-1234.

Metadata Glossary

Benchling In Vivo entities that can attach metadata can store a glossary field, used to design a schema. For example you can set metadata to be a select field, or a date field.

Supported field types: text, select, multi_select, lookup_select, lookup_multi_select, date, numeric.

The lookup_select and lookup_multi_select field types are only supported for study, group, treatment, and disease metadata.
For attachment metadata, the multi_select field type is not supported.

Pagination

All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list studies, list animals, and list cages. These list API methods share a common structure, taking at least these three parameters: limit, page, perPage.

Object limits per request

Some endpoints let you create or update several objects in a single request—for example, terminating multiple animals or assigning users to a task spec. To keep requests responsive, these endpoints accept up to 100 objects per request.

Requests that include more than 100 objects are rejected. To process larger sets, split them across multiple requests.

Rate Limiting

The Benchling In Vivo API enforces rate limits to ensure fair and reliable access for all users. Each tenant is allocated a fixed number of requests within a fixed time window; requests that exceed the limit are rejected until the window resets.

Default Limits

Scope Limit Window

Per API key

300 requests

30 seconds

Per tenant (all API keys combined)

1,000 requests

30 seconds

Token endpoint (/oauth/token)

60 requests

30 seconds

Response Headers

Every API response includes headers that report your current rate-limit status:

Header Description

X-RateLimit-Limit

The maximum number of requests allowed for your API key in the current window.

X-RateLimit-Remaining

The number of requests remaining for your API key in the current window.

X-RateLimit-Reset

The number of seconds until the current window resets.
These headers reflect the per-API-key limit. A 429 response may still occur if the overall tenant-level limit is reached, even when the per-key remaining count is above zero.

Exceeding the Limit

When you exceed a rate limit, the API responds with HTTP status 429 Too Many Requests:

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests"
}

The X-RateLimit-Reset header on the response indicates how many seconds to wait before retrying.

Best Practices

  • Space your requests. Distribute API calls evenly rather than sending them in rapid bursts.

  • Monitor rate-limit headers. Use X-RateLimit-Remaining and X-RateLimit-Reset to adapt your request rate before hitting the limit.

  • Back off on 429. When you receive a 429 response, wait for the duration indicated by X-RateLimit-Reset before sending additional requests.

Stability

Stability is extremely important for developers building on any developer interface. At the same time, Benchling In Vivo, like any other software, requires iteration and change over time. This document sets expectations and informs how a given API endpoint or Webhook event should be used and in what environments, to accommodate the need for stability and backwards compatibility as we make changes.

What does Beta mean?

When we are actively iterating on functionality in the API and Webhook events, we often want to expose new functionality before we finish iteration to get feedback from our users. When an endpoint or event is in beta, it means we are not entirely sure if this is how we want to reflect the data model or expose the functionality, and we want the flexibility to keep iterating before moving to general availability (GA).

Beta

When APIs are first released, they are available at the /api/public/v1-beta/ path. Customers are encouraged to provide feedback on beta endpoints as we iterate.

Generally, we bring an endpoint or Webhook event into beta because we know we want to have the functionality, but we still want the flexibility to change models. Breaking changes happen more than normal, but are not frequent. We provide a 30-day deprecation period prior to removing old behavior.

Versioning

When backwards-incompatible changes are made to the API, a new, dated version is released. The latest version is 2022-12-14.

All requests use your API key settings, unless you override the API version.

To set the API version on a specific request, send a X-Studies-Api-Version header.

Your API version controls the API and webhook behavior you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on). Your version gets set when you create your API key. When a breaking change is introduced to the Benchling In Vivo API, a new dated version is released. To avoid breaking your code, we don’t change your version until you’re ready to upgrade.

Each webhooks listener is configured with a specific API version. If you wish to change the version of your webhook events contact support.

Webhook Security

Receiving Benchling In Vivo webhooks requires hosting a publicly accessible HTTPS endpoint that accepts application/json POST requests. Your endpoint should be protected using one of the authentication mechanisms supported by Benchling In Vivo, such as custom authentication headers.

In addition to endpoint authentication, Benchling In Vivo includes a cryptographic signature with every webhook request. Verifying this signature provides an additional layer of security, allowing you to confirm that the request originated from Benchling In Vivo and that the payload has not been tampered with.

Signature Verification

Every webhook request includes a Signature HTTP header containing an HMAC-SHA256 signature of the request body.

Signature Details:

Header

Signature

Algorithm

HMAC-SHA256

Key

Your webhook’s signing_secret (plaintext)

Data

The entire raw HTTP request body

Output

Lowercase hexadecimal string

The signature is computed over the entire JSON request body, which includes all fields:

{
  "id": "event-unique-id",
  "client_id": "your-client-uuid",
  "event": "animal.created",
  "version": "v1",
  "created_at": "2024-01-15T10:30:00.000000Z",
  "payload": {
    // event-specific data
  }
}
You must use the raw HTTP request body bytes exactly as received. Do not parse and re-serialize the JSON, as any changes to whitespace, field ordering, or numeric precision will invalidate the signature.

Verifying Webhooks Manually

To verify a webhook request is authentic:

  1. Extract the Signature header from the incoming HTTP request

  2. Get the raw request body as bytes (before any JSON parsing)

  3. Compute HMAC-SHA256 using your signing_secret as the key

  4. Convert the result to a lowercase hexadecimal string

  5. Compare with the Signature header value using a constant-time comparison

The signature is sensitive to any changes in the request body. Even a small modification will produce a completely different signature. Do not alter the request body in any way before verifying.

Most programming languages provide libraries for computing HMAC-SHA256 signatures. The following Node.js example demonstrates the verification process. This is provided as a reference only and may become outdated—consult your language’s documentation for current best practices.

Node.js Example:

const crypto = require('crypto');

function verifyWebhook(requestBody, signatureHeader, signingSecret) {
    const expectedSignature = crypto
        .createHmac('sha256', signingSecret)
        .update(requestBody)
        .digest('hex');

    // Use constant-time comparison to prevent timing attacks
    return crypto.timingSafeEqual(
        Buffer.from(expectedSignature),
        Buffer.from(signatureHeader)
    );
}
Most web frameworks provide a way to access the raw request body. Ensure you capture this before any middleware parses the JSON.

Breaking Changes

2022-12-14

  • Measurement response variables replaced with calculations.

Global Resources

OAuth Token

An OAuth Access Token is a string that the OAuth client uses to make requests to the resource server.

Attributes

Path Type Description

token_type

String

Indicates the token type value.

expires_in

Number

The amount of time that an access token is valid (in seconds).

access_token

String

The requested access token.

Create a token

Fields

Path Type Description

grant_type

String

Denotes the flow you are using.

client_id

String

Your application’s Client ID.

client_secret

String

Your application’s Client Secret.

Request

POST /api/public/v1/oauth/token HTTP/1.1
Content-Type: application/json
Content-Length: 161
Host: localhost:8080

{
  "grant_type" : "client_credentials",
  "client_id" : "ba25944e-2fdb-4742-b09e-130e26c46cf0",
  "client_secret" : "WbxNbRMOW48M33BMLQZ71Gj7NMMmWnp7Q1U4pgbR"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1124

{
  "token_type" : "Bearer",
  "expires_in" : 86400,
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYTI1OTQ0ZS0yZmRiLTQ3NDItYjA5ZS0xMzBlMjZjNDZjZjAiLCJqdGkiOiI2N2RiZjIxYy1kMWMwLTQxYTQtYjljMi1iYzgxZjY2M2YxOWIiLCJpYXQiOjE3ODkwMjUyMTksIm5iZiI6MTc4OTAyNTIxOSwiZXhwIjoxNzg5MTExNjE5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFWS1JMNTNlYTZKWVB6R0dJWkNKSEgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mX6E8J93YhmohK0KJJpuu97cQoaaRRGcqqWmWXTIwYiNXdozDt78bK_b51w47fzeeK1JiW9f2jIuB3njxFMOcBPlTbMNRy6_DJsU6-i5x5GdIAC7Ex38UlO89MeFLLAL_W1VPp98gFaDxui3dm0uDEXDI6N6ncoJLYRU7A4Kfy5PSEBVNX4IExmnxVfWqYMc_pg63ea0BmaBYHjoPRKTQwZzBMxS8aNiHTD0OLFJeou2BYJ9GMKbXa_qbIX8MLbep6TGX7k_yktP20Y7cif-xdaG3JMd_C_xtiEGM9ZK3n0qKKP-eJ3BQmjqeNAuJ00zWDEzklyIBWaMkjUc2zSPS5KbBCLZBmzKnfYPrFhZ514Rnx-57g7p4OiqIG1p1jhXv7XiPvs_u4naDjPG1BeGFfoYmSn0tHZ_SR5d6StOrd-LxNDhUILDKHnS5CN_WtNe-Jysi-9oX7z_b4EY9U1W99GspkmurIEVEFXdqYgbG-E_sIXFMjvHDlFDyFDnmNS0CnwEnLkw2NxipL2p3GSZShIIBzcowEdSDPfanXh1fTTWWHC5au3kF5PpPY5sK8BSrYSyM4lRTjeY0Qjja5hX_OPpZHJzP9dQr-rIwv7Sz2tFxnikePRkhFQpUAOoF8lL8lWu2Bw3FMIhJaSk2YueKq92kb9uzPHTBsg3xfaCCP0"
}

Glossary

Your team’s glossary and their configurations for Euthanized reasons.

When managing sample or observation types, use the dedicated glossary resources:

Attributes

Path Type Description

id

String

The unique identifier of the glossary.

title

String

The title the glossary.

group

String

The group associated to the glossary.

Retrieve a glossary item

Retrieves the details of an existing glossary.

Request

GET /api/public/v1/glossary/gly_5PeCDAE2qWXEAIbmfZJnoc HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NTdlYjUyNS00MDI0LTQxZDYtOWFiMi03NDIxYWVmZDAyZDAiLCJqdGkiOiI4NWFiY2E3My1iNmI0LTRiYWUtYTUxOC1iOWZjZjkzNzFlY2MiLCJpYXQiOjE3ODkwMjUyMTQsIm5iZiI6MTc4OTAyNTIxNCwiZXhwIjoxNzg5MTExNjE0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJnWHdzcUt5N0V5SVVTcVNnMVhrVVkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.VCkk9Bazebiec_-XkStTNBeuuHDXI8x_YEXmJDEMcAJwFwd7MlGf7Sv6aitik92Tcbyh6M3REwXm1ZfgbSIFxk4plv0H3SQiILlkm_yciqLzvyLx4BtF1vG2szO2-vFLZV0PqTah2hRwXCHlFwRfpinbBUy9rEugH_GLFbKo3-7Ql7uLxXiVQECKkNqvo_YXh2vU0_p6sk_sOr0VWo0QAgPEPEU4dCikr_RBY50J2iypTymD3w0rmwsEy7aPxL5w1m2pbPXsWrWcAa8wO44lOcMleEkQbdCUwVhSPzt5d2xP7T3nUQHLSciVVlNj4hq-kb0XJ933iG04UyPSfj-nIMw8N7AWAEr7IUUWsfBUxk4amnDLiVgfnZ5FVN8kue48lz8Dhs7B3aj_0C1OGTccJbnQ_qz9okOjwTM3qPSAgAei4Y82SBF18LlqdjdZOr7AjduuPg3tOkVDS7v3h2M9dt_qBil97_VyHvKApORiJGRDDR8Sa034D6RLbv6Ye_FHOSlN0VAfuxV2-_rhNUTj3k0fxv8rhaUA5Z_OV432GqmoCbKiL4-sjqsuGMsimNd4nSiMeOBq5tt9H3c-_NSSjIRb5XZFC0YgE9XOYZXnEGn7R0HSn5dwK4e92gEhnygwqjgdcNHbIYdRtP-fJKuyyTGpGSyhNhq25Qk-yiiTMTM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 5
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 100

{
  "id" : "gly_5PeCDAE2qWXEAIbmfZJnoc",
  "title" : "Euthanised",
  "group" : "euthanize_reasons"
}

List all glossary items

Returns a list of your glossary.

Query parameters

Parameter Description

perPage

The number of glossaries to return per page.

page

The page of glossaries to return.

type

Filter glossaries by type

Request

GET /api/public/v1/glossary HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzOWQzNGZlMS0zMDE0LTRmMjUtYWEzMS05ZGIwZTkxYmJjNmEiLCJqdGkiOiI2YmRlMWU0My05MWU3LTQyNTQtODY1NC0xNmY1OWFkNzMyYjUiLCJpYXQiOjE3ODkwMjUyMDMsIm5iZiI6MTc4OTAyNTIwMywiZXhwIjoxNzg5MTExNjAzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdNNkNpWGgzZVZQblc1UkJrcWhDUUkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WJykNSMS0EIQEaoALnhVDsOMeZ04CvVZBpTR-KJEq1kotXu2Tm8NNFcAcgAFJA1XJdXci69pVjGr50ruxqTEukuABAi84K86BvPYdlXW9qir5cu_uyj62kYFtQoi-rMr3V6mhwtKZFcgyaqsVnUus9kKa5r_rNizEp440dgIH72hQNodR6ks2U5zP-wa9uTXOoNZkBUt-_HU-vcsH59R0Udk5d4IcHxtaI_qTSBOmSqccuE3DPb19jdno59DRPyyyKp3NQzztFJLucR46x8PqlwJegxREAcPXWyZwLBWy2l6PVYX5HTakJ1561oxRWyS5DbrP4WN-ANGCsfCIvDcU2hl6aCIReuv7ozMGs34M8XQsft5sv9ww1ZM4m-HL0L-tyn5uNqum60vcdl9hZraXx3ku2vI7VOO0ckk-Z2XsN5yimGPEt-CrthTk6QRMghY2qNKga4OE99peh3BBF9BmOVvw2AJ8OVN8NK4uTjf1J0YHNoqG9Y5L7GM_g36KZDqO34h2nitXc3rOQiCZfaL9bxaROqjcaIPIbIUPsCf9vweiuANhf8Qaje5_lu4fSCd0rW1EenG6NJs6wLmD8mDMy6ihuNIkegODunN0oV4wbb38_E0GrUtDFrb_DPDzi7hdV693VmjYucWJ1FNl0nNGwL3iNxdO7nSxbncevWH0tk
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 511

{
  "data" : [ {
    "id" : "gly_6ogw2AgByiqYcTncUB9wzz",
    "title" : "Found dead",
    "group" : "euthanize_reasons"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/glossary?page=1",
    "last" : "http://localhost:8080/api/public/v1/glossary?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/glossary",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Animal Resources

Animal

This is an object representing an animal in your facility. You can retrieve it to see the status, date of birth, sex, species, strain, identifiers and treatment group of the animal.

Attributes

Path Type Description

id

String

The unique identifier of the animal.

catalog

String

Unique catalog number of the animal.

name

String

The name of the animal.

number

Number

The number of the animal.

strain

String

The strain of the animal.

species

String

The species of the animal.

sex

String

The sex of the animal.

dob

String

The date of birth for the animal.

tail

String

The identifier for the tail of the animal.

ear

String

The identifier for the ear of the animal.

tag

String

The identifier by tag of the animal.

donor

String

The identifier for the donor patient of the animal.

tracking_date

String

The tracking date for the animal.

disease_induction_date

String

The disease induction date for the animal.

terminated_at

String

The terminated date of the animal.

terminated_by

Object

The user who terminated the animal.

disease_survivor

Boolean

Specifies whether animal survived the study before being euthanized.

metadata

Object

The metadata associated to the animal.

study

Object

The study of the animal.

study_group

Object

The study of the animal.

cage

Object

The cage of the animal.

created_at

String

The created timestamp of the animal.

updated_at

String

The last updated timestamp of the animal.

Create an animal

Authorization: Your API token must include at least one of the following scopes: animal.create, animal.*, *

Fields

Path Type Description

cage_id

String

The cage of the animal.

name

String

The name of the animal.

strain

String

The strain of the animal.

sex

String

The sex of the animal.

dob

String

The date of birth of the animal.

metadata

Object

The metadata to be associated the cage.

Request

POST /api/public/v1/animals HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwYjhmN2UyOS04ZjVmLTQ3NmEtODAzYy0zMDIzN2RmYmRlZTciLCJqdGkiOiI0MjJiN2U2NS03NzNiLTRjZTktYWY1Zi1jOWI1NzAwZTMxYWYiLCJpYXQiOjE3ODkwMjUyMjgsIm5iZiI6MTc4OTAyNTIyOCwiZXhwIjoxNzg5MTExNjI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJYYkVPRlM4b0hyeGkzZ0h6cFNYcksiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UAEjOeJ5_me_vq_eMBmXDpPiMneRoBNtWDEJnJfcoOTF_PFhAdG1Tax6xstJcFbUtcbE0EHFwdLSUehJkpLhaClYMsjpqx9hE54TIEgjRdVHILvWZqUI4boP9XIkJbdW95KXYuwrjuVqB4t15Bd-5WYVZH1SfDq3tytekKc5p1Ro0Xn9ARGJcNzZdGyQsI-XNIqy-zwju1EIuaONcrjuIHyWdwm5Nx67WT53gxhWqttE6Cp4UHD3EPIKjtu-4TdaD33paLAEmq_JfsWjcZ3xMR9YjxzAhu6EveuiaQitbWDov7-T7NiQxtGdX6LAIeyA1_fWL_DvC603IaGUcpkngHOV440wrUYPsbyc91HmVngHbUqi9JeEaienirOYeE5KhWBFxYamS8XU0rNu7QqlzvF0qp3VQ6GKT2Bl-w5tS8OgE1RCCPxnaFm5C_WJf2IYaBWYSZZgJPPSpYu2JYJdlntbBmhvXnCns2EzkGyDaI_EF1nMXOq6BVNsO8vfX3E5_PA3bhMIIXRuUhg17EjaKxXDE0qIkgNdqeJiFM-zopnOa2XmUZAr2fio7oTDc8aLX1E8FVXIrcpStLC3F6gfzbTFgAZlZGQzae9kg5nZ1oFER0qkeyjlM_LMY3AJs0_b4_ICDt5c7Z-ldPksqmCXIlhwUDBHZwEQWZr9ZdfLFIs
Content-Length: 198
Host: localhost:8080

{
  "cage_id" : "cge_6OoggPBm1dqsVZK2N1PoNQ",
  "name" : "Animal 1",
  "strain" : "AJp5HMsvLT",
  "sex" : "m",
  "dob" : "2026-09-10",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 21
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1896

{
  "id" : "aml_4ft0SdmwpKwuzDa1warQgP",
  "catalog" : "A0000001",
  "name" : "Animal 1",
  "number" : 1,
  "strain" : "AJp5HMsvLT",
  "species" : "3BEQM9izOx",
  "sex" : "m",
  "dob" : "2026-09-10",
  "tail" : null,
  "ear" : null,
  "tag" : null,
  "donor" : null,
  "tracking_date" : null,
  "disease_induction_date" : null,
  "terminated_at" : null,
  "terminated_by" : null,
  "terminated_reason" : null,
  "disease_survivor" : null,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_3FGE66tl8DHvvVhdLFppUV",
    "project_id" : "pjt_2FOhzbAE8FOy7C8FEn7tCL",
    "name" : "wqGrfeF4D8",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1Pn240nVw2w838hdmvzDyv",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "6JCxzUrE87",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2DoCYMd02OgqS5rB3YyQic",
      "name" : "0SAKl3DcHl",
      "email" : "bTjCcccq@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3OmhJ7pjzoH6Qf2cSnRrcU",
      "name" : "j29zVPade8",
      "email" : "a5OujPeO@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:08.571069Z",
    "updated_at" : "2026-09-10T07:27:08.571069Z"
  },
  "study_group" : null,
  "cage" : {
    "id" : "cge_6OoggPBm1dqsVZK2N1PoNQ",
    "study_id" : "sdy_3FGE66tl8DHvvVhdLFppUV",
    "name" : "bwcmHX3mtN",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-09-10T07:27:08.953574Z",
    "updated_at" : "2026-09-10T07:27:08.953574Z"
  },
  "created_at" : "2026-09-10T07:27:09.090516Z",
  "updated_at" : "2026-09-10T07:27:09.090516Z"
}

Retrieve an animal

Retrieves the details of an existing animal.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}

Parameter Description

animalId

The unique identifier of the animal.

Request

GET /api/public/v1/animals/aml_71H39zdfOc89pNIutQSI22 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYTM3ZjcwMy04OWJlLTQ3MzgtODk1OS0yNDVjZDIwMjhhZmEiLCJqdGkiOiJlMTIzZTJiMy03M2Q5LTQyMzMtOGU3ZC03YTQ4N2Y4YjAzZDkiLCJpYXQiOjE3ODkwMjUyMzAsIm5iZiI6MTc4OTAyNTIzMCwiZXhwIjoxNzg5MTExNjMwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRsaU5TY0k4cDdGZzFsQlhVbUx6MlMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.dwmuTgC30P8NptJ0wTS3zyfH912GAhgWKRXz_-nuKeE7Cft1MkH--NXg-DhHxvkXbQR76pepr2HUP6BNwCFi5AR5cPpge8GCeLTGTGAOpAVEVSK1y4beRK6CUbS7Eo-MgdSxTdf-w9N3g5Uxy47Toe4Vt7RinXuFmnIShYM6zWxjFSDC98p7NVBrXevL5ZQk-q8hmqXzyeBV3vjVdv4cR0T-HIPRHo7ogc524m3fV6ai_ZE3d1wxlIiauF2VvDRKuNud8CQcQnXMHO3eRMeCq-123H1jCtk-QS-UzcomLJZW2IrI53Wlgi2g7Hr2WUfLG9D3VByNvuSZKOl7gLa6lX5-CoB0tvk845_9szDvGXzMslWN3b-G45_bys8dDIFc7SEn21MuIHvsbH37pXkPDJsr1Sj-6fNcPs6zQCJoZ3nf5m5DvYKhfJfiHvRBPTMzsYLtj-qgernLcyY-nXIc-YMeFJfRZpAM6gWWzP5LKn88ayA6IKXJRR9-nDLJoUGTGll8ObaeukcdoI4tNzikfsjrkIkbQGPZtOogiUIzZmZVgP1OKHxJMF-zM9bXq93yo0MM86H-JbHxCxQHAnayF3EXkTkXzzZg83Nv8skGT8HG3ouVIi2rTf2UHGY01x4Hnj6J6y3lpI6pOOzZSbBSGWCfLQS3HGDZ7uaDN1xk_Hg
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 19
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2580

{
  "id" : "aml_71H39zdfOc89pNIutQSI22",
  "catalog" : "A0000001",
  "name" : "Ewh8PIpBU2",
  "number" : 1,
  "strain" : "bbVnooEZfq",
  "species" : "Zd4CUB5MX1",
  "sex" : "m",
  "dob" : "2026-09-09",
  "tail" : "5AnvYY8kra",
  "ear" : "ocYYBJbPVb",
  "tag" : "1b36kreEFE",
  "donor" : "lqlwmxTkyb",
  "tracking_date" : "2026-09-10",
  "disease_induction_date" : "2026-09-10",
  "terminated_at" : "2026-09-10",
  "terminated_by" : {
    "id" : "usr_7XmkQsAwCPnbkQwO0LdIZZ",
    "name" : "jVVo3MFPqp",
    "email" : "reGmKMUa@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_3DmlpKOXrCfG8X7cV4wsAm",
    "title" : "Found dead",
    "comment" : "xOTXTROyLN"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_4gAj4lB0CQSd0pAV1BhzVh",
    "project_id" : "pjt_2IM5mfhZdTdx4jZHWJ3aT0",
    "name" : "WEBgYuQgqC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2donaQ7TYfnPjr1JW0m4LY",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "5bhjPDg8R2",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_W14ubeUhwomxyGIEl7L5i",
      "name" : "y3BbMdyRsV",
      "email" : "jOof4NKc@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3ut5bxrXBn6F9n4MWOj14P",
      "name" : "JUGmVvz6qr",
      "email" : "NkAyTzDw@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:10.293053Z",
    "updated_at" : "2026-09-10T07:27:10.293053Z"
  },
  "study_group" : {
    "id" : "grp_1OEdawZKhmLCf88R4AnCZm",
    "study_id" : "sdy_4gAj4lB0CQSd0pAV1BhzVh",
    "name" : "FCA9IMiwp7",
    "no" : 1099912694,
    "color" : "BjIm5DauTb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-09-10T07:27:10.770562Z",
    "updated_at" : "2026-09-10T07:27:10.770562Z"
  },
  "cage" : {
    "id" : "cge_6uFo3TUYezxtFuImb9kk8K",
    "study_id" : "sdy_4gAj4lB0CQSd0pAV1BhzVh",
    "name" : "TC6jRPRBli",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-09-10T07:27:10.734591Z",
    "updated_at" : "2026-09-10T07:27:10.734591Z"
  },
  "created_at" : "2026-09-10T07:27:10.785238Z",
  "updated_at" : "2026-09-10T07:27:10.785238Z"
}

Update an animal

Updates the specified animal by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: animal.update, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}

Parameter Description

animalId

The unique identifier of the animal.

Fields

Path Type Description

study_group_id

String

The study group of the animal.

cage_id

String

The cage of the animal.

name

String

The name of the animal.

strain

String

The strain of the animal.

sex

String

The sex of the animal.

dob

String

The date of birth of the animal.

metadata

Object

The metadata to be associated the animal.

Request

PATCH /api/public/v1/animals/aml_6AAbFYghHtNJAcZxL41vlk HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZTZlYTcxMi05NjIyLTQxMjctODY1Yi1iNTBjMjQ2MzdhYjkiLCJqdGkiOiI5YjFmZGM3Mi00MzNhLTQzNjctYmNhYi0yNzQ3MTAxODAxZDUiLCJpYXQiOjE3ODkwMjUyMzYsIm5iZiI6MTc4OTAyNTIzNiwiZXhwIjoxNzg5MTExNjM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2Mxc3gyWlVmdVFHS243eUNKb1FxdSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.jDi7CyA1ik68ehBu1pSZZYxiErHFgk_UECP4MjF7_2ylXsmIXOggr7oNlmZLTYl9MA751C6MXs3njDkkYn0lgXSoxihpI610Nfl7N6SlsiJrnAChJ_l2pfQOQLCXVTIQbnVYPkTUR5skQdeAI6kF2V63FILaQWc78nmxhlwo3EEJiPGbVhLegOozUWGaorPpperKQTv9qNT6-wfs9COWVRzRnhHvU7PRoxYCztzi_-WCCstPR-yo9SRWG511hy5fEkO4NqWxcFF55L-soc3MhmLAl_Kz9T7M2HlXE3eGtEts0NADXAGF2H8a0YTdvsNGw-apdJHgNELMtCRSDNzjAduSMRN7yhBB8SWdr94asix7B-SPwZDpdCaYP9hyhvCxLVN65GdFhmPcUHkb-EMT36I5SuC91kvn2gLVPYnUtbzTq7B-HzfSv0b6-rR4z6WX5gkgIp8_YzCzlqg7HIX3pYXH8NtOsFGH8i0dYxMm5lUK1NzF73adXs2TZ_-sKPAi_0eode6WArpsplRl1q8C5xGl0BayFowVgcKBX6hyoYHfOKUfORZPzMcbyxmCtVV_-0TeMDkKJBWHKERblmwZ5knGtJXFnjCTT7fGzGCqbXMkw9nwpSr2e4UqDW8WCCOFDQAUnI0zYwPc_gGr2V2yefBMdjbiqtSiCHe3u9cf2eM
Content-Length: 264
Host: localhost:8080

{
  "study_group_id" : "grp_3oGllT6v5rgDGc1Oa7xt1q",
  "cage_id" : "cge_tyKb4BhXNrCSN21EtYFv7",
  "name" : "Benchling In Vivo Animal",
  "strain" : "0B6FIO24we",
  "sex" : "f",
  "dob" : "2026-09-08",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2355

{
  "id" : "aml_6AAbFYghHtNJAcZxL41vlk",
  "catalog" : "A0000001",
  "name" : "Benchling In Vivo Animal",
  "number" : 1,
  "strain" : "0B6FIO24we",
  "species" : "4u1A5BNTfR",
  "sex" : "f",
  "dob" : "2026-09-08",
  "tail" : "DD9KH7yeeC",
  "ear" : "xz6znPTuDR",
  "tag" : "ghn1V6VhWZ",
  "donor" : "oiPrLulRFM",
  "tracking_date" : "2026-09-10",
  "disease_induction_date" : "2026-09-10",
  "terminated_at" : null,
  "terminated_by" : null,
  "terminated_reason" : null,
  "disease_survivor" : null,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  },
  "study" : {
    "id" : "sdy_1duOKXyFjL9xL7brIdg6Im",
    "project_id" : "pjt_B6XuEFUWWj00ZoSEF15an",
    "name" : "YtiSE52Koc",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1NbmbTHCyynp1CI985CSmG",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "P9FlgToVsv",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4gPpfB9uln3uQrmOeqgNrh",
      "name" : "7ylwPoTUv3",
      "email" : "EfuJ9SE5@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_GPtKkZCFJAGH1UmGmUPJU",
      "name" : "H3aZx3k7UA",
      "email" : "S9CdRHo9@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:16.150076Z",
    "updated_at" : "2026-09-10T07:27:16.150076Z"
  },
  "study_group" : {
    "id" : "grp_3oGllT6v5rgDGc1Oa7xt1q",
    "study_id" : "sdy_1duOKXyFjL9xL7brIdg6Im",
    "name" : "1VEpKJUJwt",
    "no" : 1474231139,
    "color" : "#e9429d",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "new-study-group-internal-id" : "NEW-GROUP-1234"
    },
    "created_at" : "2026-09-10T07:27:16.668109Z",
    "updated_at" : "2026-09-10T07:27:16.668109Z"
  },
  "cage" : {
    "id" : "cge_tyKb4BhXNrCSN21EtYFv7",
    "study_id" : "sdy_1duOKXyFjL9xL7brIdg6Im",
    "name" : "iGLAPqK8iu",
    "catalog" : "C0000002",
    "metadata" : {
      "new-cage-internal-id" : "NEWCAGE-1234"
    },
    "created_at" : "2026-09-10T07:27:16.680047Z",
    "updated_at" : "2026-09-10T07:27:16.680047Z"
  },
  "created_at" : "2026-09-10T07:27:13.691152Z",
  "updated_at" : "2026-09-10T07:27:16.821669Z"
}

List all animals

Returns a list of your animals.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Query parameters

Parameter Description

perPage

The number of animals to return per page.

page

The page of animals to return.

name

Filter animals to return by name

cage_id

Filter animals to return by cage ID

catalog

Filter animals to return by catalog

sex

Filter animals to return by sex

metadata

Filter animals to return by metadata value

Request

GET /api/public/v1/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYWIwOWRlNC1hMjgzLTQyMGEtYjNkMy1lYTk1MWUzOTA2NGQiLCJqdGkiOiI0NzE4NTI1Yi1kYjg0LTQwOWMtOGI5My0yOWE4NWFhZWRjZWEiLCJpYXQiOjE3ODkwMjUxOTgsIm5iZiI6MTc4OTAyNTE5OCwiZXhwIjoxNzg5MTExNTk4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzUxTXkwem5FU1Z0bzM3d3ZiU2ZROFUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UzP7FUjU9a-IIOq6tByECAjgGSdsNDvz1BTXCxBpyTgNjNb68489aQAURsl1_NlYubnd3Ttqb45y0sUXaN9i3v_gW8LBP7x6xVXp4SUyiWvr5YMj2OK8Uu6k2h185wCqxVlsGHb4Q1foTQGQy19Rof1eSU-5DftbYOhri8SiJjnGHwH2i6drapz5HHZFJGWGGO9EDQuMUWShhM3pKOzrCrH5ExiSfAiUhITVXyJ6oKjKWNJQqleEyiwgJmdEJ3nq2DWTB4uCIezU5o4KGXFYnzQGL_lNIrvbO5XHE__08K9_CbI9znC1VAM05htKQthos1HKMkoQRgvTMXNgk-EGm723N1AIanVORmLy2mklD0f_DMAvNgJAtc7KHRWa4z2TezEisIrrLJXWcbeSav-HIHpDSKQNJyW0ld4HwytrjMk4SR-9o0QbskSlJtMj0dPIBR0I4851KPeSxUJLjyls-bmAe03Hw4_CKIE5RrsRnhdNZuAR_LqxgeGTfOda9N_SHGR2q-eKb221Sk2wmWhKd_7gADDjYssgssCQDAKzKQJI0jvnS_HN38W3hcU_rgrnXDVGkay7w4CqMsD0dtPOJBXB6e6QPDF-rUHDHXedU0HklHnOaY3IOJE_Kq6a0JJ4SGbwHdBigjwUl42P2g_TsX2eCZu6ehq3pbkbuQPbJc0
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 21
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3159

{
  "data" : [ {
    "id" : "aml_4ON4YGF7h7Ppx16oz5bl0Y",
    "catalog" : "A0000001",
    "name" : "oeBqCQ8bgr",
    "number" : 1,
    "strain" : "QNNfvs5OUF",
    "species" : "YjcCJabSYo",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "6zyYkS49xk",
    "ear" : "3b4YMEknme",
    "tag" : "pOPVLEqJZa",
    "donor" : "pPckvYYm0T",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_3ynmuZPFsLpK0MN14XGHB2",
      "name" : "Qgujm4RRXR",
      "email" : "36bp07tZ@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_4qkNLjIF5wFvWGGiqFsxrd",
      "title" : "Found dead",
      "comment" : "BDH3YWC5fw"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_5EZq2ug2V0Qg8G1UyxE6IH",
      "project_id" : "pjt_3o2ZhwJwKNuEZJtSCVJ1pK",
      "name" : "JnodohVsyx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3A4hmduhIyLd1bDzzwQZcl",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "uEeRgHpjEk",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6wlGPNBD89cByzgftg6UG",
        "name" : "OqNudXbwTa",
        "email" : "4yYxIwBr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2KYDST1Af1DT0BRvZOZlNT",
        "name" : "9TOXcHrgeF",
        "email" : "099bTWw0@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:37.096499Z",
      "updated_at" : "2026-09-10T07:26:37.096499Z"
    },
    "study_group" : {
      "id" : "grp_5H95nlI46WDJoSbBhJwMAU",
      "study_id" : "sdy_5EZq2ug2V0Qg8G1UyxE6IH",
      "name" : "ca3sNpdbno",
      "no" : 708198540,
      "color" : "Dr7xtRTIQH",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:26:38.410448Z",
      "updated_at" : "2026-09-10T07:26:38.410448Z"
    },
    "cage" : {
      "id" : "cge_79vZsNHEKXhRcZlJJsvzl4",
      "study_id" : "sdy_5EZq2ug2V0Qg8G1UyxE6IH",
      "name" : "KHtcmi8tT4",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:26:38.274793Z",
      "updated_at" : "2026-09-10T07:26:38.274793Z"
    },
    "created_at" : "2026-09-10T07:26:38.447834Z",
    "updated_at" : "2026-09-10T07:26:38.447834Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete an animal

Removes an animal.

Authorization: Your API token must include at least one of the following scopes: animal.delete, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}

Parameter Description

animalId

The unique identifier of the animal.

Request

DELETE /api/public/v1/animals/aml_7RPARRTPFhAoYYLRfoF8Gh HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNDc5OWM1YS01ZDdlLTRkM2QtYmE2NC1mYzE1MWM3YTQzZTkiLCJqdGkiOiI1YjA1MGNlYi03ZTIxLTRkMDUtYmFlMi1jZWY5OTgxMzNkZjEiLCJpYXQiOjE3ODkwMjUyMjksIm5iZiI6MTc4OTAyNTIyOSwiZXhwIjoxNzg5MTExNjI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVwN0xpSmtUWDJJVk9wWFY4SUFyQXYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.jEnvON8qMzieBeFYsFq3yt5jwuW4VlrAvPrXHz6M0Dhp0eioo2nfYt82H7bb-p2nLmpSv4KWqSoTjvIefgoj0VWVcrfO2rkJ_Amf_CewRiP0wstoV5vSk7V2BU33UikBJiqEGiOFGTYldVzR6Nt0B2kxZKxcJPUEJQL7A1WH6bSeKU7oT0B2Kk0IJD99vmgEaD1HnsKSuUMleJ3P0FrCWkHtoSyhdbCXL4nhhp_1joQFpHh9ZgdrM4MnAilM26-VIBF5Yg3XBHZQnUrMPWi_PoAlN84JfmX8Ru3Ge3PnubtpR0FiiflhniEMg4SetVlNJ9t0RJlok8HfVlyStnilnsja7VeQ5MrFjJWRNrOcPhDMATiHHWKumk_fx75E6ymxsENdpRjyHDBAd4wXUrbAwE3wfbjU8CULZ9sHgpRKn1rEXVBJSaphDBUQyMU63UbA5CvlRSe-d7hXV9AKgBsuCU3PlC7VoD_jbgZjihD0R3JSWaO5pR9DmVr397IH7FUB-tpPA02OYJZQT_xGBIWt3bYqvvPx-viLaSWNpv-fwT92Fs2aXOq8ttMg3t3EmDz-yBeLrPAsQ6bDjmUm9LLF2G0GtQTYef4N_40S58_xiE8yW9ic9KLTt3hkkMyU2vsEVIDTWUkLvoPi4q6rQbWvMYwLxhjedjiluNNChAPsiIU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 21
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Animal Dosage

This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.

Attributes

Path Type Description

id

String

The unique identifier of the dosage.

name

String

The name of the treatment type.

dosed_at

String

The created timestamp of the dosage.

comments

String

The comments associated with the dosage.

dose

Object

The dose concentration associated with the dosage.

dose_volume

Object

The dose volume associated with the dosage.

stock

Object

The stock concentration associated with the dosage.

volume

Object

The volume of the dosage.

study

Object

The study associated with the dosage.

animal

Object

The animal associated with the dosage.

measurement

Object

The measurement associated with the dosage.

user

Object

The user associated with the dosage.

treatment

Object

The treatment associated with the dosage.

weight_at_dosing

String

The optional weight that’s taken during a dosage.

created_at

String

The created timestamp of the dosage.

updated_at

String

The last updated timestamp of the dosage.

Retrieve an animal dosage

Retrieve an animal dosage.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/dosages/{dosageId}

Parameter Description

animalId

The unique identifier of the animal.

dosageId

The unique identifier of the dosage.

Request

GET /api/public/v1/animals/aml_40n5euZTc6YbFwdquJtpuQ/dosages/dsg_a6ezmy1Nh3FnyFhQpmLQd HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5YzgzOTNkOS1hMTU2LTQ2YzctODRkZS0zMzBmZTExNDI5MjQiLCJqdGkiOiI0NTk1YjRhZi00NTM5LTRkZWQtYjdlYi0zYmUzYjNkMTYxNmEiLCJpYXQiOjE3ODkwMjUxOTAsIm5iZiI6MTc4OTAyNTE5MCwiZXhwIjoxNzg5MTExNTkwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE5dzZ0dkdXaVZGcmNqTEFtWFBXYUsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GIlmosBBNPgjN-H2PjipcU2wGP3qNZz__PhrezLm71OVk3oyl0rEzyi0vDWi1qPOcAfPg_2PhBC_V7WhZup5WhFnnUuNFYMuXalu3nofpvurEZrn_YaHTZBiWigTbHL_IPI1rudjPE9E2Dv6yzH4xBiYALdTOq_ZWXNT8_jUaWPEIgYqu1Ugouw5h6dINLAQ6zoAprnGXQEDxYYTNcR3gca0BWK1VJlpYcrN3GrHouj6PGT5s-KpGnaVYVAy2vctfNLikeuxXnXA0XDmRVsz-DK6h3M40y3JNGsR_fK0Xi8g0k7RfhP9jQnxwW5XrIi3rqrC-iBOKAjwQ1oZueds9qGyvRIEVLJHFcYFcH7wSqfFKgKmS0HCOtNeKScJtiVDQonAgWkenImr8PxqeP4uLq595z_M8nPdGDspk2XfaD2z0w2D9b5v33zX6Plnkj5gSle2pfyok7sUxMOAOWpnqbTn5xquUjU8tKN07B7imPfhRHxc6uZbvE2btQrVkcNYzDNLvVxsbbyMjfgDmfO0rizqW9OoJFdytasNgOdAkTBTxd1K8GzRN9J8Z81-_cq7RlqO-df8JhXUL7xyRi9A4puH5zFex5QbsNbh3z70W3tOWkcuyzAXUl0Rkiblr9RKugGZIPPMZlVuV_9xuW0DEN4d3oYVXiX22-5FxXBm--Q
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 30
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4791

{
  "id" : "dsg_a6ezmy1Nh3FnyFhQpmLQd",
  "name" : "Example dosage",
  "dosed_at" : "2026-09-10T07:26:30.740538Z",
  "comments" : "hoyDv9lcXS",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "3.18",
    "display_unit" : "mg/kg",
    "display_value" : "3.18"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "15.88",
    "display_unit" : "ml/kg",
    "display_value" : "15.88"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "22.29",
    "display_unit" : "mg/ml",
    "display_value" : "22.29"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "36.77",
    "display_unit" : "µL",
    "display_value" : "36.77"
  },
  "study" : {
    "id" : "sdy_4oF851BGnOZ4vW6SDWfBAh",
    "project_id" : "pjt_3nLyMME8Xxw8h91AOo4iRH",
    "name" : "RxZszpri0W",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6vDYfeKUDfqRBMn46dtiPK",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "6sa668Ypcn",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_79Kisyz30hGNlfdRDcbgoM",
      "name" : "Wj8iPczr45",
      "email" : "CAOWYAnv@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6ZlrkGZW2diENeaUPDTppn",
      "name" : "zZB3ZFiMra",
      "email" : "ChwGUauF@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:26:30.053903Z",
    "updated_at" : "2026-09-10T07:26:30.053903Z"
  },
  "animal" : {
    "id" : "aml_40n5euZTc6YbFwdquJtpuQ",
    "study_id" : "sdy_4oF851BGnOZ4vW6SDWfBAh",
    "study_group_id" : "grp_3ZIsGtVi51J8FzMm3p7uBq",
    "cage_id" : "cge_7OyDez9lEse4vHHd1z5Uhs",
    "catalog" : "A0000001",
    "name" : "vTAAp4dBsj",
    "number" : 1,
    "strain" : "AmG9QQXt2Y",
    "species" : "F40iThGmqL",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "VSXrhNQEDt",
    "ear" : "LnT0QN51oW",
    "tag" : "5udrFhMjL0",
    "donor" : "wD8bNNRKYi",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_2gPXyvjSuNtJzytzmE1LgC",
      "name" : "bYivKWxwI6",
      "email" : "1e55JA4z@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7MD3vUx6xp8QDoz48Gd5Cj",
      "title" : "Found dead",
      "comment" : "KQjpIaS2BS"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:26:30.481807Z",
    "updated_at" : "2026-09-10T07:26:30.481807Z",
    "disease_induction_date" : "2026-09-10"
  },
  "measurement" : {
    "id" : "mst_1pvCuMDGykGj1tPu2aaJ3y",
    "study_id" : "sdy_4oF851BGnOZ4vW6SDWfBAh",
    "animal_id" : "aml_40n5euZTc6YbFwdquJtpuQ",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_1j8yubzA6XuNXPKl7WKFUS",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1j8yubzA6XuNXPKl7WKFUS",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-09-10T07:26:30.696641Z",
    "updated_at" : "2026-09-10T07:26:30.696641Z"
  },
  "user" : {
    "id" : "usr_1aK0d7qAQqU5vqrEXkU6oU",
    "name" : "pxx21 Overwatch",
    "email" : "nommjrHf@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:26:30.018301Z",
    "updated_at" : "2026-09-10T07:26:30.018301Z"
  },
  "treatment" : {
    "id" : "tmt_6mEKr2Qui7TmqoIMnOTse8",
    "study_id" : "sdy_4oF851BGnOZ4vW6SDWfBAh",
    "type" : "concentration_vgkg",
    "name" : "0QpGzj3cUg",
    "label" : "Test Treatment Label",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "created_at" : "2026-09-10T07:26:30.708117Z",
    "updated_at" : "2026-09-10T07:26:30.708117Z",
    "external_entity_id" : "l8IeFH3MSW"
  },
  "created_at" : "2026-09-10T07:26:30.740623Z",
  "updated_at" : "2026-09-10T07:26:30.740623Z"
}

List all animal dosages

Returns a list of your animal dosages.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/dosages

Parameter Description

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of dosages to return per page.

page

The page of dosages to return.

Request

GET /api/public/v1/animals/aml_1XM9lokBY3IU47IWyRmTaT/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4ZDM3ZjJmMC1iMGU5LTQ2OWUtODMyMC0zODg3MDdiOTYyMTIiLCJqdGkiOiJlMjRhYjVkNy0wOWNlLTQ0MTEtOTU0My1hMDA2ZmUwZGNmMzgiLCJpYXQiOjE3ODkwMjUxODAsIm5iZiI6MTc4OTAyNTE4MCwiZXhwIjoxNzg5MTExNTgwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFvNVdleDRjSjE0TjNzakhKMjZqU0siLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.BfLOABPgiyZb2tK_KltgH7102hFairdPGdwB6K0QfYdHBoWIlcHC6g2z_hulGMae4GJCPL6Rht_OqFdhdD4ZT9PsnYJG6KRbqiZwfYfhA3uWGPEUvtPNCZUlttvw7tGRlW0vnEQ5illAQlNEMSBDg_zu45i9SZ0ttdg9cLyxJFrQkSkOybvKeGsP7TPVQg6h0bba1vbOnp3Y8t3cDUfDYzg2BNbIwUoY86ou0fm0BrroFrMCI9-upuldSjKsVAANvSRFS09Pc0G4rI1yWhp5QQWFnIes31Exhe6vUxU64g5s1ysiDVzJPmpka7MgAV8zWVqsZZii0UclFCb8Po5TThAOu1Tc1ycMP8Fus79P7tcJbMCCSt3ace6twJJSXa2_QFEv4tT0wcWyPxYZh5C93eqSGrP2ZbQnwcRApNl7wLFBY9GTr1r48PrVj286Nhs7ahxYfFbmtoJk0uVOV3DKMOBr4BB7s6lhO-3CMs3RrQ80qc8VJc4-SXzTexjg9IWNDRCDkkkbiGHaiJ-jFNgFm2SE42DKgKT20K-ABlj9DeGNRqbGabIW2-yd3xrs_Aa6nYBCnk2bFJbSLSWe-YjmqWEEQO2UJRZd04gFTeR7KvjS1bdFvDNsYysHAR4VR5rml7m0Ajn3Dr_N7S2AoCRfFSYN-4LeaYy2dRi2vX8uY-w
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5637

{
  "data" : [ {
    "id" : "dsg_7KWREAhYI5Fo1zK32FLzqJ",
    "name" : "Example dosage",
    "dosed_at" : "2026-09-10T07:26:20.220820Z",
    "comments" : "MWS73u839p",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "1.92",
      "display_unit" : "mg/kg",
      "display_value" : "1.92"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "14.42",
      "display_unit" : "ml/kg",
      "display_value" : "14.42"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "29.90",
      "display_unit" : "mg/ml",
      "display_value" : "29.90"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "31.97",
      "display_unit" : "µL",
      "display_value" : "31.97"
    },
    "study" : {
      "id" : "sdy_6LqVF6OQmBFHptR7v2Hr0o",
      "project_id" : "pjt_1MTRrHrDiNprQslimvI3Cw",
      "name" : "XRww8PyLua",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3g6zHTzTR28TOAeHf50O7d",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "p2wTT2pVo2",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7CdeOTbi3IOXJ59hRCdtuP",
        "name" : "1ESHlZgl5p",
        "email" : "iGGNdw3M@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6DXZ9R4z8qZNiYmatGKSYM",
        "name" : "ZiJLCEA6DC",
        "email" : "PWO0GSBV@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:19.488635Z",
      "updated_at" : "2026-09-10T07:26:19.488635Z"
    },
    "animal" : {
      "id" : "aml_1XM9lokBY3IU47IWyRmTaT",
      "study_id" : "sdy_6LqVF6OQmBFHptR7v2Hr0o",
      "study_group_id" : "grp_TNZTKVM3ZO9SRDDnjPsXI",
      "cage_id" : "cge_32DgglbiJGfd7zmg0MvkfB",
      "catalog" : "A0000001",
      "name" : "PRxkZZ4NuO",
      "number" : 1,
      "strain" : "pArmtZYK3U",
      "species" : "QcWTwK9Tjy",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "LBLaTuMMYo",
      "ear" : "4aN6eMBlsT",
      "tag" : "DgkehacUN0",
      "donor" : "FdPKEbIFQZ",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_1QILv2sIVSlhQrsfxiBP1T",
        "name" : "gzVkBdxsND",
        "email" : "82xcckAw@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6tXxaP5ZLwBUfJHANNMCDQ",
        "title" : "Found dead",
        "comment" : "sfKVOiYcwp"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:26:19.908264Z",
      "updated_at" : "2026-09-10T07:26:19.908264Z",
      "disease_induction_date" : "2026-09-10"
    },
    "measurement" : {
      "id" : "mst_6uFMK6ZhzTVUZ7AqLb0u5v",
      "study_id" : "sdy_6LqVF6OQmBFHptR7v2Hr0o",
      "animal_id" : "aml_1XM9lokBY3IU47IWyRmTaT",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_4UiKhXMDXkHM4bwUvzsJP5",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_4UiKhXMDXkHM4bwUvzsJP5",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:26:20.152118Z",
      "updated_at" : "2026-09-10T07:26:20.152118Z"
    },
    "user" : {
      "id" : "usr_3jzAUaZC0FNBjpvn5Hd9EW",
      "name" : "k79cN Overwatch",
      "email" : "cgzhS8QA@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:26:19.428429Z",
      "updated_at" : "2026-09-10T07:26:19.428429Z"
    },
    "treatment" : {
      "id" : "tmt_6a4vn4C9bvcc7oXTctoHmg",
      "study_id" : "sdy_6LqVF6OQmBFHptR7v2Hr0o",
      "type" : "concentration",
      "name" : "Dq4kZjXfUH",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "created_at" : "2026-09-10T07:26:20.180950Z",
      "updated_at" : "2026-09-10T07:26:20.180950Z",
      "external_entity_id" : "E4QPYhrdAt"
    },
    "created_at" : "2026-09-10T07:26:20.220860Z",
    "updated_at" : "2026-09-10T07:26:20.220860Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_1XM9lokBY3IU47IWyRmTaT/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_1XM9lokBY3IU47IWyRmTaT/dosages?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_1XM9lokBY3IU47IWyRmTaT/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Animal Measurement

This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.

Attributes

Path Type Description

id

String

The unique identifier of the measurement.

measured_at

String

The measured at timestamp of the measurement.

calculations

Array

The calculations associated to the measurement.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the measurement.

updated_at

String

The last updated timestamp of the measurement.

calculations[].variables

Array

The measurement calculation variables.

Retrieve an animal measurement

Retrieves the details of an existing animal measurement.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/measurements/{measurementId}

Parameter Description

animalId

The unique identifier of the animal.

measurementId

The unique identifier of the measurement.

Request

GET /api/public/v1/animals/aml_1ZUZcndI24QJR9Lb7QZX6N/measurements/mst_4PJ4z4eoGa5SXJ1YBJOOe7 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhN2I4ODdjZS0xYTA0LTRiM2ItOWQ0MC05MWY4YTY2MTE1N2QiLCJqdGkiOiJhYmVmZDViNC0wMzZlLTQ3OTEtYTM0NS03M2NhNGVkZDA0MDciLCJpYXQiOjE3ODkwMjc2NjcsIm5iZiI6MTc4OTAyNzY2NywiZXhwIjoxNzg5MTE0MDY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJnZ1ZHdktUZXBMSDFRYXlGanMya0wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.A32AZkhesKQwcCDGI6x1uTVQa-91RgxrnAA_KM2P89Noq66IdNvdzPjMnqDYMMb0M-Vz65dUHnGZqpCJSRRlnHZqHk8HXCI-xEMgYJFKPdIX5-wsvttbthnrj33VgSjGqE9hd5xp7ecSE_4VA9k_Km6tkLFRj23qc184kA02MiX4gZnWhr-FVUGZRX7LCpKvuHVzhoSP7nhqHxDDtHKSysZPz0turjzNrWysMfBwqIwEwWEkDmgEoIBj67gJ80J3_eZHm_r6ZzPW1kYDSjpXGH6hY-IHqGrhffDTrt3E6wpSnaDht_0oPG9D3ukM3hfnK-2-HzZQhydpXci2B6unbOTB1ljI98_WuXWUx7oMkZXVJlnkr7JC98mH8ir4FEx7mZW2YDJxNw5cOaW_ROcOup0EsER256dYcUgQuRzAgv9tMnnRKd3eQmJHpY95pMa24ld22gvpS9y5ieJnFFYNXifAy8P00gcfPQKRdERmT81tsCJkh-e4g_-FR3h1NudQ_qhr4jSN09J_hCiXo9K2VbHcBdz7R3OqfyzarsYgq53NXnLop9POdozbptlGWm_yR3AKlNP3TF_2VWGKo7HZRKtJ0SJdeSgNTD3esbCkDiYSCR8U_HFK1etRbGx52bwdt0Db6O6C4TL1ojcXjIGx7JVp0P3TczJ5NhWyVAR1RIM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3400

{
  "id" : "mst_4PJ4z4eoGa5SXJ1YBJOOe7",
  "measured_at" : "2026-09-10",
  "calculations" : [ {
    "id" : "vbl_3gmZRjUwil5Vdl8UbjfbPA",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_XTtIl8Mf8oQSiYAug6AIb",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_4j4dvB4qot5o117TMINtNW",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_3i8oy32jXbFON8Qouzedq0",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_3i8oy32jXbFON8Qouzedq0",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_4YSPi2vyxAHXlYLNB8KDzk",
    "project_id" : "pjt_4SbamfBAVCGvGshTlH4Msl",
    "name" : "sW5YMrhtm0",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6hbklD58rLcGA3gaicrIFR",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "H9gc9TC7BW",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5Vm52huqakds90QyLjVFnO",
      "name" : "uuUUzoctzt",
      "email" : "jrrX7TO3@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_78kZ8tL3VF7K1Fw2K58ZiK",
      "name" : "55vPYm6Deu",
      "email" : "M4DdSxn8@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:46.546366Z",
    "updated_at" : "2026-09-10T08:07:46.546366Z"
  },
  "animal" : {
    "id" : "aml_1ZUZcndI24QJR9Lb7QZX6N",
    "study_id" : "sdy_4YSPi2vyxAHXlYLNB8KDzk",
    "study_group_id" : "grp_6L2vSBFmRRiWN3XQ711slk",
    "cage_id" : "cge_1mAIuXgvOPWId62pjK3BCR",
    "catalog" : "A0000001",
    "name" : "DvsJHoSJRw",
    "number" : 1,
    "strain" : "F4syv7hEWs",
    "species" : "Y06eiHqavq",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "0zK4ia97V6",
    "ear" : "NqSzfCWdb1",
    "tag" : "aeaB8TROuH",
    "donor" : "VKOzdSQZrl",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_21e0GaQoskE3FRgpPeb1Mm",
      "name" : "fP9vsxuRWa",
      "email" : "BWbSGEju@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1wMYRFDETAGNOzU8Sifwbv",
      "title" : "Found dead",
      "comment" : "wa2e8ckswn"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T08:07:46.885407Z",
    "updated_at" : "2026-09-10T08:07:46.885407Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_55d8kW2nwANItmlCEKvNNb",
    "name" : "EuMdP Overwatch",
    "email" : "PIj1IPhB@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T08:07:46.503812Z",
    "updated_at" : "2026-09-10T08:07:46.503812Z"
  },
  "created_at" : "2026-09-10T08:07:47.000675Z",
  "updated_at" : "2026-09-10T08:07:47.000675Z"
}

List all animal measurements

Returns a list of your animal measurements.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/measurements

Parameter Description

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of measurements to return per page.

page

The page of measurements to return.

measured_at

Filter measurements to return by date (yyyy-mm-dd).

Request

GET /api/public/v1/animals/aml_7WDByRi5YFzZaaiTK3A2TU/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzZTlhOTJkNi1mZTU4LTQzN2YtODkyMy0zZDE1NmRlZWI1NDkiLCJqdGkiOiIyMjU2NDMyNi0zMThiLTQ2ZTEtYThjMS0wNjQ2MTJjMGEyMzMiLCJpYXQiOjE3ODkwMjc2NzAsIm5iZiI6MTc4OTAyNzY3MCwiZXhwIjoxNzg5MTE0MDcwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdKcGp5Q3BaTzg1dkx4ZktYY0Z1c1giLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Ii8wk93SxrJKJ0RS7cWEjUP0dSV-5jI3O3Y8UC2QXxzXn1AFhe9_EA5zTMtqaaCYH3-5GcAh-i-4JbT-ureM_IiigieGE7XYh_yhUDWfJ9zUVlWha6C8BNMgRUnVBPnrL5F3GXDC2xg02mT2i8DqHCzqmGgnqCwmjhEEFfhwPmC2MZcHl17lvdnod7XdW6hAd4RyLZ5ZKWK6VDKDnpDPwDpj5-CkgTHI2YUjqZmJPIN52qbTdHOAgW019w9Nfe6o82ehv8bUzhGohaucMzOPowtRg9t34-tvEIM_f4bFVpazveSoR9r4RyYuIkdvBC-m6WL6Dzqpl060E3OUVju0j-CneFWbzwLzEYgmf6EP90a5s-jkl20WTpXp4iqgZkrr5kKnPx9H0J_yP1InKcptdUapuK-4e9a6cFjy0DfMvC7iMlxXtQB_48ge4BT7ZbHE1AJunlyFRGKrl-b8NWa0znRhbxGrCsoJlafqZsdsQp2_-2i4lIuCYFwHwfn1HNxutm_Pi_gvS5h2X8onugyxsfZv6qrrM74H98RUC4RvepiUUPi9twJvEw45698WP6YOALDATqqg8w3UnEHLl4a9psc4pRgDUj9NR225tfOHIn_QZZNDr6ssfprtZDVR10ehw-Ty7ShYsmb3xttVD5NDsAXFs9mZcgH_6vlJsESz3iA
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7796

{
  "data" : [ {
    "id" : "mst_wph9Ja6rrKL6ign8bdYPf",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_3T8C1gu7SQLHupIsC6xXVd",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5Gl7FQnuL4ll0DDtqNMVLC",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_1xskrV3DtxKhZfo8NRlImM",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_7XhpNOAVmKmYRElVEg1lFQ",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_7XhpNOAVmKmYRElVEg1lFQ",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_ThehOVMGuljXnGtgjQgEa",
      "project_id" : "pjt_76tfgZfM2qZMlagTRhfRlX",
      "name" : "v6Y2ztq9dn",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3tMuPL8ATETRrO3RWo7lWg",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "oPxAHyPi5j",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4cQlnqIiKK6vPUYCySrgkB",
        "name" : "HQOO3QSski",
        "email" : "ZkhXP88d@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4Wv71s4guKSthd2YBMOE3s",
        "name" : "sabFZ8t4tj",
        "email" : "ELsx4IJf@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:50.141007Z",
      "updated_at" : "2026-09-10T08:07:50.141007Z"
    },
    "animal" : {
      "id" : "aml_7WDByRi5YFzZaaiTK3A2TU",
      "study_id" : "sdy_ThehOVMGuljXnGtgjQgEa",
      "study_group_id" : "grp_6JOaRSn9QJZPnoVsL0bFR0",
      "cage_id" : "cge_69sIp8mGHye2o3CPBk2HSD",
      "catalog" : "A0000001",
      "name" : "Ie5wsCnwq1",
      "number" : 1,
      "strain" : "GBBPeRmppy",
      "species" : "QTgzHiy7nV",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "IKEdgbOngK",
      "ear" : "VLfSgNmomq",
      "tag" : "yBQGynk3Tp",
      "donor" : "t6f5797XzE",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_35IodvfDzEwkn78jx3kuWt",
        "name" : "MEuOeJbmnG",
        "email" : "JSVZPxaB@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4yJHvcsdblF9NcuIDAMrT",
        "title" : "Found dead",
        "comment" : "Qu37mVtumr"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:50.440603Z",
      "updated_at" : "2026-09-10T08:07:50.440603Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_HLeKrXvfMhFsmXhUmCFEs",
      "name" : "cU2Sp Overwatch",
      "email" : "yISK2h6P@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:50.107582Z",
      "updated_at" : "2026-09-10T08:07:50.107582Z"
    },
    "created_at" : "2026-09-10T08:07:50.609397Z",
    "updated_at" : "2026-09-10T08:07:50.609397Z"
  }, {
    "id" : "mst_3QT9S4lQb3d6k2YFQHqmLP",
    "measured_at" : "2026-09-09",
    "calculations" : [ {
      "id" : "vbl_5A5RCdpL1SnEjExkgUo9aL",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_4mfAG3ndpIkZmnPPKM5Hfr",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_3NNfhRG8Lf8In985bGK4R8",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_35yeInxN8JD8qYjnY8nWYJ",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_35yeInxN8JD8qYjnY8nWYJ",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_ThehOVMGuljXnGtgjQgEa",
      "project_id" : "pjt_76tfgZfM2qZMlagTRhfRlX",
      "name" : "v6Y2ztq9dn",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3tMuPL8ATETRrO3RWo7lWg",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "oPxAHyPi5j",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4cQlnqIiKK6vPUYCySrgkB",
        "name" : "HQOO3QSski",
        "email" : "ZkhXP88d@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4Wv71s4guKSthd2YBMOE3s",
        "name" : "sabFZ8t4tj",
        "email" : "ELsx4IJf@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:50.141007Z",
      "updated_at" : "2026-09-10T08:07:50.141007Z"
    },
    "animal" : {
      "id" : "aml_7WDByRi5YFzZaaiTK3A2TU",
      "study_id" : "sdy_ThehOVMGuljXnGtgjQgEa",
      "study_group_id" : "grp_6JOaRSn9QJZPnoVsL0bFR0",
      "cage_id" : "cge_69sIp8mGHye2o3CPBk2HSD",
      "catalog" : "A0000001",
      "name" : "Ie5wsCnwq1",
      "number" : 1,
      "strain" : "GBBPeRmppy",
      "species" : "QTgzHiy7nV",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "IKEdgbOngK",
      "ear" : "VLfSgNmomq",
      "tag" : "yBQGynk3Tp",
      "donor" : "t6f5797XzE",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_35IodvfDzEwkn78jx3kuWt",
        "name" : "MEuOeJbmnG",
        "email" : "JSVZPxaB@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4yJHvcsdblF9NcuIDAMrT",
        "title" : "Found dead",
        "comment" : "Qu37mVtumr"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:50.440603Z",
      "updated_at" : "2026-09-10T08:07:50.440603Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_HLeKrXvfMhFsmXhUmCFEs",
      "name" : "cU2Sp Overwatch",
      "email" : "yISK2h6P@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:50.107582Z",
      "updated_at" : "2026-09-10T08:07:50.107582Z"
    },
    "created_at" : "2026-09-10T08:07:50.618790Z",
    "updated_at" : "2026-09-10T08:07:50.618790Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_7WDByRi5YFzZaaiTK3A2TU/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_7WDByRi5YFzZaaiTK3A2TU/measurements?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_7WDByRi5YFzZaaiTK3A2TU/measurements",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Animal Observation

Retrieves the details of an existing animal observation.

Attributes

Path Type Description

id

String

The unique identifier of the observation.

glossary_id

String

The unique identifier of the glossary item.

team_glossary_api_id

String

The unique identifier of the team glossary.

team_glossary_id

String

The unique identifier of the team glossary.

title

String

The title of the glossary item.

label

String

The label of the glossary item.

text

String

Text related to the observation.

type

String

The type of observation recorded.

value

String

The value of the observation taken.

observed_at

String

The timestamp of when the observation occurred. This value can include a timezone postfix.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the project.

updated_at

String

The last updated timestamp of the project.

Retrieve an animal observation

Retrieves the details of an existing animal observation.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/observations/{observationId}

Parameter Description

animalId

The unique identifier of the animal.

observationId

The unique identifier of the observation.

Request

GET /api/public/v1/animals/aml_3bfMtCBvnjo9n8kUhfPaFU/observations/obs_4gX0ztni11vdhTJ1xBUk9t HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhYjZmNjRjYS1iZWVmLTQyY2MtOWJhNi1jZTRiZTkxNDY1NjAiLCJqdGkiOiI4MjE5NTA1ZC1mMDM2LTQzMWQtYTRkNi0yNmE2MjY1Mzk0OGUiLCJpYXQiOjE3ODkwMjUyMzcsIm5iZiI6MTc4OTAyNTIzNywiZXhwIjoxNzg5MTExNjM3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZTNHdsRXJqNFMzOUk3UzdCaXlReWwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.QW62zlFaOsmuduVgZt8yh6Sn9o1MF9mgCDakkPr9Xl4_aLsf01nNYwlpMsYbXQLBz_YTCvLSMQ4PGXfpKy0yJDjkUuCEFZt95atx7yAa58ja1oOaKvZ6s_hEvxrGzeKzbUyXFYs-8Uh11Ik3uiXBlpP87PotRe3ct2AaNtVDnPatCqEXOx5GcGFjV_l4ix-Lqs4pxFEwHTKrwRas69DE5CKckPQWKrsTDcYOUXWR98n3TaH5vNHdBA49USjRw6SWDQM47YO7hT-p_NAYcZvJQa8gRXJpB-Q2HZSLLXjek5uRqRpImHb4fsJb91oRfoMp3Zi4OS3ic_EXl85Ase9T39KMZtb7i-m3Svc3lpEBLihPJeUlYvCB8i6yHjnEGiUqjbKjwuOKsEeCb74ElkHuuZm6L15RFP2tUOvL79lRLu3UvxZBAUXmLhkO4Z3nDFW1IAZGTxPZNfLgo18zddY28wDiG9p1FHy6OvhZB7UDo_XjhtFnTuiY4ThTQg6Qgfw5ArI_baUMUAtfrUHug1ODhttr4IWNEi0lts3SpOZkpJjrkVfO2BISW9UDC3C_9VQnoKwuxAsRyK2JTojlqMBf5BK0zveYqTHNmKvzUnSTcdoHpfiZKCvLQ1DWDkVAirlpWo-889e2u14PRSb-zew3nasJsAoBnXzRVtXgPOReg54
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2806

{
  "id" : "obs_4gX0ztni11vdhTJ1xBUk9t",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_I2L48jzuxGuA4sQgjfLIS",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-09-10T07:27:17.788685Z",
  "study" : {
    "id" : "sdy_J3VVziqEeyHH7fRc8BWkZ",
    "project_id" : "pjt_3ILIu7KheOV6e18Bp6qu8J",
    "name" : "1AQpYOz9Wy",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_792vxEEgJtuAvbeqS9INk6",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "3PvpHQBgRg",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3ucqt3Uad2hzECLfXzh7Nu",
      "name" : "ovXruDyRPn",
      "email" : "3NCEPWbz@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1ZgAqwJ0bAeQqXuahN8m4m",
      "name" : "GOGgkLEdbg",
      "email" : "Wl6qWsQ3@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:17.153444Z",
    "updated_at" : "2026-09-10T07:27:17.153444Z"
  },
  "animal" : {
    "id" : "aml_3bfMtCBvnjo9n8kUhfPaFU",
    "study_id" : "sdy_J3VVziqEeyHH7fRc8BWkZ",
    "study_group_id" : "grp_29hbw7nQ6wFBsXsfuOsqgN",
    "cage_id" : "cge_6risRD1TxHXPrS3ExrdtEZ",
    "catalog" : "A0000001",
    "name" : "nzHcuTRRlu",
    "number" : 1,
    "strain" : "HnCWs4F15m",
    "species" : "B8YlKoUDxa",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "7sS2e83fvd",
    "ear" : "JAHtHpU5Ls",
    "tag" : "iWBXv7AkxY",
    "donor" : "2szrOvPnGo",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_7aLq0t156LcjDoKcgXdDtQ",
      "name" : "toBxTUuQoo",
      "email" : "LVvTyca3@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3G68N7MXvs7OLEBW8mGegl",
      "title" : "Found dead",
      "comment" : "djReTkwWgZ"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:17.557622Z",
    "updated_at" : "2026-09-10T07:27:17.557622Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_6ZdVRaiJYMwfcXixMPxVVZ",
    "name" : "lA6s4 Overwatch",
    "email" : "88GaAuHu@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:27:17.108992Z",
    "updated_at" : "2026-09-10T07:27:17.108992Z"
  },
  "created_at" : "2026-09-10T07:27:17.789088Z",
  "updated_at" : "2026-09-10T07:27:17.789088Z"
}

List all animal observations

Returns a list of your animal observations.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/observations

Parameter Description

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of observations to return per page.

page

The page of observations to return.

Request

GET /api/public/v1/animals/aml_3tF31Esfv0uMJiLVuP4TeT/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhZTdlMzkzOC01OGZhLTRhN2YtOThlZS1jMjRhODE4NzI4ZmMiLCJqdGkiOiI5MWVmYjk5OS0zNDY4LTQ3NTUtOTJkOC1iYTMwMGNiN2FlMjEiLCJpYXQiOjE3ODkwMjUyNTMsIm5iZiI6MTc4OTAyNTI1MywiZXhwIjoxNzg5MTExNjUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNIQjNXSFFIRURXQXpacTFhR3lVNHMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.gIzlGZEs8jnFDo0lB6Ug1Ya8Hkjw8G2xtzbF-WhEI19Alf06UnWrlC5HriEZJ2FoSDKsIPDpFFwFGXkwIneIMPcNj9oI38TTPGsBcAX5xZqEk7TRogwwffHLR0m_0nt2yD7joJO1U4sVSRTlSsPupn1W7tteuQWDpoDW_UJIUpCCmcS7Z1WT56cBqCW2HM2CqowihDi78p1veW8Wve1qtojUG-1tJ4Oic89b6xSj_NMY5-yKt6vPIQ-6TYNNMyfdoMzyPWxb4JTlFUnxSnXBtWNDpmYtIPDxkYr4PhYtuOWDz5ILojdeEAwc6wUg11m3dw_ffDF-_WWJbGeQVQXnZbKBCAbebMybNNLpEpvpFlsHDGAYyiNK2EhGFOrTEAPEu6FW1X3OaHvlSaD6XUmyLOb_4mZJw549kW5zoF_U7JIhE476NXkOYknu3yx7zKgLKnCA-97VHJPIrre8HZa5rAWZoEbXf--rdrKYE2iQQTivIP8YGj4OdE-kfx1ISXGCsc-XBwmN7GfAmBPTw8EkwnzjCh_bcl6PAkrguexazCdnoviKU90TShTPJVudo1Z3QygP2IqZpjfCaa7u574AfraOjdLTfIG5nwqoMYSiYimUwl-yuXj6dmi9QIhauMykNkvxdPjEGR6We0AnL8pccc69m4gkosVGWdnZURsDkqM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 27
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3515

{
  "data" : [ {
    "id" : "obs_3I0gbFb7ZeLxhesZr5nV6u",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_4P2v4jmjw9F5Iqn12yxlT1",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:27:33.262695Z",
    "study" : {
      "id" : "sdy_7YzBxB8KqOr7G5H7GO8pwI",
      "project_id" : "pjt_60ynldvWFRkTxt3kpk8Fw5",
      "name" : "ha5X4XrUCh",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3ATCaphMCxREf4nEix07AZ",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "WDNyayjTMm",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5hf5m4OLq19MrZflAgUHGd",
        "name" : "F5rf1C7XQ4",
        "email" : "e0kFXIlO@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4Nr8yQxDx0YCAUlcix2wX0",
        "name" : "FZsF5U5Civ",
        "email" : "TemoD0yE@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:32.739660Z",
      "updated_at" : "2026-09-10T07:27:32.739660Z"
    },
    "animal" : {
      "id" : "aml_3tF31Esfv0uMJiLVuP4TeT",
      "study_id" : "sdy_7YzBxB8KqOr7G5H7GO8pwI",
      "study_group_id" : "grp_7bnQnxD4LxK4NZ1PxUaGOO",
      "cage_id" : "cge_5Oz0QG4f9O0JI3ku13EkFr",
      "catalog" : "A0000001",
      "name" : "oeWL1vL2um",
      "number" : 1,
      "strain" : "yph9xDsdSd",
      "species" : "VVn7iaELJu",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "SrmozGjUiR",
      "ear" : "V5CbUy45zi",
      "tag" : "lkm7HVsA96",
      "donor" : "cKJi7ozPPl",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_15M3fkAeOimGra40f5Att6",
        "name" : "PT78aYr4bC",
        "email" : "LQCAYprA@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1Es1eUzzk7j1aCLbdq7cHI",
        "title" : "Found dead",
        "comment" : "0dFghtv1Ix"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:33.102686Z",
      "updated_at" : "2026-09-10T07:27:33.102686Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_1OHl3jNHd924Z9HvPZ2oYe",
      "name" : "65f5k Overwatch",
      "email" : "nEz2N6SZ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:32.703002Z",
      "updated_at" : "2026-09-10T07:27:32.703002Z"
    },
    "created_at" : "2026-09-10T07:27:33.262794Z",
    "updated_at" : "2026-09-10T07:27:33.262794Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_3tF31Esfv0uMJiLVuP4TeT/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_3tF31Esfv0uMJiLVuP4TeT/observations?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_3tF31Esfv0uMJiLVuP4TeT/observations",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Animal Sample

This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, status (collected, planned, cancelled), timepoint, details like volume or mass and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the sample.

sample_id

String

The sample ID of the sample.

label

String

The label of the sample.

type

String

The type of the sample.

status

String

The status of the sample (collected, planned, cancelled).

timepoint

String

The timepoint identifier for the sample.

collected_at

String

The date and time the sample was collected, as an ISO 8601 UTC instant (e.g. "2026-03-25T10:00:00.000000Z"). Empty for planned samples.

details

Array

The details of the sample.

comments

String

Comments of the sample.

sample_definition_id

String

The sample definition ID if the sample was created from a plan.

metadata

Object

The metadata associated to the sample.

study

Object

The study of the sample.

animal

Object

The animal of the sample.

user

Object

The user who collected the sample.

created_at

String

The timestamp the sample was created, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

updated_at

String

The timestamp the sample was last updated, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

Retrieve an animal sample

Retrieves the details of an existing animal sample.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/samples/{sampleId}

Parameter Description

animalId

The unique identifier of the animal.

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/animals/aml_6hWJDw39Z1723avflPbXbe/samples/spl_3v53xvXQHlnAlOmJB5TJQA HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMjZlMDgyNi04OGZjLTQ2MTUtODJiYi05NjkwMmRjNzdiMTAiLCJqdGkiOiIyNDVmODBkNC00NzVhLTRkYWQtOTJiZS04MTQwZDhlZjU1ZGYiLCJpYXQiOjE3ODkwMjUyNzksIm5iZiI6MTc4OTAyNTI3OSwiZXhwIjoxNzg5MTExNjc5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZ1eXdvZ1ZtTUx4N2dZdzZ2M05TMDYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LkcLnk-ut5uZqv5ETG0srMUYzyVvD7Quvxr8UKMqdlNzF_G4WmaqDmlu1-22eQuMZHv454BJ2lEka0pKjuBIAEA_RPCbLlv9F_rPY8kUjAov2t9f7Zkk7hPGGRSqQdNhZ8fe03ZW8zfz44VSSBE28mPID1Rb8hEzvs5ihrZ2YeihbJAve9g0XGNlYk5Xl-H0nOEMzRV4V56NAMsLb9fMDS4Aj5vdJn4OK4A1a6kQ1BUBae2FohucbvMwYrqvBFotlp1qRT6X9GmWbgTRzpwrkMzFhW2Jf9hS906wISt01FrVy5v40cA2oysFRbLRtIbUvgiK4RIOaigKc7FI4stWw--7CMVGnYl2ghw83TDSVwbZW-FtFC1zntNTqO2YHCfdImsoMDshd-yVoW4TA-C3Qj-kWN2_8RBw3_-wxFbOJXpLEZBeQhIbGKbIF1zQDWhVqG_Fwv9ZKoj2xt2GOqKYKb44Yjxf56W7SEwKRjkcZ4K43DYICps03RfThCcKInhDIJkvsVuYOTIo5AU_8UY4SzaU-sJj9T5a3OMsrhBjEWIAv1VS-KFz70RU3UdfEnh5k0KHyDKw4LuJ1VFWB7Xk8OZjNvLo6DWKb2FKCq3vxWNreiSLdqWMwKqMXr2yv86dkJ88pAqkJ6MF4mE73Ky4apcWntJhaNZL70T0MgvB1I8
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2959

{
  "id" : "spl_3v53xvXQHlnAlOmJB5TJQA",
  "sample_id" : "S596602244",
  "sample_definition_id" : "sdf_2ndB1hOdyfVm9zpOzl8Q7V",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-09-10T09:27:59.353342Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-851348005" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_5GyNzXjYpU8huje8lFDJ0t",
    "project_id" : "pjt_28B78aFfuwG5zV3UQprpsZ",
    "name" : "l00R3SIKwn",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6QrBsSl2UQPzMusKRTDM40",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "cPFrJM2WSa",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5U0WQBmDOtOe3XYEfH8fzi",
      "name" : "MjEjH7RNKN",
      "email" : "Gz6sLAzF@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3V0Oyw1O5ruaj73ugdwKrf",
      "name" : "iDZPrCnSZL",
      "email" : "PhkP15Zk@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:58.529725Z",
    "updated_at" : "2026-09-10T07:27:58.529725Z"
  },
  "animal" : {
    "id" : "aml_6hWJDw39Z1723avflPbXbe",
    "study_id" : "sdy_5GyNzXjYpU8huje8lFDJ0t",
    "study_group_id" : "grp_2YsD8ak65RySlKlbOgrBcR",
    "cage_id" : "cge_5FlFEmKVJpS61Xcc06alcH",
    "catalog" : "A0000001",
    "name" : "NTI3v80o6t",
    "number" : 1,
    "strain" : "aufHQxogg2",
    "species" : "lTxHNCtq2Y",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "b72FPx0DgI",
    "ear" : "RquONc3mCa",
    "tag" : "ejc7MW4FKX",
    "donor" : "GQcCQkU5ju",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_1MnNYVlAuWSCZHqem9OIeV",
      "name" : "NoYlIZREOe",
      "email" : "8GYwc8P5@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_mlYomTLDWKAn67STn9cZ1",
      "title" : "Found dead",
      "comment" : "ASjvqKHw7v"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:58.976206Z",
    "updated_at" : "2026-09-10T07:27:58.976206Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_57ndVGTECKoDrjsbB0KOhD",
    "name" : "DV1r69fTYc",
    "email" : "qWIIkc0Y@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "V1RCHdtmwH" : "5qdrc8BWvy"
    },
    "created_at" : "2026-09-10T07:27:59.338931Z",
    "updated_at" : "2026-09-10T07:27:59.338931Z"
  },
  "created_at" : "2026-09-10T07:27:59.354616Z",
  "updated_at" : "2026-09-10T07:27:59.354616Z"
}

List all animal samples

Returns a list of your animal samples.

Authorization: Your API token must include at least one of the following scopes: animal.read, animal.*, *

Path parameters ./api/public/v1/animals/{animalId}/samples

Parameter Description

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

Sort samples based on an attribute (animal, cage, date, group sample, study or type).

order

The order in which the samples will be sorted (asc or desc).

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/animals/aml_2myiKMU2xgZJDqdQAlzpZH/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyMTM5Yjk3ZC1iYmU4LTQ3MTYtYTkzMS1lMDE4YThhMGQ0OTYiLCJqdGkiOiJjMWU0OTJjYy1hNDFjLTQzZjMtODdjOS04MTkwZjU1NDAwOWUiLCJpYXQiOjE3ODkwMjUyNzMsIm5iZiI6MTc4OTAyNTI3MywiZXhwIjoxNzg5MTExNjczLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1NEOFhLd01wQW1NUEk0Zk10ejNRZSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.N2VXx94imcXL-WsZSzvv4HzQPEEqT9MdzDB3HSDwjFzwzS3aXOebO1EkGR2tvokgdr6YPrFdGq_fpc_s2Lsip9e_S5K7iS3NmwyuKTeZNOWE3mf3Au13KniyDqm5sutw59as-3K0dZdwbumQgXlOVHgE8Z8uGLdeKpgnhIy0ClLaWRMNGOsNEFS0Hf8vb449JpRADDYsUAN36bMc_vHl4XqPwqzB38SBA8FkuZN3D7IvHCALKDZeYqDTAFgWMMem-TGkhCefAPZRJ6nC4PCdZHN-0qiOKWF45uAWFVIFYUIYq1PBzf9Ua58Q4RHPGEcyeoRHJ5sdwtfFXzgU20fnsAZxmVvyCgo8gtx-EUaCv4n9SOhywfGIwuq1O_bmshICOtonmawZCL5yhU6ARl3e6eBTsJwfH1PMa8WxkHLLKLFcnFD8ndIQ0IJjTN323Wp3j-8xznZopehWFUMOWkWSgBJ3Qdx1-vmzjq43QFu4ltlE_7RFqLCA7KCLlv0EI24crrTXXsMfu2Wnx0DdFHIMoQueZ16w9CPbLTCRr1klt4SOWsQihAbnHROi7ewZHPE0SQeQVK3Pw8-arH6Wrw5xxo-ySA7sn8jUFn5vBgRkVkSW__pAzx0LZIVkPWcWgn_EVvbG3wtLzPcMtBn3HvvTamqJJJ6ecvB7r7xIJFlKcdU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 7
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3665

{
  "data" : [ {
    "id" : "spl_48VWB4lEBBSnWYZO5rhOu4",
    "sample_id" : "S135032637",
    "sample_definition_id" : "sdf_3BgUz3s1ZhmgsHV3Xh4yli",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:27:53.108998Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-49485837" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_2GjvkWLaxM7F86JEsyu8bu",
      "project_id" : "pjt_2IW0uPr3zW29uMESRDPhmU",
      "name" : "IWFjtnd9M1",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3EbnDXSBJSyatyUaGArvTu",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "QxFr5c01Vw",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3eu2PwsbH4LQrwDFbRVG2e",
        "name" : "fWbU43eZF1",
        "email" : "4TZD5u08@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5axqd8SNBk1XqhIyTf6zh1",
        "name" : "EZRDM5KJdX",
        "email" : "td9D7s9J@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:52.457540Z",
      "updated_at" : "2026-09-10T07:27:52.457540Z"
    },
    "animal" : {
      "id" : "aml_2myiKMU2xgZJDqdQAlzpZH",
      "study_id" : "sdy_2GjvkWLaxM7F86JEsyu8bu",
      "study_group_id" : "grp_6S0SJGo0LlOZSLeYr1TCXu",
      "cage_id" : "cge_3RJxhKEZhCTzbfjw28pf9z",
      "catalog" : "A0000001",
      "name" : "NeXSxyzqCp",
      "number" : 1,
      "strain" : "DMHiukdY0j",
      "species" : "fQouUoVRF8",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "BcxHj4WAZ9",
      "ear" : "F1kS6DR824",
      "tag" : "3IxB5YPUGP",
      "donor" : "FkIteBlECa",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_5LzEboikBOXuf5SHgys9UN",
        "name" : "PgYEq1BBVS",
        "email" : "qMfIKg4P@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3czGEs78xvGyxhfPWWimIU",
        "title" : "Found dead",
        "comment" : "ivz8RV1CBu"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:52.775416Z",
      "updated_at" : "2026-09-10T07:27:52.775416Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_ObH4ockhNzPWnPbFVF9Zx",
      "name" : "669e1rx4b4",
      "email" : "pCDUIRz2@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "Ww4qQf9KVy" : "ku2debRN8p"
      },
      "created_at" : "2026-09-10T07:27:53.094503Z",
      "updated_at" : "2026-09-10T07:27:53.094503Z"
    },
    "created_at" : "2026-09-10T07:27:53.109217Z",
    "updated_at" : "2026-09-10T07:27:53.109217Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_2myiKMU2xgZJDqdQAlzpZH/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_2myiKMU2xgZJDqdQAlzpZH/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_2myiKMU2xgZJDqdQAlzpZH/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Cage Resources

Cage

This is an object representing a cage in your facility. You can retrieve it to see the catalog number, name and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the cage.

name

String

The name of the cage.

catalog

String

Unique catalog number of the cage.

metadata

Object

The metadata associated to the cage.

study

Object

The study of the cage.

created_at

String

The created timestamp of the cage.

updated_at

String

The last updated timestamp of the cage.

Create a cage

Authorization: Your API token must include at least one of the following scopes: cage.create, cage.*, *

Fields

Path Type Description

name

String

The name of the cage.

study_id

String

The study of the cage.

metadata

Object

The metadata to be associated the cage.

Request

POST /api/public/v1/cages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMGUwZmUwYS04MjdhLTQzMzYtYjcwNS02ZDM5MmFhNzBhNDIiLCJqdGkiOiJmN2EyODM5Yi03OWNjLTRlODAtOTdhMi04MGVkNmFlNTJhNWUiLCJpYXQiOjE3ODkwMjc2NTgsIm5iZiI6MTc4OTAyNzY1OCwiZXhwIjoxNzg5MTE0MDU4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVqblBQMFJ1bUFqcXpHYUhwc0FFVVciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Nthn2igGbrd7yN7jPVLA0nXDTBQ_ZVV7FNddOnUpVayBHq1B47hZjMgcgD0Ea05TmBQEe_JqBJee7pumTDDg8J9JGyzPPxOIsYPRfoW9NFQiW2kzz288LBxbVw3i8JIi_j7XPxt1cZIX5CuXtqo9SXcYplCwFYSu3jRANHPUfORIGHRMHKsQ_K_gVZgGsDF5S6RlMPIxNhxCMisRcqkXBMPDHKgvxtkIz1rnslTfbhuO3hAv1Ofpon_-4SrciY-eWHAIwHp4f2UxhSe0cpaYsSvLutxAABZfl0yDo96aEEvXJ39A-KZZqgDBXcWYT1IVZZhQThCHkxQo3jbiNt5sWi58OzTzD7iwi1YHRLj6XOzQrLHl_wHJCYV6p5cY_Mj_lTWUqD8UGL5o4FeRZGVlRVAQ-9RhyJp4edrDNJ7glvgMMWZ26Hb7D5rrEZOSGK0XjnDd1ySXZjdecR0dIEZodTktc1kCOACCe8Q1t1wWS1srAUOE_hF5kpB1mp2cDfJoar0gCo3QkTN2MaMK-qMBb6gPCFx7lssv0wzn3UWxLd-QA85HY8wWv5J2In1-LpOFIBaM_QbEvHSv8MH_hwSfCZ1jGLJPm26196sZJK8fdGxSNLnMoBpRvO53OYVlynp0tR8gXfKleCbjf7FPJg7lSaw5VPSLIGHuiLVxI7JNF2c
Content-Length: 107
Host: localhost:8080

{
  "study_id" : null,
  "name" : "pQ6oXLQ6gu",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 22
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 265

{
  "id" : "cge_7gcDDnwfDYVkbIQ4Q0Uw15",
  "name" : "pQ6oXLQ6gu",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : null,
  "created_at" : "2026-09-10T08:07:38.608808Z",
  "updated_at" : "2026-09-10T08:07:38.608808Z"
}

Retrieve a cage

Retrieves the details of an existing cage.

Authorization: Your API token must include at least one of the following scopes: cage.read, cage.*, *

Path parameters ./api/public/v1/cages/{cageId}

Parameter Description

cageId

The unique identifier of the cage

Request

GET /api/public/v1/cages/cge_TtAC268dwILdxeyRzI9M2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxOTFiMDI0ZC01YjM2LTRiODctOGZjNi1mYjMzZWJiZWQ3OWIiLCJqdGkiOiJmZThhZjg1NS02YjE5LTQ2YmMtOGFjMS1lNzNlZTJjYjNiZjgiLCJpYXQiOjE3ODkwMjc2NTEsIm5iZiI6MTc4OTAyNzY1MSwiZXhwIjoxNzg5MTE0MDUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJXUnl3akNuTE9NenpGUFdiNG5TUHYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.VqMpVJbn5ulv_cIElBO_js-IBpgpz6x0ZJXKZN9QHl_84eVouY0MAxj692PgUU421eVQS0Nz0VAtDHeXq7xyQ-Hr27kI-IlVA83XnH3Iemt5ChWnVGWlRzD5onOacq2E0A66w9-27FW5_xhz9lWHTdiCQrTHvSxNefQsortz6qsyeZWB9UtI-RBPoq3AGOVkjcGt1mW1I2TcjazUY2-8bwlrkfp3ORWKgtBe2ryPhTkafJRb7t4PBAG8zlxwv114_b-QsyMDqFtiP3lY91N4Hwo4f_ylSprrJk3YqsdpoGd7_Pr8wF8SFAlwdXPMinBk0_j_Qb5tYoln50FnDMQRlhhTJpuvAtAmwMZr9D7yY1YR_G77m84avkxE2skRYNtkR8_E4lgIZPcDo2lkbC7uflFrgkgOL1gg9wU4YBAzwV6mrhwlrgWrAi7eFj90itvMDvoQ_-nx86tj1JzexjuzFdL_rhBkE-p8XDH2TcquGSxwZoXvfIrWmS2wGSZuwCoj0LQa1L-Sd_p629OymamzCheA1yYdLga7Ss2A4jA4pBNZeGC_ktWUi5H2A6_TZxsu1E7E1Gn-Xn-8lzPJiJyPS6aefM6YVG0Shwbgqpjh44Guw6pZFZn2-7svF5hWp72G0ks08SmeHvNQs4MKMzF4zZ2HmlWbrSfKMwqDjMuhrlo
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 29
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1194

{
  "id" : "cge_TtAC268dwILdxeyRzI9M2",
  "name" : "PsCinBXPAl",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : {
    "id" : "sdy_79IDtIQ72NFc4lpubxrm4G",
    "project_id" : "pjt_18ZHeVrB20Kix2zRoyH7g",
    "name" : "3xpfkMYCq2",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3dqmTFODMA41nMbaOdrvGi",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "ypKV9jvvL4",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_36IIDeQ3OHsLDIFtMLxP1i",
      "name" : "4h0hBIQvY5",
      "email" : "PsJzOh9k@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_38F6yLHv4bEW1FJSCCDgYf",
      "name" : "RpbYmfRm6o",
      "email" : "JGLZl08u@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:30.887739Z",
    "updated_at" : "2026-09-10T08:07:30.887739Z"
  },
  "created_at" : "2026-09-10T08:07:31.287190Z",
  "updated_at" : "2026-09-10T08:07:31.287190Z"
}

Update a cage

Updates the specified cage by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: cage.update, cage.*, *

Path parameters ./api/public/v1/cages/{cageId}

Parameter Description

cageId

The unique identifier of the cage.

Fields

Path Type Description

name

String

The name of the cage.

study_id

String

The study of the cage.

metadata

Object

The metadata to be associated the cage.

Request

PATCH /api/public/v1/cages/cge_cN4ctSLvHJjUXYWAdn1OR HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYmU0ZWJjMy0yNGIzLTQwMmQtOWFlMy1mMmYzNGVhOWU2YzYiLCJqdGkiOiJhZDIwMzY2Yy1iOWZlLTQzY2UtYjA2Ni1hMTAzYjRhMjg1ZjkiLCJpYXQiOjE3ODkwMjc2NjAsIm5iZiI6MTc4OTAyNzY2MCwiZXhwIjoxNzg5MTE0MDYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJYY3YyTlFBZEVlYnZSTlRGaUZNdXMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ni6_uc2DH6zIj97AY8OBGcnFO9dIkUhz5sPZW_d4PArDjGyYcrIpyXMUZraROv4XBAnjzcn72L6XId1PMYu7MAD-eA9vmsRT4nYojNwkDblqPWwGnMG1QkkPXkHRyP4BMK_QHHKSrRL4lFcE3W47wAedYhQkCz8i1fPY4vJ8cCVLEH7xPSbsoj6QjuNz7FxxUELphZyNooBJFUGw5ymLYF7AXQcGLpA2df2G73V4C7zRnM41tkmhDh9N-yhmXVcH7jcUYiVMY3jn6-RzVmZP027LQsqZJ2EXDturDaiwK1hmelJR_uttn3RMoDaKZAXLn4U1k-c_F8Iz3r867LSLJO7ukzIQly3_exWYcKKLU1hIwwRvZ7rFqErfeiHBpRIg3ODU-b3_ZUdpZKAMRSTEMVpgsh5xMKLD7Lwho3CpBYTFABwMHWlg6ICwPH0nc9jWTkiW3PLM5gCmWgbEeV6-0kEr4RoDd5wBUdKXjBrm1H9qTXUQtqBh7Kz92NmEQZGoF4qkuRRO1dAmvirteSM6n64SnQMrVOPlDTiFtndl5aP7R9LmY97vsBLP9uAJk-lm-3gLa6CnNOr40cXSN7pUoqGgNTFhtBYeS_YlSTTwUPrU3qWUCV0b00dG_vIEtdYNSY5ov-S5ntp4m82PdhcEQuwbsBdw6CKSyQGhaXbwmBM
Content-Length: 143
Host: localhost:8080

{
  "study_id" : "sdy_3hcxVW6JfJUbPdes8V21z8",
  "name" : "Benchling In Vivo Cage",
  "metadata" : {
    "cage-internal-id" : "CAGE-4321"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1215

{
  "id" : "cge_cN4ctSLvHJjUXYWAdn1OR",
  "name" : "Benchling In Vivo Cage",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-4321"
  },
  "study" : {
    "id" : "sdy_3hcxVW6JfJUbPdes8V21z8",
    "project_id" : "pjt_4Itebhtwa8n0z7KoZxmBeZ",
    "name" : "T1OL4Mh8wi",
    "code" : "CD-26-446",
    "study_code_id" : "sdc_5TMCWvmzVQO4YztlJXqJR2",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "9wExVFSqd9",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "new-study-internal-id" : "NEW-STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_6FZunxbZX8jQ5a3aCSSzoN",
      "name" : "5bqD3KihHJ",
      "email" : "exkBbZUv@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6awy3pngWEoa4krqvw5KDd",
      "name" : "di7Tj980fb",
      "email" : "Y3GQc1fw@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:40.571356Z",
    "updated_at" : "2026-09-10T08:07:40.571356Z"
  },
  "created_at" : "2026-09-10T08:07:37.835834Z",
  "updated_at" : "2026-09-10T08:07:40.919298Z"
}

List all cages

Returns a list of your cages.

Authorization: Your API token must include at least one of the following scopes: cage.read, cage.*, *

Query parameters

Parameter Description

perPage

The number of cages to return per page.

page

The page of cages to return.

name

Filter cages to return by name

study_id

Filter cages to return by study

catalog

Filter cages to return by catalog

metadata

Filter cages to return by metadata value

Request

GET /api/public/v1/cages HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlNjhlNjM3My1kZjljLTRhM2UtODYzZi01NTE2MTdmY2UzZGEiLCJqdGkiOiIxMmZhYmM0Ni04YjllLTQ3NGItYWRiOC04YTQ0NTVjOWZmNWQiLCJpYXQiOjE3ODkwMjc2NTQsIm5iZiI6MTc4OTAyNzY1NCwiZXhwIjoxNzg5MTE0MDU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZkRXdhaVlNZ1FoMUlPbVAxSFVzZG0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WXWDjb0eKLGr-h0Dr47Wihpp_qmmHhA9Ijmv-LQPCAUr_6tVmg7WGf-Lu9JW63eBhgnTvi41kgFGgEfIpNGDfzhiSiCxiI84jOoEDjyRA3bRWmLgbTrveyCYGIb8fmXFZuDoVOIvzNEABBix_OXPjhlQlMbpXDv1Oy5B09jigHN8OtGX86SqF1DVD3pspK6x0hkVnFKL9na-Ub2VdxmpkQzLqF11lEvlMdYAo_ABi-_pZfVMMTGABfHDsf4Ngl9FFU4C7g0M2u5BSQBZxJ7c5J8qUno1G-eBnswvSiCIaN0oxelEhZCBo8PTFRV1gsS1Pa8Qt6TwiP7fJHK5prn_4OQjCKp4zc02MF6ox6q-2HkVsQhBeX9EjCgvneZe7IpxUwoVTWcaycZU8CzvYc_DheENb7Qq4-cw-IKm4bQ523jpneOzbWuYa3NTHUeAZ1z9pfsmE7lIgPKwoBIQSNnMfCas-tjqi_j9yu_J63pIy_2kuurWP0OOGyFfDuCV35ZkHFE1lWoEZygI3Q241j7tvP63jbvOMbQ2Mt6i8WdYZ-SwWVZyZwkUXLGXYtDvOKCo2NcJWOCJ4cUytgwrffiRDQZvT-q75qzEx3QvoWut_s1JSmUr328JVxXVmjWR-K_V0YGYVBKVTfaHzo4iozVmIUNGG2Jjb_rwXYg1XAEmwAU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1670

{
  "data" : [ {
    "id" : "cge_1lnAzRFmv6Nkb3RP8s9GtN",
    "name" : "cuDcmkRmh3",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_6ZiAcQVhOEKvfJCTVncZwX",
      "project_id" : "pjt_BzVme3MB0GCUIX1neeD2c",
      "name" : "wmDSQSukMJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_21A7vYnPL52UXJKYfC1fy0",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "9B4gf7OcJb",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_43qRgZgeXGavIo8PKGc5J5",
        "name" : "AVhWFMDCAa",
        "email" : "h7oK83zc@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_uMILcPy6YG4FLG4p6aaaf",
        "name" : "kuWZDBYoBX",
        "email" : "8Ah3HjiS@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:34.394472Z",
      "updated_at" : "2026-09-10T08:07:34.394472Z"
    },
    "created_at" : "2026-09-10T08:07:34.657374Z",
    "updated_at" : "2026-09-10T08:07:34.657374Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/cages?page=1",
    "last" : "http://localhost:8080/api/public/v1/cages?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/cages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a cage

Removes a cage.

Authorization: Your API token must include at least one of the following scopes: cage.delete, cage.*, *

Path parameters ./api/public/v1/cages/{cageId}

Parameter Description

cageId

The unique identifier of the cage.

Request

DELETE /api/public/v1/cages/cge_5C2eEheuZhqPdC6XKwQhBT HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNjMyMjJlNi1mYzQ5LTRmYWEtOTY4Mi1jZjk4NWY0ZTM0OTgiLCJqdGkiOiJhM2IzMjUyYS1jZjc0LTQ1MDItYmJiMy1jM2Q1NWFlZGU1N2EiLCJpYXQiOjE3ODkwMjc2NTksIm5iZiI6MTc4OTAyNzY1OSwiZXhwIjoxNzg5MTE0MDU5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzV2TzVtTDRDWExORWNwYWxpSjFEaVUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WLgiHsDgys4lQXRtW-919elcVPT3QgXGh25X2gCwzftLeZlEBQkvr5a8VTi08dNfmWN3XZ6KYKqnhEmfJySFiUcq5bQwD3XxpUZPT5KCkE_k3lqwFY2h1d4a__iDw6EqzsP5K8Mwtk9-4j2XKoOF_IvGcevUs4pA7zPD2hSXJv7OSMHPSzu18N-GVlWw6niMQ2y4W57DcRm_Z8N3FVzk_fcsW5QKtg6sbal-ihjEpzHfl7Recpn26r7Qe-RGuXHl-IqH8392jRFYAl5jHhYYyRDaO89LbpvE2X8YmS-IfthzTnASM77OiyTA_SxPxa3qse5JYlCsH7WcIlJ9rrcVLuXB-NFgwzIOMZuAgLXdiYzodYz0BNUfO-VXVNTaNvCc6UBUXyH6gdie2t3YZkorItDMg05USrskmmdZxHd9iEIdje_NbD8HO5QBqYzYloUh3-Z1EO_CwnVJbv1EU4BmYv3IdzSed-q9QvmYhQFMqhut-swu2ncIDbboEqAfd9_ptAm5lYnBgOScIW5dPuhtUkCo9F_DSJ0MWOuMeS_fNE-eXH3K3TacGI8eTfFIe1mYRal4Bt8T9nsgeeaiIKRt0jN43PQ6DWydg58A0V0awOnKJj1xKZs8zHAZw9Uj1wb5h4S-ALlMzxchxr7Q-NPBiHR3zafH42AyEHJjKWUBHaE
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 21
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Metadata Resources

Metadata

Benchling In Vivo entities—including Study, Cage, Group, Animal, Sample and Project have a metadata parameter. You can use this parameter to attach key-value data to these In Vivo entities.

Attributes

Path Type Description

id

String

The unique identifier of the metadata glossary.

type

String

The type of the metadata glossary.

title

String

The title of the metadata glossary.

slug

String

The unique slug of the metadata glossary.

field_type

String

The field type of the metadata glossary.

options

Array

The metadata options associated to the metadata glossary.

active

Boolean

The active status of the metadata glossary.

read_only

Boolean

The read only status of the metadata glossary.

Create a metadata

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Fields

Path Type Description

title

String

The title of the metadata glossary.

slug

String

The unique slug of the metadata glossary.

type

String

The type of the metadata glossary.

field_type

String

The field type of the metadata glossary.

active

Boolean

The active status of the metadata glossary.

read_only

Boolean

The read only status of the metadata glossary.

options

Array

The metadata options associated to the metadata glossary.

Request

POST /api/public/v1/metadata HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ZTk2NjU4ZC03YmNiLTQwMDAtYmY4NC1lNDI2NDgxNDA2NDAiLCJqdGkiOiI1OGMwYTFiNy00OWU0LTQwMGUtOTYzZS1iYmIxNzUyYmNkZTIiLCJpYXQiOjE3ODkwMjUyMjcsIm5iZiI6MTc4OTAyNTIyNywiZXhwIjoxNzg5MTExNjI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN6U0hoQlRyNENUOEF5amFTWVc3OFQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.IecBIOwLKKLQ0o02ny3ST_CK88GLCnOEqReVXB_zM3WoIMwVINMIDy1WrM0xAgsJZ3EJJojoj9M6mxYUmjr1QY8rJPsd46xJlEs6NCP2wJCOJBXTyKJE_6cgGwpZBJcCncZkXtA70ADHzbpBt6VA38iQ39O-x8BS0i2B1AVvp5jhM4dm5cz02P36g8ZVqm5QzcIZx8SotL80y0ZVuWPReurG6tVuKkfVXa_Q2JUsLiobkDN76cpvGdZimS0itEXUiGs-OrawhsBYRulPx8Fsvr-aQbAM90isoTQZAFwgGebC_R23f8mDeGOLJ-3zYH0bisTNBnPxrpCA2cv4ncTd0HHer4OV034R7MbFeORLnRLs6cD5x61ZvsBB8V3JY3zWho4vNixFYo9uZ10OJEGVxARPQcsaLAaUND-3Y-k8dgq6ISkfjXT0MYqVfODG-ctPJJm8pjLT_v1TbqnxByPT9Q1R5DZTeVcqdb6oCFsglrcmZk7YI3rQt2eLgHLff4qov3PdxwHIPEPYhcpXmKm3_yw3FMf2abEii8mMnmiA5kWSXN0oMcfcChBw8ZmvcX41pW4yn5xv0ghoEm7uc_oJ2CIc8O4HjFtcI4qgNxmRQFuMbyTGvKROeAJRDaDT8ty9CheKKaKgdmyFbjc8Ui8gqR9Qlei9ttndnwykSqceLD8
Content-Length: 174
Host: localhost:8080

{
  "type" : "study",
  "title" : "ZTPbeDwRWh",
  "slug" : "b983mkWY7m",
  "field_type" : "select",
  "options" : [ "1", "2", "3" ],
  "active" : true,
  "read_only" : true
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 213

{
  "id" : "mgl_3TAugTqUeHNiEoUKoSnyZQ",
  "type" : "study",
  "title" : "ZTPbeDwRWh",
  "slug" : "b983mkwy7m",
  "field_type" : "select",
  "options" : [ "1", "2", "3" ],
  "active" : true,
  "read_only" : true
}

Update a metadata

Updates the specified metadata by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}

Parameter Description

metadataId

The unique identifier of the metadata.

Fields

Path Type Description

title

String

The title of the metadata glossary.

slug

String

The unique slug of the metadata glossary.

active

Boolean

The active status of the metadata glossary.

read_only

Boolean

The read only status of the metadata glossary.

options

Array

The metadata options associated to the metadata glossary.

Request

PATCH /api/public/v1/metadata/mgl_1xKyiobB6TxIp33prPti1j HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ZDNjMGIwYi0xZGY3LTQ5NjktYTkxYy0xMzgzNDVkZDNmYTMiLCJqdGkiOiIwYzYxZjNlYi0zMWJjLTRmZDUtOTE3OS0yMTgxNTFhMTllOTkiLCJpYXQiOjE3ODkwMjUyMjksIm5iZiI6MTc4OTAyNTIyOSwiZXhwIjoxNzg5MTExNjI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVINUo2SjIxd25xendaaHcycUlUN3MiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Wuro4r2qWK0UZ1x4kALlubjSlRJLfPpc7DjcJMjDMylzmes39koTM7C1izit3EUkZnMlTav-LYRxDKGV5UxebNklMOnXHkoYSmVTKkg-wEs_1s1dnYGacfPmHYhr7tLC1QuxMobcfo_Y7ixHIY4HScYUgEU9sX6IU2yh6VGxqvG6UcYjiVBqTBNEuXTM7kKg4XRfF_1HnEUS16W_fw-zBgWEl9j4uqBvEY1VaAP6ifI-hlYN-ypGackXOs1ThZbmz-WsDkuu0JgbRXl8AmQKfd0ysnpM579JLutTyNESIL3C_BoFF87MAx7UZGQC1MGnQf9OaL7itd9kmoA2VOXg05ZgxAX1AFOalcKyE1zFLkGt8S1xTJQcoCiWtfuVUFlndUhURktIinBKuiwPE4PVFZg4VPiNFOnWCCyWAy0P6HxL84kvH-8_L_uH6JAdzon9UQylhZuOdWxUzWGZVL3JvSNxG5mf6rz1idZrRy_7VFRgjrDrjHD1tp2u6w-uuIXGtcS1Kq0Q_jc7z7b9OMCo_p1xhfRuco8632uNLfCnArBnURwZ_KwR-DbRYH6bG4NIeinNbntmpYwX_x1dF8h68WOYe6UVtE_M0qAq_z6uuy5Bgo17gQRsEzMqV5ieTptgwZ7Vy4ylfPbo7YpTLe6RvKUdx8u3lnhhoaFgWRgw6ss
Content-Length: 149
Host: localhost:8080

{
  "title" : "New Internal Category Id",
  "slug" : "internal-category",
  "options" : [ "B", "C", "D" ],
  "active" : true,
  "read_only" : false
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 236

{
  "id" : "mgl_1xKyiobB6TxIp33prPti1j",
  "type" : "global",
  "title" : "New Internal Category Id",
  "slug" : "internal-category",
  "field_type" : "select",
  "options" : [ "B", "C", "D" ],
  "active" : true,
  "read_only" : false
}

Retrieve a metadata

Retrieves the details of an existing metadata.

Authorization: Your API token must include at least one of the following scopes: metadata.read, metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}

Parameter Description

metadataId

The unique identifier of the metadata.

Request

GET /api/public/v1/metadata/mgl_30heIdJG2lAToYBGydMNBh HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjOWQxN2U5My00OTNjLTRjNTgtYjUzNi1mNGQ4NDdkYTIxMmYiLCJqdGkiOiI0YzQ1Y2E4Yy1jM2UwLTQ1ZGYtODVlNS02OWMyZTk4OTc2ZjMiLCJpYXQiOjE3ODkwMjUyMjMsIm5iZiI6MTc4OTAyNTIyMywiZXhwIjoxNzg5MTExNjIzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJ5a29EQThid2ExWTA0ZWtEMURINDMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UiEITqJ2SJmcfgQC6RvL9vRiTC_des8WcK2VjKAf18PjXLWk_SamzCLHjSiKjcOEiBjvhYT_lpSlV202l8DR0Dm4uCZV1NA4AIoqLkMe6oXkQfMCYdHI31VTCkAJ-BQjCRLL7ClpcYHBZb83kw2W35hPzYReWxWwzdoi8aBvAP9hWE9CGqpGt1jtuCBJnmzVl-wo26XsWXzHnwLkjG0G198zHTFp-A6sRUogRpNu0avCLi1vu2p05d-bwkvkDYly3b_RAnIVOPKF2-CHc9NXqEKX5CM3Hehu9UKc9XFNw9MTKENT620RAlwAVU4XJO1dvspDqMgN2kbZeMoPJUwPaICX7RRbC8b8teXscJnH6tmlWMNoEnqZL8BZMhbcYsEsyrzZCbvAUqQzyxb-SR_mHg0Z4nBhb0bBeC3f6HF5Hhg988GrzYMfHvi530ya-XaAVTr8QGug8SxEC3fdyZJqIpZvJ_ZOjPRWo0vXqC0AgVO7tKtNMKHhWas4c-K55iX3lzDK530nmOx9qGa-uaw_D8C0W5leEQjy86bFUDdetToLKaAMM7taBL3dIfcaaRgG92rkt4k1eQbovM6yykj7KZmkKyrTeIL4O8nIj4_LwHFtTEu6_J4LXLJkOtPlYqk_tIFnweU3PTZA1AqLNV2ijGsdI76mXtnIQ_7bH15rbio
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 232

{
  "id" : "mgl_30heIdJG2lAToYBGydMNBh",
  "type" : "global",
  "title" : "Internal Category Id",
  "slug" : "internal-category",
  "field_type" : "select",
  "options" : [ "A", "B", "C" ],
  "active" : true,
  "read_only" : false
}

List all metadata

Returns a list of your metadata.

Authorization: Your API token must include at least one of the following scopes: metadata.read, metadata.*, *

Query parameters

Parameter Description

perPage

The number of metadata glossaries to return per page.

page

The page of metadata glossaries to return.

title

Filter metadata glossaries by title

type

Filter metadata glossaries by type

include_inactive

Filter metadata glossaries to also return inactive

Request

GET /api/public/v1/metadata HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjODUyMTY4NC05MjRmLTQ2YzQtODQ2ZC05ZDcwZWJmMWM5YWUiLCJqdGkiOiIwY2NmNTUwYS1lMWIzLTRkMDgtYjkwNS1hNmEwMzc3OGNjY2UiLCJpYXQiOjE3ODkwMjUyMjQsIm5iZiI6MTc4OTAyNTIyNCwiZXhwIjoxNzg5MTExNjI0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF2akdDaERRTU9IWGl6b2FxNmt0THciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.jbBTgoZotwvy34CNi7IczTNAPJN82ukq1KOfCNCWWnhuQkF7q96VBLU6E_FUeLfRtsoD6x1v7BmT0LaIgemVZyCcZ5gALQ9VB2s3oy6SDaKCiVepCzNnBONGQ4JmvvMs1RxG8ocWxgxL9ok-gG0aYoRY_LinDuT_DA763deIERFbQ_hR8f_YdYZ1TV43F3ko-D1qEf-OoXDIkOu74q7nUIwQUGVuS_gDb_42xN4ufV_U_TTkr0yoM9hNtQ6CarqhH9j4-Bi8oFy6A_fV9u9XQvPs-FOIQc7gSxMuiR2k68C_3SRwacWao-Ysu6Qj8hN_StiOq32M0Quw-pX11cQ5UV3zerhsbJbbf2bmaZ9J_1J9iRM6s05u4KE90HfNm3mC4Dp4FZfmhfvudZZCSsR7QMlwOZMSl425e4L86yqQcM2B-J5d-CAtTrLtyf7VQnDzEj8IWEH-szRcYu2F5K4pKLKsSx9ZXdxLa-d0rasCsK0P_6uHtnhgqxsRt5EWLII_8tjhjhAxduRzIy99gOVEenCL4ZMN2Rk__gztRBvGGxTVW-Mmb4dimEj5MPbwR-AXbHrBtO6TCRerqzQDVBmg8BATEIxlacgmrbtPg4XQ6T49KK9Dr6MdEUIZk9lSVEIDTnNfeKgt_zGyDmqzvNrDNczKY3lN4uZ8N5FH5_jC33g
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 653

{
  "data" : [ {
    "id" : "mgl_2SVQMRpUoMuq1LEhtuCSrE",
    "type" : "global",
    "title" : "Internal Category Id",
    "slug" : "internal-category",
    "field_type" : "select",
    "options" : [ "A", "B", "C" ],
    "active" : true,
    "read_only" : false
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/metadata?page=1",
    "last" : "http://localhost:8080/api/public/v1/metadata?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/metadata",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a metadata

Delete a specific metadata

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}

Parameter Description

metadataId

The unique identifier of the metadata.

Request

DELETE /api/public/v1/metadata/mgl_62k2TciYflDREPAw6iLhpF HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MjBhNzk3Mi1kZWRiLTRkNWItODA0Ni05MTQ3MmI1MTc3MmMiLCJqdGkiOiIzNmJjMzQzMC0wYWUxLTQzZjUtOGQzMy01NDM2NWU3ZWYwZDQiLCJpYXQiOjE3ODkwMjUyMjcsIm5iZiI6MTc4OTAyNTIyNywiZXhwIjoxNzg5MTExNjI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdjZmpmUDRzNjJrMmlqVmg0cXc5UiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.ef84SnApoNwDDWvAkpLYHFQ6m_N4NbVjjJNTGkwuvXJdg-fzFv5b9Ip-7EIDTvdiIc23nB8x5H7BkQh3EMh3F5KLrAdF3ipUTsIYtrwFK7Q0isYEjN4S1_Nom_9WFJ1OyvDr7yVIliYkAnpw7JbYKtyStGxrdJ127CS_HgsFF14W12LFGFJOaGYPbbTTiBolWE3mqIJIy0MpysTZqCdGheOXE84UE_S8xGLOc0o3af_-BZohPsEj9Dkljxhm1VipLe98TF25jw6f3U6jjq3u4EpzL0p7evylkCpFg_-pcv3cBJszeRxPdtxtwvbDBI6S771GQBpA83OdlUxfPr9Ef_Rowta6NtAXqFjNG6bBje8HQxYFi1Vj4zQt2ERGEZAaPKw1vXhvEcUk8nptnLhBcfieqMDj0wk_9Jh1x-IJIEHVXr3pfrn5GKO5qLdpKpCY-DpvUleHy8xaKcYK3GBvi0z73ZDAUuiLUFBkZR745mt05owlBu3aNNuSI52Pg5GY5nPz6-OQk9yUu9awBOImoIbibBWVkI1ng0GjJdgTwz7ueoWNZeL_FwxPe1p2lUh5qWAlyFXWRqVEV6oyOhjE1zsgSlOPjsPliP3EYJX1h0DnXvg1sBDcUP-RdROCNzLfBTnflW5AJE19vWoX-u3V-XJcC2Nb-_9Awc9dRIHsNuw
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Metadata Option

For metadata glossary fields "Lookup select" and "Lookup mutli select" you can assign values that can be auto completed by users. Typically used for select option lists larger than 15 records.

Attributes

Path Type Description

value

String

The value of the metadata option

Create a metadata option

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Fields

Path Type Description

options

Array

The options for the metadata.

Request

POST /api/public/v1/metadata/mgl_1xVcFKDGgRKg7IAefpTLZP/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmOWJhNTc5MS01MjY3LTQzN2UtYjg2Mi00ZmRhZjdlNzExMjMiLCJqdGkiOiI2YWM2Y2JjMC1hNTBlLTQzNDEtOWZmYy02NTc3NzcxZjkzM2QiLCJpYXQiOjE3ODkwMjUyMzAsIm5iZiI6MTc4OTAyNTIzMCwiZXhwIjoxNzg5MTExNjMwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNmWVFMMFFVRGkyaFF6MUNSRndaUDciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.gClK3LasNWKrAEf7hStHzGZ-3s2SMdooqD6AvJ2LlXNB_5i-dCBf7TazvWnj9ci0ezBQ1WIT3yv7Fy7zPErJViiwEsC0KiF1w6m9RRkF_cXbIZhAgmIdUQoSTbyj_Lw_lF_fhTiuFF6VgTqY_mu-UFQ6yGLCnnRot9IAZLn8LouRxFGOMCxQjfb6SZMokmuXoB3s5IfLVVal4LJs2deBRtFIrgF6E6WamLM8t1-HqiCKPFhxo6cJPg-K1L7IK0jQNASqJg5JTWLAxi59rk6kWAV85IYzscbx_7uWem8gROTpAMjHO68pH00j2tKzmZekeR5vTDV8z7VkHI0ATd29hPomLpap4q-kyLPGe9_hws6T8g2Gbe-nrau_hEyIWFZmoWmBZVhSDXvG1yxN3WdAC4zLF0P8jjJhSOrEeqfKDhlaj8KcRZAdApdkrbF-GIPTdXnUeCjWnVAP4ddN7eDwXQSaAeNko8nXfvj9MHGn-OXRJBKAvys21odZz5GTsRiLTBSfSqX1i3p7piAt6Jfsr4UsL2cHYTlZG_QtruOAiSaWWOlJugCJng4y-zuZ-u33do8gM2o8kUPKgqrNaFfntWM4HwYp0RslqpYoziw1idPUqludXzYfmVKxfuz0aQ4yfiNeVzf83kdiOesq5LOKvSwV_0NyWDJUmz-ieiGF_8c
Content-Length: 59
Host: localhost:8080

{
  "options" : [ "B6129SF2/J", "B6C3F1/J", "B6CBAF1/J" ]
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "success" : true
}

Update a metadata option

Updates the specific metadata option

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}/options

Parameter Description

metadataId

The unique identifier of the metadata.

Fields

Path Type Description

old_value

String

The old value of the option.

new_value

String

The new value of the option.

Request

PATCH /api/public/v1/metadata/mgl_1BG2xOp56v040zVuSGgULX/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZDhjNzdhZC1jNTRmLTQ5NDUtYWVhZi01YTUxZmQ2YzRiNTYiLCJqdGkiOiIzZTdjMTcwMy0yNDdiLTRhMWItYTkxZS0wMDdlNTVhMGIzMTYiLCJpYXQiOjE3ODkwMjUyMzIsIm5iZiI6MTc4OTAyNTIzMiwiZXhwIjoxNzg5MTExNjMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVmaHc4THF6aDhUejhSVGowZlkyQ1AiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Hk3o92Vv_9pGOB1sbIBHefQdCvcc16u60tVlJwtXIjf4qe57mBQYK-NlOWDGpZWTa-EnF9n26KT4AKGY4lPFEpMrQztxG_0k49F_6UTtS-aCWd3pSHK4iYRqkKw87_1tGiTTy_Cs-Z2lt2iXc9c1WSecDIBZ4JF4HeRiOQ-ANLSytPYZZSZEA2pVna0qgervO5r41-LnKdYQ_VOW-pEG9OMa8Ip0aJwW8ZOY8WYctIZhcEUYFQXJO8PZYsiS1pa5JhTuAgQUvJlgn7wO_YFghdflSLdw2wQnqOvvUR8hSbH3ewXS3SdVE5LRXMVlUDkylYnG1Xm1_nqob3iCGF4HA-yaLMcx1MM8z4Ckq8Tg-U1HwjHRUfkbgCHGj3YcYf8uGTkUviElMToUlriFNd969E0q0u8GllfQVshTIk-xzJiDDl_HWgNaEB07uXymCWLrX4WSP2QQypSzaG9HNNbqX3RDyiZjutPSlmQZo-lvPqMhHYOOHGKE8cXlY2lOSnoPrCK9ViSce24FLlpKJOikk0Gfs3UfA7OZLAZXjQzYaznzVx0bS0tr6fvyW_NYcmAepsVJ56p4uhC7z9r4JbL-ld8lURG0piW74F10e5SsWoq-RpC7aAe9cxCOkk9_27v9akDlWxcYsbwmJjeU0SLiFFINfR0sZjnyGbBH1BlgfVM
Content-Length: 61
Host: localhost:8080

{
  "old_value" : "B6129SF2/J",
  "new_value" : "B999SF2/J"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "success" : true
}

List all metadata options

Returns a list of your metadata options.

Authorization: Your API token must include at least one of the following scopes: metadata.read, metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}/options

Parameter Description

metadataId

The unique identifier of the metadata.

Query parameters

Parameter Description

perPage

The number of metadata options to return per page.

page

The page of metadata options to return.

query

Filter metadata option by value

Request

GET /api/public/v1/metadata/mgl_6jps1akNjfQ4VSZoxF9vRm/options HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMDg5NzhjOS0wYzU0LTRiNmUtYTU2Ni0yYTllNjJhODk1MzMiLCJqdGkiOiJkOGIxNjQ5YS1mYTA1LTRmZDAtYWYzYy03NzcwZDFjYTVhNzkiLCJpYXQiOjE3ODkwMjUyMzYsIm5iZiI6MTc4OTAyNTIzNiwiZXhwIjoxNzg5MTExNjM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdoYnU0cnJvQlZndWlRTG4wS1pzOTAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.aeuseJ0BsDv_I7WWyn-w0QAscCzq3LlDCi9h587cY9rSLfvluwl1A9PTDtSjFyChuIMiZmmQ74tldJjJ2qUOio_u2maXovBg2oU5VYxos1BAzFJ_gkr2UCdtm_JwXFBzdUESBN9cZQfmF17ep29-QQ5DnI_PqzrD87pmkDoMpCFaRHwUPG28rSV1Zh-VhlWwVYgjxoNbhErKGkkkN_3Cl_sKQtZLfqjW-trjlsscJ96efluwx8lIxVzQjz7nT2Ce4lnRQVXnmrIfGu9Yw-vXdIsMicqvMSRAN6vKs9ATBQX7kcX7rIn_0c9CPXm_ZI0F1yKa58U6KDxC2Kyuzf_7zOpx3BGrSvqS21YPBKJob7xPzXCzBs1afMuQjp7nebo65IFAQC1zXO6lZs1Nr4eRdT8MZLVPVug3EQVO0fyhY_EYTfOzRatZNwjkYmiVsWjuF3CPumR54IMyyAFd1derxDDELmC3P5j-afzkODIpRS8582xKy1FhqIYaaxhbbiw4wwEpyI9V2D4TsOBv9B5gIRt5nyhVBg6ZYqrOHvITjRzOS4VUSxMDFnXwljfjD8w9BGKxCHNMhRTF53opUZrMh-QcSi3YxMus1Y6z_X8f1cCh8VJi2_SY9WvYJqHnys1_0aqgVqc0mXJ65GsJEyBuizGDO5ELYfQ_1x1QmK79tqo
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 605

{
  "data" : [ {
    "value" : "B6129SF2/J"
  }, {
    "value" : "B6C3F1/J"
  }, {
    "value" : "B6CBAF1/J"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/metadata/mgl_6jps1akNjfQ4VSZoxF9vRm/options?page=1",
    "last" : "http://localhost:8080/api/public/v1/metadata/mgl_6jps1akNjfQ4VSZoxF9vRm/options?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/metadata/mgl_6jps1akNjfQ4VSZoxF9vRm/options",
    "per_page" : 10,
    "to" : 3,
    "total" : 3
  }
}

Delete a metadata option

Delete a specific metadata option

Authorization: Your API token must include at least one of the following scopes: metadata.*, *

Path parameters ./api/public/v1/metadata/{metadataId}/options

Parameter Description

metadataId

The unique identifier of the metadata.

Fields

Path Type Description

value

String

The value of the option to delete.

Request

DELETE /api/public/v1/metadata/mgl_7AvS0WgnThKtlasacxVeUy/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0N2YwZjkyZS01NzFiLTQ0NWUtYmExMy01MTkxMzMyNGQ4ODEiLCJqdGkiOiJmMjA5ZmQzNC00OWVlLTRjZmEtYWFlMS1mMDQwNTRlNzc0M2QiLCJpYXQiOjE3ODkwMjUyMzAsIm5iZiI6MTc4OTAyNTIzMCwiZXhwIjoxNzg5MTExNjMwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI5Y2p1YzhzWEJRcnlCT1ViTXZqaUgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.EbprAj9jr-1H2yYVSIkBsv7-HrX9zjLWXbTUL9vhF0X4SGuVQb_d6EUfGCaLVBuU-e7NJ11eEeStsZeM93qGzZbkItiBDg9JveknoQ_aQwcu_G-zLLBiPV9HzznJekRW2l3Daxek2Yj_cg_DjxswzK-tAD5bXKuVT5qPaOR-vsyRmVVYH10Hd_eAnTpK5RzCSQXF5Pz4pAXF3P99l_j5OmiQLMCsdNigVuGZ9oMeNzBE1wWxecegwYQ22eRFehU-mzu0xZlzmM_v00ngzePOgNpfoOd5X8CjdQ7ydnzvvw89jWgTKIwXHMvZ4STTqU02Moe_FjptKuG-j2v5LfeudPu3pb7zBKlFjqTxGam-wSVhqj0blAwNdVrjSARu_ApKqk90AdBbUcZDP3zRatQrtMoLGx7Nf1of-jFZ9HagJXaGt-U4DxNOwM6H5g_UrWb00OUpru4s3KjuxQ6RZUSbRe21e_9HcKsxHeAgiccYB1Bpz7DhCVLUubVadYk16tN12pNmsGIwyXxB_uQMCMvY2Gsmuwzf6hDn22m3_GaQ03mwG7yI9eOejS_kOveMCaqkYMQK9QTpClX_nnfE4HWycGmW9pjrSufq8-zwIpcZPBVI4BApc8k2JGN8U03lQdWIaT1bx-NTDpSsd0H8RPeH6gVvBSU7RuOv2SQSJzuQ3Jk
Content-Length: 28
Host: localhost:8080

{
  "value" : "B6129SF2/J"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Observation Glossary Resources [BETA]

Observation Glossary

An observation glossary item defines a type of observation that can be recorded in your studies.

Attributes

Path Type Description

id

String

The unique identifier of the observation glossary.

title

String

The title of the observation glossary.

label

String

The label of the observation glossary.

description

String

The description of the observation glossary.

type

String

The type of the observation glossary.

status

String

The status of the observation glossary. Possible values: active, archived.

numeric

Object

The scoring options for numeric type observation glossaries. Contains min and max. Only allowed when type is numeric.

Create observation glossary items

Creates one or more team observation glossary items.

Authorization: Your API token must include at least one of the following scopes: team_glossary.create, team_glossary.*, *

Request

POST /api/public/v1-beta/team-glossary/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4Yjc3MmU0ZC1lYzJkLTQ2NDktOWEwZi0zNmIxNzdjZWM5NzUiLCJqdGkiOiI1MjM2NzUxNy1hYTI1LTQ4NDUtODUyNC0yMTQ3MmU2NzU0YTUiLCJpYXQiOjE3ODkwMjUyOTcsIm5iZiI6MTc4OTAyNTI5NywiZXhwIjoxNzg5MTExNjk3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNhdGhDUFdEcnJoRWFseU1ndEM1dUUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PvvLEPjL174CwzQij0Ys93-f5LkL2PZIVq8ZxKNnSLhr-O1mii135sI5fFBUQNmg0l9X4IDy0NdkBDevx8_KQUEK89u2DlH-y6adNqj6j03Dj1NkhDEVFi-jtvPL6_Y7RXHbNZZdF8OhgRSgjwMBt_KYMV9oN3RebLzvTlI4vdu-Q8tCOoYAe6MS1A94GyQov2Y_gnx_gN4y8Qz65cvOBI-ln0tKh__WOrBw1PUuQYX-A2JBbt6OyabIZrcXP9GvQFJhl1V_LaQZEHPoWMJYvTfdbK1cbbktD8Hum3oldDOTj3ZojSkhSU42nGComjYIY0vn1Sgob64dnu3nflkqPQsphCjFdKrHLkj7XVwAYzHJvjmvaUereOyNMroeBMoVaz3YsSvBKhkiLeu5GZNkqAgU9WrAdRR7gT9m04jD_Hq_iPmRIfl0rg7TOW4oVn_3jb6uVzK34nQQ_CKp4upzn_RkUEfTtA8o1EqJfwnhRok_fpc2AGv-P-6qLxmjCOIKYEVje0NTaj3rTmHVXhOK1AEwyOWLoNytdtG9A6IyI7B_7cRPqsKQ9LjyfVp4EhVPUqndeUpkotwpepDLRR9HCQr1MsD-Hc0K8xZnbkZ64l0W5NaJJoVEdY2Wsc_o3WFgnpTJUtY1f2apCbFn0Ih-nMIzQyptjf5g7BLCACn3CSg
Content-Length: 445
Host: localhost:8080

[ {
  "title" : "Body Weight Change",
  "label" : "BWC",
  "description" : "Percentage body weight change from baseline",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "100"
  }
}, {
  "title" : "Coat Condition",
  "label" : "COAT",
  "description" : "Fur quality assessment",
  "type" : "severity"
}, {
  "title" : "General Appearance",
  "label" : "GA",
  "description" : "Overall visual assessment",
  "type" : "none"
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 696

{
  "data" : [ {
    "id" : "tgy_4Fly5Thw4xoQn3yW2vd3SY",
    "title" : "Body Weight Change",
    "label" : "BWC",
    "description" : "Percentage body weight change from baseline",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "100"
    }
  }, {
    "id" : "tgy_6yGumYG7QpB9ZyLTauDZ9p",
    "title" : "Coat Condition",
    "label" : "COAT",
    "description" : "Fur quality assessment",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_51bLPSqNFnqHqmpzFsf25O",
    "title" : "General Appearance",
    "label" : "GA",
    "description" : "Overall visual assessment",
    "status" : "active",
    "type" : "none"
  } ]
}

Update observation glossary items

Updates one or more existing team observation glossary items. Each entry in the request must reference an existing glossary by id. Only the fields supplied in the request body are modified — any field that is omitted will retain its current value.

Authorization: Your API token must include at least one of the following scopes: team_glossary.update, team_glossary.*, *

Request

PATCH /api/public/v1-beta/team-glossary/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmNzE1OTY2ZC1hYjY1LTQ5YjAtOTYzOC0xODFiMjFhNjgwMWEiLCJqdGkiOiJjNjUyOGE5YS1mZmY2LTQxODItYWE2Ny1hZGJlN2I1NmU5ZTIiLCJpYXQiOjE3ODkwMjUyOTgsIm5iZiI6MTc4OTAyNTI5OCwiZXhwIjoxNzg5MTExNjk4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRuTkVDRTZSbnJoU1BEM0hUaERoUHciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mqaAODs23IC7mXl7nPGpS_lXk27LDwlC-BhwuD95oHdRK7qM3IsitcSUr1bb9nciA5jSgFsk-Sl0F6SDvFbOUWgl_Bl2SCZprNXEnxIFRFEeU1V5T_myL3vNF1LLcdp-eol7U8d7UU-rfBxPeJnjX3Y6bONoVlN6cvKLGy5m_5CCBMTPODNF48stiGjeYqBy2NVqYaElVu73KO1hVRIwbzKrJEIv1PFoXfpKosWfUjsz98iK-GJa4b41qduBKsQsdbD9Kl5JH7mt_EZRvox1uMarriIKmrK9kaTD6Wix0AFklU7ARZzdvVh9bOsmmQU7BV9Bufd1k2xK1J8QE5ZNZe-wZvtPXKn4SujvS9oCr8YeBTg4JuIxchjYhy9PqgRA978jIqcY4p4Ni-yPz0Q7jzYgiVTDJKAL2C5o8eLbf7Iq8JK_Evmv2x-HbHn3h6X4irUvmgwbsRulmlLmYu2e2g7VteNayOxhKR7b3NQ43HHllwse7ZVCaL-eOftISFIrJdyfcmyYQ-dT7UhD9I9x_v9OUQ5_Rx32-8nHVTG4WZQy2NNlZg058U0caBsR_tipx8HpKj-3Vt8SNnKuZxr-ICm4eoU-iwpIaUanR-8MXh3y44VVLkZpjTmDXH2hXBQyiDIBvUJLzqt59NpncGx1KbawLmDktW1EKciu89753wA
Content-Length: 547
Host: localhost:8080

[ {
  "id" : "tgy_23xTVhgccmG0xoLXg7HCL4",
  "title" : "Alertness Score",
  "label" : "ALRT",
  "description" : "Archived alertness assessment",
  "status" : "archived",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "10"
  }
}, {
  "id" : "tgy_4w41qzEycoI100mpAVKxyI",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "5"
  }
}, {
  "id" : "tgy_5YdeKSRYp1Apf2RWDdlIdW",
  "status" : "archived"
}, {
  "id" : "tgy_7Czl4x3Cbt9CBALeWlpTgE",
  "description" : "Body posture assessment",
  "status" : "active"
} ]

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 12
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 891

{
  "data" : [ {
    "id" : "tgy_4w41qzEycoI100mpAVKxyI",
    "title" : "Coat",
    "label" : "COAT",
    "description" : "Coat glossary",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "5"
    }
  }, {
    "id" : "tgy_5YdeKSRYp1Apf2RWDdlIdW",
    "title" : "Gait",
    "label" : "GAIT",
    "description" : "Gait glossary",
    "status" : "archived",
    "type" : "none"
  }, {
    "id" : "tgy_23xTVhgccmG0xoLXg7HCL4",
    "title" : "Alertness Score",
    "label" : "ALRT",
    "description" : "Archived alertness assessment",
    "status" : "archived",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "10"
    }
  }, {
    "id" : "tgy_7Czl4x3Cbt9CBALeWlpTgE",
    "title" : "Posture",
    "label" : "POSTURE",
    "description" : "Body posture assessment",
    "status" : "active",
    "type" : "none"
  } ]
}

Retrieve an observation glossary item

Retrieves the details of an existing team observation glossary item.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Path parameters ./api/public/v1-beta/team-glossary/observations/{teamGlossaryId}

Parameter Description

teamGlossaryId

The unique identifier of the team observation glossary.

Request

GET /api/public/v1-beta/team-glossary/observations/tgy_6mIkQ9sdbEOVCGZTn9JRtm HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MjI0YjQwMi1kMjdlLTRkYmMtYmNjZC1jNmNmZDZlZjRiNTkiLCJqdGkiOiI3ZWZlNTY1Mi04NDU3LTRmOWUtYjU3NS0xMjA1ZGZjN2ZmZjEiLCJpYXQiOjE3ODkwMjUyOTAsIm5iZiI6MTc4OTAyNTI5MCwiZXhwIjoxNzg5MTExNjkwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRDQUZObDA4WGlBNXlRNXRYQURkUm8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.CVX5NaFSVgXiG_xNUFpMA9Ex0otTbAvAVJPmwx4-aDH1KEVDFFeai2As6ZcWxf6nye9_FzZtEIYgTyyHM42DM1d96M9IHEfe47uBXIBAaaLBG57ShrL24MB4JXEY7LODwH95YMuy_ugHPKj9xE-jA2CzRcFPDmqVXroTFG4BBDm6B2ILBwTDitHXv1HBTggqP4C3WH7DP-UVLfXqVC77dE7BdDa81ce9N9wKBjC4zIPPxBvzn-cZ4zdkokUivZId7g20gLGqXxAR5w1Gv1ZOixENbi49d1OfwhduBj5RCzlBpSvd6AUjgtApZ15gcg1ibgpAGVcheJ4vlyt7L9PwViUFd6iRz4rgZvwLKpDRX618OfJHYlI9tGj6Jo8NU8N7zstNhOVf2wO56IctNclN1Mit5Fm9vOiRi_CyETcek-UvzjGu3Xs0itiALH97pJDEPxfbh3WXkeerM7EliJvkSl2KkkRqkbp0HgBqXHkyk-3BeLVoA33CBveM4z6hQ-SMpLtxsZEjoLW3FNuR8Q_yVdaNmHCr7Bo3kMykUjVq952GDoGtpmqswk6YmySvMlm4tRw2J3Ys6VVqAWw7aWplZcAMgrhEntifV5x-hArIy-vQHjcgMiuPQOcYAFHREIvSu_l1aiDIqdw-7-WTH9dB1A82RasVbH0uiBVaRkFaU3I
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 225

{
  "id" : "tgy_6mIkQ9sdbEOVCGZTn9JRtm",
  "title" : "Numeric Glossary",
  "label" : "NUM",
  "description" : "0 = it is ok",
  "status" : "active",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "6"
  }
}

List all observation glossary items

Returns a list of your team observation glossary items.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Query parameters

Parameter Description

perPage

The number of observation glossaries to return per page.

page

The page of observation glossaries to return.

status

Filter observation glossaries by status. Allowed values: active, archived.

Request

GET /api/public/v1-beta/team-glossary/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ODcyMTExOC05MWZlLTQ1NmUtODU3Ni1kNDZlYWMyOTBlNmEiLCJqdGkiOiJhZmZmY2MwNC1lZjMwLTQ2YzEtYjgyMS03M2U1ODk1ODU4NGUiLCJpYXQiOjE3ODkwMjUyOTYsIm5iZiI6MTc4OTAyNTI5NiwiZXhwIjoxNzg5MTExNjk2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2VaNVpVZEozeXFPOXp4RTJjRXBDQSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.HC42exmBP_qFUMYBcPOiyIezjS1H0R2vKk9v8JWJbn7tZ4ckewVO2m3dhfrDzFxu3b-GmMGLW0bM_Tb-nH_9bVMPeShXXz4bJ_ZE1k4ZGK-NVA78imPYK29mztjTeOvrFurHfB-EBW8sJWUz5hIZ0Uair7qCcL--eiYju96pOAoXYxFzNGB8vzGmwzUvYDd5cQA8wD1Q0hwJWZI1xPkDsCJ5idHTvOMtALEY9Oyawg2hNn4DgqNnSR1f_uMeYJ5CYUNALZ3gVow7ijQHs2soGni1FwSf5cB6p0G9cmofeVLeXbT4N8fHQQ3q_NCMmnV7W-aMId4dRpxIctbIsxnBFiCKZLX0O7Gi9X0L-qfjURvvo3wH3MthSynumIZUft7x_hclsYDpSsG5WYVQ_lo5kBMu_JUS4gxxStQTRqFnQcqrtlKOFpl8MYiktkWqGFXL9zQTV4ITAoJUzNMa8d-HMK1Lj3aeMy6Id8rV2CVhN4T0kD-FTYzNMvme5aZgpW5pfJAz6raE6CrPf1ZRXS_SQKBIMspFGENKFdUSLQ-D63t6jTWXrbgVObC1PKpWqcjZ3NRPTPCGB-LpsE8t_8zpsKkSyJXPGLOEGN1htl7h4DaFNGIHjniFhyIh2CXReThVECy6aUrGnwZRqhYod90zkdCCvIwB24CHhZ72jb0ZfXg
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 966

{
  "data" : [ {
    "id" : "tgy_7PM4q8WlnAD0JoKXDCpN0t",
    "title" : "Coat condition",
    "label" : "COAT",
    "description" : "Assessment of fur quality and grooming",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_7MDqHcPnQoLBabRsR3HBFc",
    "title" : "Body weight change",
    "label" : null,
    "description" : "Percentage body weight change from baseline",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "100"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/team-glossary/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/team-glossary/observations?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1-beta/team-glossary/observations",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Project Resources

Project

This is an object representing a project for your team. Projects are collections of studies that users are assigned roles to. You can retrieve a project to see it’s name and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the project.

name

String

The name of the project.

metadata

Object

The metadata associated to the project.

created_at

String

The created timestamp of the project.

updated_at

String

The last updated timestamp of the project.

Create a project

Authorization: Your API token must include at least one of the following scopes: project.create, project.*, *

Fields

Path Type Description

name

String

The name of the project.

metadata

Object

The metadata to be associated the project.

Request

POST /api/public/v1/projects HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZjc5MDY4NC1kODFhLTQ4NDktYjNiZS1mN2FkN2VhOTFhNmYiLCJqdGkiOiI2MzgwYjMwZi02MDY0LTQ5MTYtYTFmNi1lNTFmZTdiODI1MmIiLCJpYXQiOjE3ODkwMjUyMjIsIm5iZiI6MTc4OTAyNTIyMiwiZXhwIjoxNzg5MTExNjIyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNITm8zMU9xWnBicXlSRmdKM1dnNnciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.VBj8zngLpwfS32rJvEgnc_3EyOthC8fcqvtsl2uYZQHneHegORMLx8JVkAKKtszpen_AQeP5xDyIxntB2wcv1sBzZM_rfdZ7AZ5sBakH3qb6HTpqtnxjbBAT8tnEmb9CIjky7ifUL15bLwoKp0-GMCVnnv20-Dy_74tNRKsNarGLkeSFQ7H1AjWIBEsgr8Xc9B-yDUgfRVWGrwz4dCRc_1txu6F5CTOGV-U5_pQIGMMxdrfasW70ofC-dTyfj5Klqst1L-aD5BYgRuxHCI8cqnMaEOwmkX4GDCqtx53tSKQjOmvZtVpDH_zz33TQj2jArQPTTkYsf8QDCM6YVZbJNLozBwxmWLrWgQw6G6Yz1niuR_iEOrFhkLSBjk2nYGA8ZH2RlrftgRsG8CLsHqLNB9i4XEqL-C835ZlIfDzneuDGiyDLS_3WeC9jVMZaCCpDhOAp67kBRRi6CW95yrux5OcjkHXGRfJI54lVjQF6NH7j2CjO5n0lK8EjZ_AgNBype_QwuPWTWfYWPLpTbkSDO4Z6ICbczY5pLnkzUl4uSKs5vEYvM4YwlRBGFrhjZ5gJS0DlRtBzTfoONuzEW4bZle8IihGJesH84rl1Oy_38wnpgaWDHxUa8M7BmVNqVY2w5oNZCoSsVT9UZdgc2PlliCN56DNKbUjM0VEmqHvmtqI
Content-Length: 89
Host: localhost:8080

{
  "name" : "Lyb8TfPhIj",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 28
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 224

{
  "id" : "pjt_4O0H8lzCJVnO1uDkk4R3GU",
  "name" : "Lyb8TfPhIj",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-09-10T07:27:02.737686Z",
  "updated_at" : "2026-09-10T07:27:02.737686Z"
}

Retrieve a project

Retrieves the details of an existing project.

Authorization: Your API token must include at least one of the following scopes: project.read, project.*, *

Path parameters ./api/public/v1/projects/{projectId}

Parameter Description

projectId

The unique identifier of the project.

Request

GET /api/public/v1/projects/pjt_48Yk6ulcJh7i1IPffmHJyi HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwM2ZiNTE3Yi04ZTA5LTQ0MjItOWM5My0zYTlhMzQ1YTZiYmIiLCJqdGkiOiJlZGU3OTA0OC1mNzczLTQ0YmEtODNkYy01ODk2ZTQzNjViOGIiLCJpYXQiOjE3ODkwMjUyMjIsIm5iZiI6MTc4OTAyNTIyMiwiZXhwIjoxNzg5MTExNjIyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRodG9ZWXdCem5kTFVkS094eG82QVoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lZUWuM2HF7hmDMv0X_yV183HfSGDfNZ5BkXf1l7q8nUONC3i_C1Q3jjxVz01e0QaMj8A0t5JhtzPnw2hlNUDjth39rvQijqXlacMKqse74VVuv_yWVq9MaHcJpJjR9xKeymHehi3gGq1a4yv5xmVaBxN10UjpSbOFo8FEAEoNKmVQp3EWYZnvEnEZMGQilqT9krGh3iNMYudCM7i4HWl_KsyMM6EXcb-i-1AV4kGn9jLTo8RUl-MEJUYRyezwHl4q2-OTeb61XJqV8HBL4ZEoj9RF2wlI5XR_BAsQ-1v4WUkPj0D9S_M3AxIzHxt_rYpF1cXaDCITyxlaHM_5wg4-TnNoJhjfJ98M183fh-W9dgd5j-qjeDbNMhkRer5H93lEQ9ZZOvTJ1j1QO3_Y9G8Qk70WxXyn1gijLzE6xgKH3Qxlvd8zhdfFXRak8qTTQ2wQZYdFjMNnE0-cqkikj2hb4PIaFNCmtP4MRc7l3fj2Co4y_cSH610rwDghKgV0BAoF9I4CXzZTlsofpsfYvAbTC6sTxYYTarfrVj1EmmXexIms_3sKQs9ETbcnUHiZblmssxtsWX_VUvfb1r7eYCJTtsbKzcH4Escm1aufJwLEH63981FCL_bgJbAtwlKcZeQUBYllsxiQfa7xgezIRDjTaLpTHATSJShJz7KsRt_xPI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 28
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 224

{
  "id" : "pjt_48Yk6ulcJh7i1IPffmHJyi",
  "name" : "XJa6uGqXPy",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-09-10T07:27:02.572928Z",
  "updated_at" : "2026-09-10T07:27:02.572928Z"
}

Update a project

Updates the specified project by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: project.update, project.*, *

Path parameters ./api/public/v1/projects/{projectId}

Parameter Description

projectId

The unique identifier of the project.

Fields

Path Type Description

name

String

The name of the project.

metadata

Object

The metadata to be associated the project.

Request

PATCH /api/public/v1/projects/pjt_5KV31ASaa0DSSdP3Tdj1FK HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYTgwNTM4Yy1lYWY5LTRjZDYtYmJmMy02MTgyY2RmYmVhNTgiLCJqdGkiOiI4ZDU4NWZmMy01NTNiLTRiMDQtOTk0YS0zYWJkZjdjMjMyMDkiLCJpYXQiOjE3ODkwMjUyMjIsIm5iZiI6MTc4OTAyNTIyMiwiZXhwIjoxNzg5MTExNjIyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFjUDBLb1F5WlMwN0JFYmRPd2tjV3QiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.RQt36OJ0r0e7WTY9xHs2XHt1VBrY3XlLyLUn6DFN0ABSS8V14HrVINXBIDqOdiUL9cg3sWr098XtqJ4PRkyhXL49B0Pw4-Byh5-EZaeqWAT9u3pkYF85JQy4Db0FHcECY8eYzOVfvdd7kTck9n8WBimlexId50tGE1-PakrgAF646BCXohjioob2NZRArrBANfStBzS2YeuaNY9wTCHyP0uQp0frBjMPUFQn2TK_Bn5YE39UDrqtM_o9o6gRNg4wO3_JxKtASStdSbWTDYiX91lq2zUjtjdNzajR3GMJOigUZrc60Lo1SzYwJQbhtoRn8FwH0q7BYDdloTwAIkRO-ROFJlbqF03S7d0ULuUXNOd2THZv16WdImBSzEQW02rz6gQ1wadyw2Op_zojf_DEsjicCC4Zxj7h42Kg3BrozvPLYpouXVfKggp4NYRpNL1cjmS8Np4mG38OaAc1wUdKVOnwi6kPmI9a0ANC0Zn-vLVWO5PeVEY6uZVpfr-Da2tTwqQqdEKwzxzyKdSf2lu79S7oxR5WvWZvqKgIIJVHLbgls5n99pMaGFT81XG-MjntygzDAXpbH6e0PcgRPuxhjt5jxf5vGCMiFX-jE5AiHlVSMYpzC4MkiLNOy70ieo-KgqeuXn6JyLMHbxGJqeciTGVgdnBjwI9L_vDegsUbp7Q
Content-Length: 104
Host: localhost:8080

{
  "name" : "Benchling In Vivo Project",
  "metadata" : {
    "project-internal-id" : "PROJ-4321"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 27
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 239

{
  "id" : "pjt_5KV31ASaa0DSSdP3Tdj1FK",
  "name" : "Benchling In Vivo Project",
  "metadata" : {
    "project-internal-id" : "PROJ-4321"
  },
  "created_at" : "2026-09-10T07:26:59.950067Z",
  "updated_at" : "2026-09-10T07:27:03.040635Z"
}

List all projects

Returns a list of your projects.

Authorization: Your API token must include at least one of the following scopes: project.read, project.*, *

Query parameters

Parameter Description

perPage

The number of projects to return per page.

page

The page of projects to return.

name

Filter projects to return by name.

metadata

Filter projects to return by metadata value

Request

GET /api/public/v1/projects HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0YTkzZWE4NC0wY2FhLTRiMjItODFjNi0xNDZhZWM2M2QzN2UiLCJqdGkiOiJmZDQ3ZTJhMy0yOWMzLTQ4MTAtOTMyYi1hNjcwOTgyNjA4MzEiLCJpYXQiOjE3ODkwMjUyMjAsIm5iZiI6MTc4OTAyNTIyMCwiZXhwIjoxNzg5MTExNjIwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY5Z3ZYQklIYmhxYXVvaUxyNzMxZW4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WTaFKxNmWBt_wUh2jrK7qhnza5Jdjo9-F4r6sINBz9TOzYwFSLMYp3PC6Ti9Z8VsJXWsGIC6S-orB8V9oNc1H5IkxyxuDcqiD-0Fz3WDcs1ES9nMvK_ZW7p3arbkXoD9ouwKixOfj5Qig_tiIxO5KVZUQ687mg77e5zDLqy16n13WfdtiTach3zEzcezDox3mJzNAVxvculSG98Rlvj3aGGfOR3ccrfsOE8pWd6qbCt03LfcPMvmEI0bxNsvgLOBjcRqvD_NQi0s8-mIz_1IzsMWiqwABjTqYh4ccfiUHujv6oj0B8Nxb4L8E2m1Pji4amvdXxZfgTqu0d51WP7PBBE6CD78JTfLv1cRbT5IDxqgAyzvkzSZrI5ZjUZaXNFIDt0-_ooyoYhzMnqilHEutCoasnpJoglFlgFVWADExwZ4LGL3IVSxBjUQFGjML3s4AwPun6YcgpHtMe5cNIKgHj1ruk23icqu-sM1gTJDmbuIjvlfEm67JNyjyiSX5YAlkEV3VeHIPV0enmKjCzt5GTR0gGwkfStPkEjXoa3jTMhZhV6C-KIevH1WAW3f70LQrEUqInzfgWtHkwddkC6tf-0Vg3ojxL6VW-IiXD991wUbJ9vhGQ-MZZNVyMaIbuw7z-rwPB-9vyv-2XGsTsbUPUlmixsYqEdJf-1SIbUlfUo
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 30
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 643

{
  "data" : [ {
    "id" : "pjt_1VPNNPrr6Dk5aiUPK0E5Yp",
    "name" : "ujCtHEgr6D",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:00.373125Z",
    "updated_at" : "2026-09-10T07:27:00.373125Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/projects?page=1",
    "last" : "http://localhost:8080/api/public/v1/projects?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/projects",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a project

Removes a project.

Authorization: Your API token must include at least one of the following scopes: project.delete, project.*, *

Path parameters ./api/public/v1/projects/{projectId}

Parameter Description

projectId

The unique identifier of the project.

Request

DELETE /api/public/v1/projects/pjt_7ZqfTP5mDNRF5OvSwjUDeS HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5NzRmM2QyOC1jMzI4LTRjMDMtOWE5MS0zZTlkNzJjMGVhNTciLCJqdGkiOiJlN2FlMThlZC0zN2Q4LTQ4MTEtODUwNy0yNDUxNmY5ZjM3NWYiLCJpYXQiOjE3ODkwMjUyMjIsIm5iZiI6MTc4OTAyNTIyMiwiZXhwIjoxNzg5MTExNjIyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQ3RG03aWhDMEg5Nmcxb0ZWUUxhS2ciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.OetxbNbAXJHSfcAfdcFQhHEEZf_EZZq4lwu6sdexZyzCNiMpXtQyb46Hq-GUnfLyOUdjrNqZBGftfutOtkmxtvIp1_1NI2_ZBxa1HwZGgARyk7m-uL0k9zD_FL3thRfmwRUFY8HBb7bEKUiNUfC03QQui4nUPb60YjX1O0ljJZwHXU9N-YkmkW89fv-RUtmzrZ__BhcFyzWWeRp6drLIdxTsTRsEv-h9n1xB3AWY4EwzpnPraHE61tYgXvjtjuq1LHpXFsfcR9IpsLK8tdHuADoeN4lNnw2hkVFIIy0mIn5tYCLAsEE_Em6mj6wat9hb7_ibZunsMPsu6B6mmNkpxrCwEvWr2PocaojMDNsYW3oZqjGzhWTFrrN-5VTSl1V5eJQ_Uwc3bT5A4EL-h-sgJ0KjoE2tueLnlsFTrj9DAGMnVjLsFpLeibELBgcQJjdmR47xCQwBYOM5-FinNx_L4feX5KrA5efr4OBNWVrrnWZiSKHfVQaD0l-Jbrz2arEPIDe321N38fSaTVcdiwW81Py2mFFPo1XV9KrD02VMsIxzaZQ--TMHvSFyolcZfCMwYhHi8bctfk7-Rbqi8H7ZCgM6sL61rEw8TON1-NHgmmwRnucJyNzj2xZJb5lQxGSwWGlHzCPhGWbeMC1jP_JAxRMBAuoKapOg76idtsYZm10
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 28
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Project Role

This is an object representing a role in a project. You can retrieve it to see the name of the project role.

Attributes

Path Type Description

id

String

The unique identifier of the project role.

name

String

The name of the project role.

metadata

Object

The metadata associated to the project role.

created_at

String

The created timestamp of the project role.

updated_at

String

The last updated timestamp of the project role.

Create a project role

Authorization: Your API token must include at least one of the following scopes: project_role.create, project_role.*, *

Fields

Path Type Description

name

String

The name of the project role.

metadata

Object

The metadata to be associated the project role.

Request

POST /api/public/v1/project-roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkNzNjMzM4NC1hYmZkLTRjNjUtYjkzNi0xMTMyMjRkODQxOGUiLCJqdGkiOiJmYmVlYzkyYy1iMTBjLTQ1YjMtOWY0OS0zNGQ2YTE5ZWViZDQiLCJpYXQiOjE3ODkwMjUyMjcsIm5iZiI6MTc4OTAyNTIyNywiZXhwIjoxNzg5MTExNjI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJUelQ3dXFTRWlYNlkza3k0TXJXdU8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PYj0H73-sI_dP79rNPZ5Jp6TL3sjKiMEYD5jzswQksDH-edCkeycqd8mZNPUenDgWy-7Fq-1SVFvVuanGC189T61msiu_kjFx75GRjpFBMpz4PjAoCXe3zNXBGih5_qHE3JU1jjDIpLutFvHIWukF3G3L7ei-dMOgGgxEzzV-fo0Ui6DolMm0KUd0UcHGdERoBqZwMm_DPNZalNuxKQso5tngbMf9F51P1Wbh2dQUspAtXr3XVRnx3WsNKGayQzgqATBO-VqJ9QvIP-xsV47pRbJ3inx0EYjBwM4myJh0-BK1ocGqnzybUB12Gu7WVSbT0SHokO87iUtZpbQsL1RZYWSOBSjI4sTL-fuuOfNgxnPjftywcWvCAcHNhr8fH0XXaHso2xYHj0rOJT4DxAaomCuOxhIXMQ3DFwITV5NpUcKLMzBs4RXptTkAIzqNtXQ6yWUlofVoAYd1dGkt3Plyh6PwpT_0yiqHk0OdzBcoaMLdwhNP0HM-NhWQptBFl1xoFO5DirkECtHhnBC4tdO3lsT7-R7lgCdXx8c7DwhDjnOlUQcVsF2JmdDxakZC9AnDKjqYvwgvYbQQYQp-UH1KpPKNy4Vccz_2pidCUMaMqBnqZcILn84P3ZtgXlH4rHSX5fxGps_4sOHD-_WSJKHHZIM9j7l6ZVTMx7qDhpqbLc
Content-Length: 99
Host: localhost:8080

{
  "name" : "JV1pkUXfPW",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 234

{
  "id" : "prl_6zHDLuRd64gD9v7hSqfpKo",
  "name" : "JV1pkUXfPW",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-09-10T07:27:07.648629Z",
  "updated_at" : "2026-09-10T07:27:07.648629Z"
}

Retrieve a project role

Retrieves the details of an existing project role.

Authorization: Your API token must include at least one of the following scopes: project_role.read, project_role.*, project.read, project.*, *

Path parameters ./api/public/v1/project-roles/{projectRoleId}

Parameter Description

projectRoleId

The unique identifier of the project role.

Request

GET /api/public/v1/project-roles/prl_1tHOGjQEVLbLwIySNtIg8s HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYmM2YmI2YS1iYjhiLTRhN2ItYjM5Ny04OWEyYjE0ZjRiN2MiLCJqdGkiOiI5MTU5OGY1NS1jYTI3LTQyN2YtOGQ0Mi1mMGE4YzY3YmMzZWEiLCJpYXQiOjE3ODkwMjUyMzMsIm5iZiI6MTc4OTAyNTIzMywiZXhwIjoxNzg5MTExNjMzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2RWWUQzbm1ha3hxRHJGQXljRzUySCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.l9NLylrScXtgvywaDTl2PVP5k1Re3q9xDnvTkAA-v2ixz64ogtpYIpEufMOQ1t1CWWnSwDINAQ5ABRzSxGPpEEqe-X-veZDh3zfQKkCAyNiKnM9otV3Dpwjz1OFEYKY74k5EHeZ7rFJkFwzveY2frM-7PgBwaW8ckNBipM6XfwxOdyob5NLtzEIUKHw204jOW9iwL9pehiGQJ_CcUaa0uWjCRZNnAUfGK-4k8h_6dh5IrXtqZO4hJJ_lPxTxopahJ8Uw5ygCyNBDPwjWdG_lzzo1kBM2w_eIumjKDOkJmINf6GTDyjW7o3i1nzyVUIwb4jZm57NfgteqqeTzQmDHnvtn5CbpOVX5bgym8sTL_x-onXWK3rdFDU9enbewuUS-gpZGUEtZ8JkP7Zj1YmVVWQNiQy41yS8-jWF9AL-ylTIkmfccPzJ3u5ScYG6SBYbXKvG0oOFnqk9B8BqFmblmmg5LLyRGkCy2iQaaLLT5VCEYKl1bd4443ZqeO6Ta0Yf82WaVMSTMfg24Vch6hdSqYksM0eYIu8Et5t6CLI7q2JKDWRqyXaiNdzJviqks8Ij-zFk7VzOP174LEYoU64mGNnqVJG54dyoMqylTWrAOBN-WVekB8VSshW4_n5se_lmh2vMlNfZHG8rGJVgqtcwF8mWWeccncgMwZ81OfsupyfI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 234

{
  "id" : "prl_1tHOGjQEVLbLwIySNtIg8s",
  "name" : "zjUZOA39uL",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-09-10T07:27:13.373441Z",
  "updated_at" : "2026-09-10T07:27:13.373441Z"
}

Update a project role

Updates the specified project role by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: project_role.update, project_role.*, *

Path parameters ./api/public/v1/project-roles/{projectRoleId}

Parameter Description

projectRoleId

The unique identifier of the project role.

Fields

Path Type Description

name

String

The name of the project role.

metadata

Object

The metadata to be associated the project role.

Request

PATCH /api/public/v1/project-roles/prl_40Q7Az0tBi1LJkzhmRzT4X HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMDhhMDAwMi1lMWU4LTQwOGQtOTUxOC0zMGM0ZDYzZWEyOTUiLCJqdGkiOiIzOTdhZWU2Mi01ZmYyLTRlZDItOTRkYi01YzIwN2QzNGRiNzgiLCJpYXQiOjE3ODkwMjUyMzEsIm5iZiI6MTc4OTAyNTIzMSwiZXhwIjoxNzg5MTExNjMxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFSNlBUbkJscUR1YnZEbW5iWDhrV2IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.kKxtxSN7saVBMsCsPAtqksp2UiWYBwsVTTNAbu_9K4pnoH54nVe837lzPVaE5IbwAfcq9fDJHfDEbbhNTwgEsp_yiLydqbTwrjPrOn2cBhsuwDD_SsN39VdMExItW6ZGtiguc7JsHiCAfozEAo4reE8WvFYQWOjW5R_1XytNxdJPl2MMni5HXB9S1JPUgg0aK14t1BPfvf49iZ5_HLf7HnhQNWDv3PJvrAhikaScWIfjn7TtXV5S9DZw1SZnz7BELuzrY7ztMyp5e9X8NREFY7bZTpwQQxtvFRzKSnvAYj5YntS1U1Xozo0Wc0fNQqXatQbifTUme_uuOs-7-XsFZfT3x8q0ZgNmcRuBNweqL2gdyAGTyYgrfmJR2cVK_8j0LYlECR5i7d6TaPZiBOHdfUoajMMVK_rDcAwdCd0PK7dzDpuCOt7tRc_YsMIi2I5heJtRn_WahddgNwSaVdZLOAMzQO-SL4KerE-05HZAJumIa2N1QS7PxO99qosiPiioaKM5hDi4hyiTyL1Y9uLK542w_hK3C4dkd41T4jQdXknjOvxA9miUlkJsCuZO5nNLX_PrCLf7uRAwJG_VtzWLnXJglIijCft6SBD1_rpms1UM9zXUOL0EZbFvLbMizWXPFQD0UyRPk6jcSYO4xoB7S_RHyYAMD9-bkfBkbAR1Dcc
Content-Length: 111
Host: localhost:8080

{
  "name" : "Benchling In Vivo Role",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-4321"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 19
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 246

{
  "id" : "prl_40Q7Az0tBi1LJkzhmRzT4X",
  "name" : "Benchling In Vivo Role",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-4321"
  },
  "created_at" : "2026-09-10T07:27:11.141181Z",
  "updated_at" : "2026-09-10T07:27:11.223456Z"
}

List all project roles

Returns a list of your project roles.

Authorization: Your API token must include at least one of the following scopes: project_role.read, project_role.*, project.read, project.*, *

Query parameters

Parameter Description

perPage

The number of roles to return per page.

page

The page of roles to return.

metadata

Filter roles to return by metadata value

Request

GET /api/public/v1/project-roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZDNiMmEyMi0yNmY1LTQyNzktOWNkMi1mYzQxM2E3ZTM3M2UiLCJqdGkiOiJjYzc2NjYwYS01NzcwLTRhMzgtYTQxNi04NzM1YTY0NTMxZmIiLCJpYXQiOjE3ODkwMjUyMjcsIm5iZiI6MTc4OTAyNTIyNywiZXhwIjoxNzg5MTExNjI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRuN2N2Z0NzZWgwS0tyZVpQOW9ERFAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LTmyp2CNfiAKwKanwkUnDhauOKHWJpYK9YXWT-VBht9kE5VM9qnmjVBwtRH1KjAA7wZNJuPxFXdPreFdi3oq0zOXqo5Sq16IVQCqQ_lLa8F_6n0dqUh5obUMlECLVZU_LOAUaOybf3SOpZTwd_SETlX09C2I27Ew48oYXVTykAKfoiKQqwS-FUpFRJTMbKjQQG2sjMIO6wwaqMd2urqk6bVYfFB8tI_K17gDC95SwvNoEPzPNG6oXHmtC3itdnp713N9XcMnAOerQKrwxeGvKhAXky87YkAEJQwV9VnwG0wrqyZwlg_PLUa9LjAdFW78ga0SBFl2b4CAa4jPSn9fXZhnYXIPPUdpo6zvHtLHn8nuChDhtxEc0zhlc0UW7P68AAbAXHwO-rqOKq8Nl-BU4dC42Odz0gyu39ekKb0Iu5TaG6g3ESmT-pdVsgmZyFrWNb_IYamlAGPn9TsIFzpFRfpdEZW6hm-l3yAIjFCzFuOcKWxcHo7CjZAIpp9vDAM3oldHs-XsoYovpfvLyqueBTTI89OurhnRVTPy-wJ3G8GWV11SsF0w_1hocdwdV1YScTY3FHVLJhcwgBW5-QaL4xqvHap4z7kr1GUtWIQq7nQMnQW0jbiVg8yG1R_3f58y1_ZRf5YxSLRjcyceoZNRkKv0zeu5cH5h4FasOWqICDE
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 667

{
  "data" : [ {
    "id" : "prl_9LnEQ0Vcx5UXMEE2oBxo9",
    "name" : "6GWjmcBkqU",
    "metadata" : {
      "project-role-internal-id" : "PROJ-ROLE-1234"
    },
    "created_at" : "2026-09-10T07:27:07.331918Z",
    "updated_at" : "2026-09-10T07:27:07.331918Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/project-roles?page=1",
    "last" : "http://localhost:8080/api/public/v1/project-roles?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/project-roles",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a project role

Removes a project role.

Authorization: Your API token must include at least one of the following scopes: project_role.delete, project_role.*, project.*, *

Path parameters ./api/public/v1/project-roles/{projectRoleId}

Parameter Description

projectRoleId

The unique identifier of the project role.

Request

DELETE /api/public/v1/project-roles/prl_WxzFLelKNBK22WePpeDMj HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmOWNmYmVkMS04NjRmLTQxMjgtYjI5MS04YzQxZTJmYTg5MDQiLCJqdGkiOiJkOGRkZDBhYy1hZjllLTRjYWQtYmIyZS0yOTg3ODVlY2M2YTQiLCJpYXQiOjE3ODkwMjUyMjcsIm5iZiI6MTc4OTAyNTIyNywiZXhwIjoxNzg5MTExNjI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJJWXBWTzd1aUpjOHNrZ25kTllSQnYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ghCAXyo7apOlvO5ED6ddkVTr5OXhWd9vBgF5nwbJYA1gbTch93fem1DdWzvSYHX1sPgX7XY4GSkGnoBsZA6w_HxXu3s6RfTtOWSBneDYZsfKA703Qe5gdJeRkPLRKCpV7__QxxipW2tpCrvNt6byGWmyynvEh2Br8CvWxPuZYUFl0NEx4TA2b_U2dZw34HqCVVfTLAyHxcjAeAXBFr-5Ur7mlDlt0f5VaXtCQ34zxjbQWVZkyUWeJ908nTqeNJqeZcQdlydTTAf6es5Fq0j4ziDGapnszKSGZP50WSn2L8N0ts_B3GMA3mhqlvYXF89RmaOiO7hmqL1aNvdERe1z-EwtyiR8-ba9JO_IkXqw3ZS-5lkr8Z_6VpmZ53b2-7EhIjAjFtmds8kwYYra8-mCmyrQ3e33qMf9Mdb-g-sq2Pw1MkCEkKZT3UAzE0v29aP5Ok7lsAMWfRehBXKJsETUAq5tCJjZ2GBcvPcw4ZS_iQodXsNtWc4V5Th7KlVeeVVkdxXHU3bsepDtjvdhCN43PFgGKp0Pv91uXhlpjHGv77UWIUTnKe5clFIL-N2BZHL94xCyi3x7WsC0yqJ9btJLEjvHXIEUGUn9T_PQKGBNycSl8iJbw8Dz7ZVnmfpRFu2OjKztbINi8q3QBn8mCs6OD9-Czb1v0alyk2WTjT9MsGI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Project User Role

This is an object representing a user’s role in a project. For example you can set a specific user as the toxicologist for a project. You can retrieve it to see the user assigned the role and the role name.

Attributes

Path Type Description

id

String

The unique identifier of the project user role.

role

Object

The project role associated to the project user role

user

Object

The user associated to the project user role.

project

Object

The project associated to the project user role.

created_at

String

The created timestamp of the project user role.

updated_at

String

The last updated timestamp of the project user role.

Create a project user role

Authorization: Your API token must include at least one of the following scopes: project.create, project.*, *

Fields

Path Type Description

project_role_id

String

The unique identifier of the project role.

user_id

String

The unique identifier of the user.

Request

POST /api/public/v1/projects/pjt_tcbrb5yma4TYandR0WjPQ/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZWVjNWUxZi1iYTlkLTRjNjQtYWIwMy03NjQ2ZGJjMzc0ZDMiLCJqdGkiOiI3ZGZkOTkzNy1mYzY4LTQxN2UtOWViZS01NDJkNjFjNzVjZGQiLCJpYXQiOjE3ODkwMjUyMzUsIm5iZiI6MTc4OTAyNTIzNSwiZXhwIjoxNzg5MTExNjM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJ2bGV1TmZhQjB1cVhNUndCM0JaT1UiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Kc4GgGbihrUa7qkjwngzqRKyp4d_cPDnGkzu1EGhf31awn4PUJJuM9fNVIK249r5cwkO9PSJAud5fe4ygtz5pl86M_1jokxmWSwFdP5UEv5yJzR8i8_CrW3vU0MbaZ2KGDXS765eW7Mo5QdR5YWH1FuuKrnsEhkqi-AneqAJoDvFjeyZM49jNQ4fi6Pe4zB_2ViZCxWp81XxJhoVUtlHT7Qo4d1VvhSl8NUEJjcOdt8Lig0zIyM1ewVk1rYILQfE8gXmx8IdYgp8qdfGPmhAMLeL0AnlxAw9au6CQuhcWiaQWq6_IeYVqIJfzghUDaMsEGMmQsQ6kKUpDHSpKXVB3PDf5EH3CCJNpD8tdpFyhg0Qf2Vobc6LCdiylouQUwg6a04z9wBKK49Zu4Op27SkJHcCsFSkCBT2y3hAoMg58N_j_csgYfxNjHpPiMbACeHFmuhWZ5mxVb8OxbKMgr-HiET33WhhFwNzq3x6XSS_ciG-RMvEvOM3F7mpqXbpJxYiJPSonzJKpiZi58fPMfV4bp_YS89hsN7Gau3-Kk2sqQqxay8a9jq6weYLvspKUa3IfZCVKGD_jSQSWcZ1A6rpfQjAWwteQQkihhL3xBD0TQGCFZT5ffn_x1EMalnDGnTFlCPZOdbxQCgRyYbsuIpuuSeoEsUP8Yem0HlCj5682Xk
Content-Length: 98
Host: localhost:8080

{
  "project_role_id" : "prl_4htuj7PiZBwmhcMBAAQsER",
  "user_id" : "usr_5WW5yGhyXeMdKWBONBtG4L"
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 602

{
  "id" : "psl_4imnMamxtGuNVQs9zvMkiO",
  "role" : {
    "id" : "prl_4htuj7PiZBwmhcMBAAQsER",
    "name" : "zY1kRko1ki"
  },
  "user" : {
    "id" : "usr_5WW5yGhyXeMdKWBONBtG4L",
    "name" : "J0jgojMEyY",
    "email" : "aPKXyM1E@benchling.com"
  },
  "project" : {
    "id" : "pjt_tcbrb5yma4TYandR0WjPQ",
    "name" : "ewBny1Df4P",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:15.661012Z",
    "updated_at" : "2026-09-10T07:27:15.661012Z"
  },
  "created_at" : "2026-09-10T07:27:15.936984Z",
  "updated_at" : "2026-09-10T07:27:15.936984Z"
}

Retrieve a project user role

Retrieves the details of an existing project user role.

Authorization: Your API token must include at least one of the following scopes: project.read, project.*, *

Path parameters ./api/public/v1/projects/{projectId}/roles/{projectUserRoleId}

Parameter Description

projectId

The unique identifier of the project.

projectUserRoleId

The unique identifier of the project user role.

Request

GET /api/public/v1/projects/pjt_6OfNZpm1BFt0c6ubyz9ibM/roles/psl_2Km5M6HoEtWBWt0bUoLwUB HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MWVmMzMzZC0zOWRiLTRjYTktODVlMi1iYjhjYmNkN2FiMGYiLCJqdGkiOiJhZmRkOGQ4YS0wMTlmLTRkYTQtOTdhNy0wYzJhMzdhMzU3ZDEiLCJpYXQiOjE3ODkwMjUyMzEsIm5iZiI6MTc4OTAyNTIzMSwiZXhwIjoxNzg5MTExNjMxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNZd0ZQdDNkaGtpVVF5aE5uRzFiNkIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GNV3C3saKd6BatY5iCEDWM_mmIAVLS01dBql8DnhzIsKxvZDjE6GGc-P5IXo2NEfuB9BOXMBobEs7CZ-O5oGz1hRXd2oMpF3eIM1abb_Np0BX83E7opIpJAue2a8gpqRhgRNVa4bVXbNdBfLDb-IV0wv0gD_4OYCBDHmay6nT0pN1wDGNdFiNJ9fXtQnbi0CbJhWCd7YOIlzduSLq3uIMcB24N3VZ9DIbp7U8WkSPWOXlBNyjLSnZ60FIQjAv1JvYaptb1tUPJLibjoOVIv-agxPr5CSPchk-ar9WDBEuPj_y2QN3HhxYkZOw5DzsA80PAvuO2V4CQmZrZoslQm2VPbZmCFoP2-pQrAQsw7Aq6mZQY-GlwJx-sWI16tdWhSfQyOy8IlKQYMmYKwgMf6wuGV6MAWQSh_wi5mSKCuRVINFelbmz0lGFaqvjY3ftWwYjI9LP2epRnZCb2PteJdAxalqN6sYO1FIYwXZcNF-p-hDJuZx9qBwHqHfTs7LotXQdp1HNm-ejJNlOi5-Q4_Fm_72F4Kv4Je8IRchXvcc7bxwpeCWQcYXzv9yixVt7Qnd2FZqNe9IkU5oazfXE-dFM0KoVZk1mzfAe4I21oIM_1rVDMD733zoUBKehfFTzCU31vES7uUsQkgGr0_ALQTAkheAtNgBlai5ZhFUwxC_LtA
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 19
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 603

{
  "id" : "psl_2Km5M6HoEtWBWt0bUoLwUB",
  "role" : {
    "id" : "prl_7JBhchadbph133uSG9hOl1",
    "name" : "u4L1Ex86cV"
  },
  "user" : {
    "id" : "usr_5j8hppWBaHFUkiXL6PNDxn",
    "name" : "iEZsebVgUD",
    "email" : "6FBo6jqT@benchling.com"
  },
  "project" : {
    "id" : "pjt_6OfNZpm1BFt0c6ubyz9ibM",
    "name" : "fJcLyCvvpi",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:11.284098Z",
    "updated_at" : "2026-09-10T07:27:11.284098Z"
  },
  "created_at" : "2026-09-10T07:27:11.474929Z",
  "updated_at" : "2026-09-10T07:27:11.474929Z"
}

List all project user roles

Returns a list of your project user roles.

Authorization: Your API token must include at least one of the following scopes: project.read, project.*, *

Path parameters ./api/public/v1/projects/{projectId}/roles

Parameter Description

projectId

The unique identifier of the project.

Query parameters

Parameter Description

perPage

The number of project user roles to return per page.

page

The page of project user roles to return.

role_name

Filter project user roles to return by role name.

user_name

Filter project user roles to return by user name.

user_email

Filter project user roles to return by user email.

Request

GET /api/public/v1/projects/pjt_4Ujmnuv6jPJy1Ru6BruBMS/roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxZmM0NWU4ZC00NjA0LTQ3OWEtYjI4OS0zMmZhZmE1YjZkMzIiLCJqdGkiOiIwMTJlMjk3ZC1kNzZkLTQ4NTYtOGViYi0yZjVkN2U4NDMwZTkiLCJpYXQiOjE3ODkwMjUyMzIsIm5iZiI6MTc4OTAyNTIzMiwiZXhwIjoxNzg5MTExNjMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI3Ym12MDVZQVQ3Y1hiYktrUVQ2TTAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.U8rc5k2rQH_ZFWAj7XeveH_WCoWAdyC3TD-zgGLwsl39sKoMCRDlfnvy_5zJ5AQ2CgPulAB4mE9TFtPjm-x2Lb__jgkAMcSx9p55K5QsM0y9m3q0qLtG0P0yELqm9dSBEVlGQuP5wYF6yZLKUEtxLW6NHImsF_x31njSHFkAvF85ypsVTD0fRX3pgUeZ1QLz-BVFtUZa-nOPXLWD9Cc-Eu9Xldpq61eu78-PkOZV9BRmaTbkhqpJOau2dNN2DBdaJLItu1YZOsWexpe9D6bIrUC-PIU-7UVJHFgZmng6Ib6wPdm98KOuWQUCFRjhyiLbrTwZqtsay_Ur3TLMCKZo2RYTBSeqYJ-kbRmDffoBHQCMtU61iF9_CgZAK7gnk2z3O6IgM6tAlWhDHdZUUGVjwyB7NdvpAsFXoSWGfImHtHVLLxGA1TpMB6UNhnjR4_JFKjp9iY_NuunKwK5yd1dYHtdnwYi8At_ozUevwprsra0kKyVJQ2b8b5rB58z8srsu2GqjtP3JXmboXEIBlW8umXetihutIo1gDBxHyJnwt9idQhJd7_RlapjbLCmbKQWqnK3zCzOpLm3R2OMlZPVe24PIV_7R92_HaJsFitzbUvxii5fqxcowzMSc5dDoQZezc5G0ZMXjgp9mTmrOICCkYdd6TcfW7Zdop5zKd-LPy2I
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1149

{
  "data" : [ {
    "id" : "psl_4LmHAupjQDJKmRWzkCeU2J",
    "role" : {
      "id" : "prl_60x80cCzCt79jpNTA8HkuN",
      "name" : "2NCgXevZu2"
    },
    "user" : {
      "id" : "usr_1nNufba39XO8AqSf5UGgQ3",
      "name" : "Z49I8Js914",
      "email" : "WcdzrOra@benchling.com"
    },
    "project" : {
      "id" : "pjt_4Ujmnuv6jPJy1Ru6BruBMS",
      "name" : "CTc6IhS5Xp",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:27:12.081051Z",
      "updated_at" : "2026-09-10T07:27:12.081051Z"
    },
    "created_at" : "2026-09-10T07:27:12.244315Z",
    "updated_at" : "2026-09-10T07:27:12.244315Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/projects/pjt_4Ujmnuv6jPJy1Ru6BruBMS/roles?page=1",
    "last" : "http://localhost:8080/api/public/v1/projects/pjt_4Ujmnuv6jPJy1Ru6BruBMS/roles?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/projects/pjt_4Ujmnuv6jPJy1Ru6BruBMS/roles",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a project user role

Removes a project user role.

Authorization: Your API token must include at least one of the following scopes: project.update, project.*, *

Path parameters ./api/public/v1/projects/{projectId}/roles/{projectUserRoleId}

Parameter Description

projectId

The unique identifier of the project.

projectUserRoleId

The unique identifier of the project user role.

Request

DELETE /api/public/v1/projects/pjt_2SMeYKUW4vSiPC3xZXFwo2/roles/psl_1easN4p85QzZ5m4GcEw5q3 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYTA5ZmRlZS1kODUwLTQxYTgtYjUxZC0yNjc3NjhmOTg5MmYiLCJqdGkiOiIzNGYyNmU0ZC05MWZjLTQxYWEtOTJiZS0wMDcyZmRkZDA3YTUiLCJpYXQiOjE3ODkwMjUyMzYsIm5iZiI6MTc4OTAyNTIzNiwiZXhwIjoxNzg5MTExNjM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR5SDlxZVZJaGphZEJrbHRlWTRvNlgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.fh_Oxt9yly7OSi-95Y6pm5BnnMRlhCpDM0zF5LbsCu1U-Y1bza3hRMMBEGFic_F5RCqqcRF_YuKeN6X84If_vkAaJt_WputmXJEtXNQ28x7fMlRP-RC-hYELL3XmQnfOtPqfyfUZx_todkBc1gNorsXc6XckzHBuAaCKF0saVWUqXHkePUcAkA6Ve6S6VfsJ-_W-6UdV07b6A9wNprnLeKLtM2BqiNVQgjraON33VmY5HZWctgSijuxSZ3marNHdN3YIYhY-UwgSxzDa0jRfrsvW1j5RfDYeeJPN_ZVVwW2zOTUoqRX7e4vdveKGi5Xix8PrAUEG33uwMvl1EQT0Y6KZanL8znVD9-GjsF-NSXy5vEy4Fbskq0WHx56wX40ZgRCb1CE24OFHeQ8qNza72GmYpth6hg1rD5WrcffaBGMf_CYF25-NZXZ1yy1l1mUeY7YjGBWUCn_md0luK-5Tm6vFM-6KRUywfxES5Vf2wW_Wr2hR9rVZyyq4KKLkOhUu9eDNHY4hNms09qCDctMJCAVxuzrtkdOj_QYcj6nzDrbAfqP-F47PPeRzif-T0-DpPT5aueC3NIICO_MxEYvLX7Kp-uvHUSbV4aR_WEyaS91r0r889prCngxqLNvfOB-AWPDKZAEJQ3ATOnX-U9GyTQ9M36RDbYnJPYhDEOkpCw8
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Sample Glossary Resources [BETA]

Sample Glossary

A sample glossary item defines a type of sample that can be collected in your studies.

Attributes

Path Type Description

id

String

The unique identifier of the sample glossary.

title

String

The title of the sample glossary.

label

String

The label of the sample glossary.

description

String

The description of the sample glossary.

status

String

The status of the sample glossary. Possible values: active, archived.

details

Array

The collection details of the sample glossary. Possible values: weight, depth, width, length, volume

Create sample glossary items

Creates one or more team sample glossary items.

Authorization: Your API token must include at least one of the following scopes: team_glossary.create, team_glossary.*, *

Request

POST /api/public/v1-beta/team-glossary/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ZTU0ODZhMy0yOGFjLTQwYzAtYTY3ZC0yODE2NGMyOWY5N2QiLCJqdGkiOiI1NDg1Y2JiMC1iYTZiLTQ3MDktYWZkNS1hOGI5ODY3ZTY4OWYiLCJpYXQiOjE3ODkwMjUyNjUsIm5iZiI6MTc4OTAyNTI2NSwiZXhwIjoxNzg5MTExNjY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVoMUxmejRFVXRmZzJMcUlnMjhYc0oiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.MbtAoZEXahf6yPka-o4aeKjftT8GA-fUbox4Ld1ni3fQmH5wCcWQhZ5ojYGFJkufDxl2xbWZazEFlL47DJeAdId2ZcB5iHC-PEKFnE4TDmBMucwC4TCABGwK1vd7tyBOrq3IHcNv35gWpc0qHecwmROLe-ciF4EXUmbjVbSkNXJrlHq8uMie7tlzMSQzISK10Xn9TooZH7yfMUu_xQYixsmc_u3sIp3lZntyP6qhC-0b2BVMvysatJ1U5vJzeyAozXYp6M0wt7hEuI1ocLIlwRsVCJEeIEagyXuqUTPXzzKIs8RLPXEBTdsR8o4kimiUMmciexn8EUxV6lvpvYXwAn1HLRt5yz6Htc2Kq8y78M2np3i9cNQRMWjo3M_PK6L-NvZgON6buI0bPvtT9gsmBXQkppLeHGtDgei8FHldXWWSDkhgaTMsHBaW2mwjkGo8G9e5hvIGzn0czT_8e_r75dM06q3ru9r860p2_7EG-uf165mEDY-a247nk9c4mT3HVMytGzg0AlD_nEFxpdS08kEHxmUoX_n9X7s1VboqcvIbmFcjnaSWONecj1s9hhAW93P4BwK0gjmvMVPqqlSKj-OPFBSVEYkjxQluaH4ktbSbTLLThM2OSEuhxF3DLuE_-Ljv_dCq2yCQ_4grAw8WDnhkYiuy3A2Cp6AVyPgMWAo
Content-Length: 212
Host: localhost:8080

[ {
  "title" : "Blood",
  "label" : "BLD",
  "description" : "Whole blood samples",
  "details" : [ "volume", "weight" ]
}, {
  "title" : "Tissue",
  "label" : "TSU",
  "description" : "Fixed tissue samples"
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 399

{
  "data" : [ {
    "id" : "tgy_3VNXrPyfZAViNK4Xx3Tt8X",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood samples",
    "status" : "active",
    "details" : [ "volume", "weight" ]
  }, {
    "id" : "tgy_2oZtvDKDkchqkMOR8dJ5Mm",
    "title" : "Tissue",
    "label" : "TSU",
    "description" : "Fixed tissue samples",
    "status" : "active",
    "details" : null
  } ]
}

Update sample glossary items

Updates one or more existing team sample glossary items. Each entry in the request must reference an existing glossary by id. Only the fields supplied in the request body are modified — any field that is omitted will retain its current value.

Authorization: Your API token must include at least one of the following scopes: team_glossary.update, team_glossary.*, *

Request

PATCH /api/public/v1-beta/team-glossary/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMzA5MjA3Zi1jOWQ4LTQ1M2QtYjVhNi1hYTI2MDJkYmM0MTciLCJqdGkiOiJkNGU1NzliYy1jMzU0LTRjNmEtOWNjMy1hMTJlZjE3YmQyNzQiLCJpYXQiOjE3ODkwMjUyNjYsIm5iZiI6MTc4OTAyNTI2NiwiZXhwIjoxNzg5MTExNjY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzcyRFdpcFFyOXVtUXhFdVdKUUZHUnYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LyVQk0UqMwTkO5olFSBj5yrp5eeYQCpbPltphVZQXcvgxagPiLY53t60qOmvLnACVvu6fV0sLpTyzsFp2xPbUgnOzvMxTiP9-uNy00qZNQh1gu_BASYmPGq__9cBrYCKjor60OE8ncEauToV5JZ00pNgX_9aPgQ_DPBfNn3-3CGEuVPFR2HToKUcZXloTF2sLeO2fQMM4ypeItL2QiCqQiXb1L2SCTLza_nTkUdFIBx57IKcZ8hojwu2rzyCqHfTDskBMR_tAhuJfTd61V1tDPxr-9hm_Z2DkUHR5PH1YZnkEh6x4ELLzwAbhSQxaFHtLPqn9JcVTrXPO59Gbidi95XJSK3yevYxc2lpcNQ45INHDF-JQJgmQj22LbJYb8rVwdTVxOfbRvlKBrrFMVvKu1WJCd8YlaO-mktZpmiIB32flS7fpu-QuS-M9Rn2bb_v_oCEKu0N04dOjEB6KwERGWu0YD_dzGZgfHU59_7jyNxfky22foDTudikP3KSr3uEBUoHoQGrejYJjCzt9M2Jg10M6QZsvNZesW30yL-ai1AbrN4MTduJzz8taJ4pUQxTc61vRcURoh23F2W-08ZVYq95Fs9HE5Y0CFTYw5KVjrA4-qR2TzqIPt78oKw023fo5_CwNs4IsE2XuHVChB20GiacJxn1vOpHj3Dcnia72gY
Content-Length: 448
Host: localhost:8080

[ {
  "id" : "tgy_3KoOVLi0hMSuidRsb0WkIR",
  "title" : "Whole Blood",
  "label" : "WB",
  "status" : "archived",
  "description" : "Archived whole blood sample",
  "details" : [ "volume" ]
}, {
  "id" : "tgy_56kgSLP8hlwtbhYkLT7SHi",
  "details" : [ "volume", "weight" ]
}, {
  "id" : "tgy_3A3yteIlNxTPNPZAWcfis4",
  "status" : "archived"
}, {
  "id" : "tgy_51puvKFDsbt5cdrZ7LIIAv",
  "status" : "active",
  "description" : "Blood plasma sample"
} ]

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 785

{
  "data" : [ {
    "id" : "tgy_56kgSLP8hlwtbhYkLT7SHi",
    "title" : "Tissue",
    "label" : "TISSUE",
    "description" : "Tissue glossary",
    "status" : "active",
    "details" : [ "volume", "weight" ]
  }, {
    "id" : "tgy_3KoOVLi0hMSuidRsb0WkIR",
    "title" : "Whole Blood",
    "label" : "WB",
    "description" : "Archived whole blood sample",
    "status" : "archived",
    "details" : [ "volume" ]
  }, {
    "id" : "tgy_3A3yteIlNxTPNPZAWcfis4",
    "title" : "Serum",
    "label" : "SERUM",
    "description" : "Serum glossary",
    "status" : "archived",
    "details" : null
  }, {
    "id" : "tgy_51puvKFDsbt5cdrZ7LIIAv",
    "title" : "Plasma",
    "label" : "PLASMA",
    "description" : "Blood plasma sample",
    "status" : "active",
    "details" : null
  } ]
}

Retrieve a sample glossary item

Retrieves the details of an existing team sample glossary item.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Path parameters ./api/public/v1-beta/team-glossary/samples/{teamGlossaryId}

Parameter Description

teamGlossaryId

The unique identifier of the team sample glossary.

Request

GET /api/public/v1-beta/team-glossary/samples/tgy_2UizRbkhLr9PbuUPdPxlry HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMGViYzVlZC1mMGM2LTRmMTEtYjM4Yi04OTg0NjkwMmI4ZmEiLCJqdGkiOiJmOTQ1OGVjYi1lMzJiLTQwMmQtYjg4NS0wMzFhNWJhNjM4NTIiLCJpYXQiOjE3ODkwMjUyNjMsIm5iZiI6MTc4OTAyNTI2MywiZXhwIjoxNzg5MTExNjYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzcySExFZXV6ZlBUeUV6RHJUUUVqRkkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.jKaM9fmeldv_QXArB-0dhZv5IBQqxXAo4carbXBFdE1JODAR2aIZ7Mfmw3TVSpifJF9iSz3wMWws5uJeQwGKmCCA0IbG6QMcy0Vx8ymHWyX7D5JnD6UQ43QvudKMM7FruOgODEtHTQTMgZ62CFTOjgYuWRbH_c_v4-0lFvKwaFwdGfXvkzrUUPz16NBTqBDnGvtCZLkgONIzhQc68qrPGBFP3q5enBsbQ0ChDGpPuLfVJ8FpevX9HJ62KFEiDtM-OC8cXtXMlBhEyC7zPEEHMXTz_MXly2mDB1SvUrtmHah_NucMsfPx9qXqARaQmMfYRqe-q6S9dFi8yKq1DVOp1d2vwd2Z5Bp4MNXclY8BhxUBJhj_hLllabNSjREyVf90txyNNcHjNFHNCLa82plq_lW3KgD0ihQTBlgNbOvdLA4ZKVo6_xkI1Y_6GquI2o5xQfgnruNDjzEDexiq8j4aU6lENCn0PoS9jgrb0IRqIjDHp9_QrzTYd6_YB0BeHFZYht3dN0t9DMS6IvoUhYO0hxfBagkr7-Kiouu7H8x0JHmdRDNavm4pmlwRfxPIYXWlgjc9hEQRGDr0FhlApufQ8tM2d61R_S9u0Of_Oeckz2RVfFp8gB0o4-WyjxSTLsziLO3e3jd8v4SLn5_5hzUnUz27AJVmcPQPD_C4GjgwMyE
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 207

{
  "id" : "tgy_2UizRbkhLr9PbuUPdPxlry",
  "title" : "Blood",
  "label" : "BLD",
  "description" : "Whole blood and serum samples",
  "status" : "active",
  "details" : [ "whole_blood", "serum", "plasma" ]
}

List all sample glossary items

Returns a list of your team sample glossary items.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Query parameters

Parameter Description

perPage

The number of sample glossaries to return per page.

page

The page of sample glossaries to return.

status

Filter sample glossaries by status. Allowed values: active, archived.

Request

GET /api/public/v1-beta/team-glossary/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ZTNjMTQxMi05OGU1LTQ1NTgtOTk5Zi0zMDZhZGFjZmZhYzgiLCJqdGkiOiJjYjUwYzBhMi05ZjhkLTQyODItYTgyYi0yZjg4NjVmNzdmMzgiLCJpYXQiOjE3ODkwMjUyNjUsIm5iZiI6MTc4OTAyNTI2NSwiZXhwIjoxNzg5MTExNjY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF4VTRsSkhOTkZWcmxicmpIUEE0enIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Ycddd2maRNZuN0YoDjlsoh1B4prOPqg8lIy1f4ezmWQaZFc2LwfMwp6ZQObZbp868-l2uYiVEg4HLBbBy2UleRn_EGY71JNkrUBJ2c-J7rkWXnOhfWGkzMQoHO65RibTHYlh2Du2laujlXF2UiMIJnRxhDB-c6_5DNrdJ9I_NIhLMxAKI5PplLkYlND9uQH_TeCBMY7CknxGC0sTVUqnDcD5TcM1lU0xk3azeN3tQAXAfUI5KW3qc6WTDzFA9zi2mn-5yUExnC-Lut_3lHwxKOUXFUxnWgsHRNvkJKgGbi1Q7uj9uPzmWKYyRuQqoxGpuZoH5XSu11apftHZAWbPXXgEu0EMRbpfB1r4NKrXAgMwtQHuHjg9P3kBCvJ4-ovTTJufThNz_1ukMtovO5HYtfVKZKYpid2Rh7L5HKY3OyjrLfHs-O0Sc5ig_-b9jzW-NTj7ZIkFGQEBzgiL3BNNtghRFMQS08Jar6kpd4_lmKI67B3Rd2cz0Ou2FaPnrKQi5ChGey0x3a-zCthsLwFaeImOxMqrWqAR18s6ROMnBf2srF-nYbBS2xP4ijyK0FJCngaxwPLeM7G34cV23eMiAu6ZmPoSzruaBzn1g0dR_fTn0On1QN3WGhGRFCD4ZqqYTqcIjwyWVIpXTZXLtsk9CfONXdWLQ4NX-zsOBTnF_JM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 888

{
  "data" : [ {
    "id" : "tgy_36Dg8qdXfitBntOVIpGCZU",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood and serum samples",
    "status" : "active",
    "details" : [ "whole_blood", "serum", "plasma" ]
  }, {
    "id" : "tgy_56oIZJzrN8Rj3CYM79kfN6",
    "title" : "Tissue",
    "label" : null,
    "description" : "Fixed and frozen tissue samples",
    "status" : "active",
    "details" : [ "fixed", "frozen" ]
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/team-glossary/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/team-glossary/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1-beta/team-glossary/samples",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Sample Resources

Sample

This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, status (collected, planned, cancelled), timepoint, details like volume or mass and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the sample.

sample_id

String

The sample ID of the sample.

label

String

The label of the sample.

type

String

The type of the sample.

status

String

The status of the sample (collected, planned, cancelled).

timepoint

String

The timepoint identifier for the sample.

collected_at

String

The date and time the sample was collected, as an ISO 8601 UTC instant (e.g. "2026-03-25T10:00:00.000000Z"). Empty for planned samples.

details

Array

The details of the sample.

comments

String

Comments of the sample.

sample_definition_id

String

The sample definition ID if the sample was created from a plan.

metadata

Object

The metadata associated to the sample.

study

Object

The study of the sample.

animal

Object

The animal of the sample.

user

Object

The user who collected the sample.

created_at

String

The timestamp the sample was created, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

updated_at

String

The timestamp the sample was last updated, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

Retrieve a sample

Retrieves the details of an existing sample.

Authorization: Your API token must include at least one of the following scopes: sample.read, sample.*, *

Path parameters ./api/public/v1/samples/{sampleId}

Parameter Description

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/samples/spl_37hcir6DCxJQXHntv8iwJ0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYzcwMjVjYy1lNzBlLTRlYzctOWRiZi03NmE0YWJhMmM5NWMiLCJqdGkiOiI3ZWFlMDRhMC05Mzg4LTRhMDItYmJjNS0zNTI1OTk1M2U0MzciLCJpYXQiOjE3ODkwMjUyNjQsIm5iZiI6MTc4OTAyNTI2NCwiZXhwIjoxNzg5MTExNjY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNXSHZzTG92ekpUSlZ4YldkZUpLVXoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.TbRD91L58pYM5oSk8QCSHPBcgs_My9J0KMgKbFLiIckbBdh9E2u0wJkRgmoS7NHHT2z_8N2OYvG0YLHs2FZfa2MPpYCNTHz_pbF5hrdSKbU56HE9plzUi_dZz19v-owefYHkBb3p8Bm-XW1fBgMW64uF128g_Hd6CeqbQL0GXap_xdOJMfQxiyhSaoSFtlCP4mcGTBFTIwGiF3gsYN0WV1rTXWzGABKenTXhVjwNzNW_TkvoQZouQZ0IUo0vrZJ7rFdHc5lbpZmMV8CueUD_yMTHABSrh7xyJk8X-0hH9mR1_m_jhItiiURSyt5K2jVw2Ontb_9uMKJhOkP3uuDuVWZZ9NsqvZMFzYefGUOh9y4dwFUpy2D10OvYwUuIBf1Arf32b9-xflQfw29WJyQ9api9EkkFE8qemZ_-X0Mk-88hCRhBRxItRfTyG9P22tWVsIKl_EYwaCINlEbr9henc4fAtRhmSfqOYwwm_m41VYY_q3jK_GIGQEdheRSMXO59BR9XMKMgOpkQ_uo0ZYUVUzBcxKDmBniXLrcSyR0rCUeL51c5TNe_rOPdq_ddd6-t2_xfwfp6KnOA1QqxMAqZwd33ogW0_M-kntvQJZ2DeU3w66X9GB0o_on4hmeoB38krS6G02PT8bB5cdgt_u3-UBq2MPwNDx24tHjZl8HyUDo
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 16
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2958

{
  "id" : "spl_37hcir6DCxJQXHntv8iwJ0",
  "sample_id" : "S738623747",
  "sample_definition_id" : "sdf_4XC9rNc3zsJg9pV4HWEy5k",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-09-10T09:27:44.789324Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-117974313" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_6zpMcC7jK0w6s3hzNCfSpc",
    "project_id" : "pjt_7aAIQ9160pOjPeM7CKOma7",
    "name" : "JShUwz8Qef",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_fApQV9UIv6m0RqzUnqEY1",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "D7ZFYGLDUy",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1SfOeae0djeDwQVNyHJsPt",
      "name" : "izp1A8fbEl",
      "email" : "3YM26EPv@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6znqNi9MVXjcrUP6hrhT3g",
      "name" : "I5enJM4muk",
      "email" : "h0VqFXh6@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:43.906764Z",
    "updated_at" : "2026-09-10T07:27:43.906764Z"
  },
  "animal" : {
    "id" : "aml_3kc0yz6xd1r1thCTfpxth4",
    "study_id" : "sdy_6zpMcC7jK0w6s3hzNCfSpc",
    "study_group_id" : "grp_4bPYCg10SeHbwlKzUqwm6J",
    "cage_id" : "cge_4zYLvZQgSOkxqyMO8QOnoK",
    "catalog" : "A0000001",
    "name" : "j25qDOUySp",
    "number" : 1,
    "strain" : "wnsY7zTMW1",
    "species" : "GGNGO2nZlA",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "LXrPxdBvry",
    "ear" : "3ThiB96c7O",
    "tag" : "E8uQeDHEMz",
    "donor" : "I4sZR0lKro",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_rsx8B4AzvTvzV63BlZn1X",
      "name" : "b6PRKHki8Y",
      "email" : "jMUP7XEg@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2vb05097qyAG26PGMEORwO",
      "title" : "Found dead",
      "comment" : "Kx8XozBQLZ"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:44.340167Z",
    "updated_at" : "2026-09-10T07:27:44.340167Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_4p5WGCOgokyRn9LNgCVsFv",
    "name" : "SMJHbSUBii",
    "email" : "0U14NUKX@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "5cEcidDBXF" : "pKihuYZX8r"
    },
    "created_at" : "2026-09-10T07:27:44.768141Z",
    "updated_at" : "2026-09-10T07:27:44.768141Z"
  },
  "created_at" : "2026-09-10T07:27:44.789519Z",
  "updated_at" : "2026-09-10T07:27:44.789519Z"
}

List all samples

Returns a list of your samples.

Authorization: Your API token must include at least one of the following scopes: sample.read, sample.*, *

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

Sort samples based on an attribute (animal, cage, date, group sample, study or type).

order

The order in which the samples will be sorted (asc or desc).

animal_id

Filter samples to return based on animal.

study_id

Filter samples to return based on study.

sample_definition_id

Filter samples by sample definition ID(s).

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwY2I0Y2VmZS02NzBlLTQ2M2YtODUzMC01ODJmYTdhZmI2MWUiLCJqdGkiOiIzZGE0YzNmNS04NjZkLTQ0ZjEtODc1Ny0xY2EyOTE1ODgwMDMiLCJpYXQiOjE3ODkwMjUyNDAsIm5iZiI6MTc4OTAyNTI0MCwiZXhwIjoxNzg5MTExNjQwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR0MnhJS0xCYW4wbFZSeFp2c3dzMU4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.C3reSynQi9L5EsefUs7Z8-us6fs1jwpwHEpLnJBtazyVOkJ5xXVZ5Wmkr9Gopg4glo3Qwp9o265lFMKRtgPaksZMsLqux6IX27cUSfLW8rP5Hq7q1pj4GD5Y60ZcD8WZWNuA4LeNCdgAeTZ-xd1WE4DgGPIEQ1cn3jYTGWCPEsaOa1H-S3u4gvQKPXwOgT6TFHwhuN00bmz-TgJUG9f4u5iI7P8IlnQadcjNxFw009rXd7AT8OEJneSqZHUxAC8jb4W5Xi9nMv6V4TAfmrbVqT3ud1hDRAJvbygYNp4Ds4JjW09FitITCSP54K0LyTmFCCjFD6Zydxp3xmJJAh_EcJaThCBkb8JdfvNF_0i-RdvanWi-YAuLdvvomgsM-r3fA_TX7nbMppVfZm1UJgEt_i_lGGDcouk-F5lPIaDjoW66Z2goDYt_Zgio1uF7gshCkEEMtMnhXbzlwrfwpn0fbmL_7TVcn4RGZ7GZHYjOaC7buEwcdGGO4E6Cvp9gNGnvIgLqYWGaHmCDx4Qh3dUw2kc_CQbTC5EqjTBoXmji0Y2062OhFDwT6JTsg6EBjh4QsiL__08bd9RpTxTEfqFXKIMFJu0aB4MmLf27ZjrYaIUnWr3obzU1IEhKG1I50nW0fheqKt6Oqzm5rW-0WLpJooijM6rXsoQ7kU4qrL8FisU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3562

{
  "data" : [ {
    "id" : "spl_23WVHbn2jFNmGqjj7DfaNC",
    "sample_id" : "S2025609992",
    "sample_definition_id" : "sdf_1EG9OCj6ON6VZVtXmbffCc",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:27:20.514603Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-116330255" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_4VilvsMMvMwNo5NdxEYrVE",
      "project_id" : "pjt_18wW1S2DK4K3aPzyQZYe3n",
      "name" : "hWAczOeGg8",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6F6mvrRZlZyub7m6H2r18Z",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "a0aiGEVdfZ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3m1gFUyslkFyc3E42dECTb",
        "name" : "YS6VJdlpHN",
        "email" : "eOVeCkL0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6FSyejd8BjnATlnAiK8W25",
        "name" : "46G4ZLUOIs",
        "email" : "0gMsYzsk@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:19.799944Z",
      "updated_at" : "2026-09-10T07:27:19.799944Z"
    },
    "animal" : {
      "id" : "aml_5idWOUk31UyWUuHwpPs95g",
      "study_id" : "sdy_4VilvsMMvMwNo5NdxEYrVE",
      "study_group_id" : "grp_15MO7236GFAoi9G60FbeDL",
      "cage_id" : "cge_MjVswaVuC5Mev1MHsh9Km",
      "catalog" : "A0000001",
      "name" : "KVf0DEewj9",
      "number" : 1,
      "strain" : "54C8HPcs9U",
      "species" : "5xe5BRgTsQ",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "dHkJMrlYdd",
      "ear" : "jS4xAtq0GN",
      "tag" : "scGrVTt7SD",
      "donor" : "gkwHz9Qhpr",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_3waMucmaieeFcPKZCcFEID",
        "name" : "p8AfAxXXtJ",
        "email" : "LNzNwYeA@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7BkVo9rlT4eSgTFX6u9d1L",
        "title" : "Found dead",
        "comment" : "jbShXwWQr3"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:20.226021Z",
      "updated_at" : "2026-09-10T07:27:20.226021Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_1QLgrMBnRGj1BEqMV9y43E",
      "name" : "pZ1Embr2h4",
      "email" : "kvlkfRsu@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "Tc0kL6tK2L" : "JubRfMv6Qj"
      },
      "created_at" : "2026-09-10T07:27:20.496049Z",
      "updated_at" : "2026-09-10T07:27:20.496049Z"
    },
    "created_at" : "2026-09-10T07:27:20.514811Z",
    "updated_at" : "2026-09-10T07:27:20.514811Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Species Resources

Species

This is an object representing a species. You can retrieve it to see the name.

Attributes

Path Type Description

id

String

The unique identifier of the species.

name

String

The name of the species.

created_at

String

The created timestamp of the species.

updated_at

String

The last updated timestamp of the species.

active

Boolean

The active status of the species.

Create a species

Authorization: Your API token must include at least one of the following scopes: species.create, species.*, *

Fields

Path Type Description

name

String

The name of the species.

active

Boolean

The active status of the species.

Request

POST /api/public/v1/species HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4ZmQyZjljZS1mZTg3LTQyODgtYTgxMi1mYjg0MjVlMDFlOTIiLCJqdGkiOiIwM2YxOTQ5YS01MmUwLTQ1ZDctOWZlMC1hZDk1MDgzZjA2NzUiLCJpYXQiOjE3ODkwMjUyMDQsIm5iZiI6MTc4OTAyNTIwNCwiZXhwIjoxNzg5MTExNjA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZSVTZtZDlSTTJlek5Qa1huQnE0WlYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.jl2Tw5tm6E7lTDZAYRKXOY4yPbxdoeVpUAPtgGDRFteRrXVnNoDymep4aQNMVpVdeBwnkDAdm9SRtyl_BNSVzWwGx4_L44S0RNL1yRl0mts-F_lq51bphoqt1vmWIO5fzH6Cpmu4KzwgXayO-Bi7m6GjHKFX5bpBpP0f3EGga5Bcc9iBIcDQ_DplvM2w8Uj4dR8UpYVHhE3dVZq7IRBmeaJbAIhKFFwfPlDxfKOWTXMCneHmMQ2aQftnRjHoMhdFlxMO_Rp7aJQsjDZ3qPsH6jRswfLPTN5NEyRc664r5ZZbg0vquUXz_50iagaD3kaJ2x8iaGAtlE33dC57Wan5llgTLUbigY5jDT7W98wXKvT12ohubOi1__21C7CpezRO4UjXkzzZYoEst_966sKO7tWLRin9iNIgFfb78FQWGpEcwf4bTtpVHXiMfMQqX4hxngo3Hp7BToP3xtMSoMW2Y3VDrbnk6HvNcFhHHz9V7Vpkm11_eyi8AtVllQKLx6Amdtfmud-4nkCVH4H8W4pntRQ51huK7avBWAWjBm0wv7ZxrLQiZ2-9Jfp62KzKUE97PpSRhieJ2pVBZ3Sw7CAcs5J40ZTgzIlxphRol5RXbjQaVYDBiGzO8YFf2WnPLPIgdlWequMTu5e3LJJ9b3isEXPLVPX41VGLgmM5KK7U97c
Content-Length: 46
Host: localhost:8080

{
  "name" : "op7dxqyyqz",
  "active" : true
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 16
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 181

{
  "id" : "spc_2JSYlr2gfNBLOwEcHhpZkF",
  "name" : "op7dxqyyqz",
  "active" : true,
  "created_at" : "2026-09-10T07:26:44.552582Z",
  "updated_at" : "2026-09-10T07:26:44.552582Z"
}

Retrieve a species

Retrieves the details of an existing species.

Authorization: Your API token must include at least one of the following scopes: species.read, species.*, *

Path parameters ./api/public/v1/species/{speciesId}

Parameter Description

speciesId

The unique identifier of the species.

Request

GET /api/public/v1/species/spc_5LmD1237mBBwJR03BHU21B HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ZTJjMTdjZS04NDAyLTQyYTEtYWZjMy1jMmM0MDNlNzY5OGQiLCJqdGkiOiI3MjljYTkxNy1kZjEzLTQxNTQtYjg4Mi0yNGMyZmYyZjc5MDQiLCJpYXQiOjE3ODkwMjUyMDQsIm5iZiI6MTc4OTAyNTIwNCwiZXhwIjoxNzg5MTExNjA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZSUWdHekIyZVNIVUlWSGNwQXFMVUYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.KAJLQB24OyQyeOE9JS6jyR425oaOMVcCJsNFxanO9-awhpb7tUHoLL1NDFr26dPAtk2qzOrpP799Xi-AeGrQefR-_MnMqy6-Lxop127-WCYDJ-ZKthoBQGQgF6AMBI0DGznWARIthrWJrlJaoAtFsuV8tOxW0jWEB0vhMT6_6p2eaofkIDyOUA0br9E8Zj2s3A7aTkLvXW9EmslHtBxoOmanhT4PoBNh9uEnytri1N1c_CtJiVoBUYOEIRfRyBKlgv4U2WFm7WCeM8321kVlXL2Hhmi5Q9C968xBrePAHGWXi6ycbwvma8moMEyEwGqLQ5jv_zzfR2h6fGXZ2mifk7_3N4IU2pwwifo-xXqZqIV5EexW42V44NkFybCEdpGHAZrc5uEBD_jjLdzzbkSH-evU67s2RPHNeAOh_Xsw_zVFKHTvXFi9jsNfKEVyafmJUc20RlEHvs5YUXqnIjP58McJcaMhto8geZSNAKe1mf62YbgeGsTXhxGlb5sKxrxOIal8XmFtS62nyJk9EOL1eg4OQ5LGteIEHsQTkpsO378kLBusmWNG95pxfdA_t0IieIZ1gURD3aEuEbfjzk62RCQdkxkcRZNEIBVNBATeJzEkkOdblchg7oUi2LrS8-Dc5X3-GKaIvx9YaA8i8oPiglwvktNiOt753DkveeZMAKs
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 16
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 181

{
  "id" : "spc_5LmD1237mBBwJR03BHU21B",
  "name" : "pDWePPWTEE",
  "active" : true,
  "created_at" : "2026-09-10T07:26:44.646234Z",
  "updated_at" : "2026-09-10T07:26:44.646234Z"
}

Update a species

Updates the specified species by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: species.update, species.*, *

Path parameters ./api/public/v1/species/{speciesId}

Parameter Description

speciesId

The unique identifier of the species.

Fields

Path Type Description

name

String

The name of the species.

active

Boolean

The active status of the species.

Request

PATCH /api/public/v1/species/spc_5XebbE7DIWTzQ1xR9vrKTS HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MzA3MDc2MS05MTRhLTQ1NDQtOTlhYi04NzZjNzIxNGI1MDQiLCJqdGkiOiIxMDg1MjE2Yy0yNTgxLTQ2ZjUtOTI1ZS00YjNlOGI0YjViMDMiLCJpYXQiOjE3ODkwMjUyMDUsIm5iZiI6MTc4OTAyNTIwNSwiZXhwIjoxNzg5MTExNjA1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzV2U2RFQkpJWjVSU2VKYnhtQktVOTQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.asSmItV6QJjDiKbNRn2O5VH-1TonvZkO6S4f78YXqx0x9cmiz3dTi65IIbkMzLp7BmZwabipayHuMAcxoHVu5HHxDjof1AcYwCMuMSsdlc8gEw5YxXNUCXsB3z9HjZCJEcG5OWjAyBm_iVDQWBM_UD2pWTH_Dyqp_kN02HCTEu4xP4voXAz0_GoP3NSWgpqMb8jVuXcE9YY6v4bX7nK6dtWDwWN7U5IV8xw4ZfskRDmdbRIDD2mQqJhCikjAYgVZ0QpDiEQNPVVsLBrm_Fv_47b6YJFocnpwxaiwChF0W-ee1LNi-kg0QIUtfGJ_o7sqpbWWjdmSp_vBa23F6uO4seQQLHdMVhMvyBB0To9u84E_D0z_2a0OduII78mmqb5ovzwAtetkXItkNVbKdxL95GaJ9FUwUiCNSv46kBYuc9LNt5YRJXBvsRS2ZDmQuO-m6mx5KB0gnlssZjxOwjxQqfv01edsUTHc55NMYQb6zeEzM--Y0mXE6w1gn49hayaCws0rYO91TL8KJTmT431Mi2XuhEMvF2GHoTsAAKp8gTwTSNV2XtHs8acjTuyPBQ89Qn-gc9JJtCkMVbxKmQCJ0IUviwBng2CZfwZ4NZlF9fEnYqGPx49fH5CSQXQcqXQ8hplbMqs14zMI3wJqlbAQciX-ErwBe5FU6jeZp55H9r4
Content-Length: 61
Host: localhost:8080

{
  "name" : "Benchling In Vivo Species",
  "active" : true
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 196

{
  "id" : "spc_5XebbE7DIWTzQ1xR9vrKTS",
  "name" : "Benchling In Vivo Species",
  "active" : true,
  "created_at" : "2026-09-10T07:26:42.047068Z",
  "updated_at" : "2026-09-10T07:26:45.352452Z"
}

List all species

Returns a list of your species.

Authorization: Your API token must include at least one of the following scopes: species.read, species.*, *

Query parameters

Parameter Description

perPage

The number of species to return per page.

page

The page of species to return.

name

Filter species to return by name.

Request

GET /api/public/v1/species HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MTRkNTVlYy1jZmVhLTRhNTQtODg4ZC02Mzk4OTMyZDBhNDciLCJqdGkiOiIxNWE5YzgzMS1hMjA3LTQ4NDktYjEzZS1lNGY1ODZjYWQxY2UiLCJpYXQiOjE3ODkwMjUyMDAsIm5iZiI6MTc4OTAyNTIwMCwiZXhwIjoxNzg5MTExNjAwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNQb29SdllGZTJnak9SY05GU1NpSlAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mWkF9rUdT7Z-z-pRWfT4f0tPwOugYBBQwoodcaJpN83OVAC7Do018Fcp1mm5Cuz9T8gF7DonsU75eAeDq1xYNoK42XpnOZn50jdDYO-QBSonQwWCXziwDYgJ1hMpOguE7oYmPoN2_lU0UbvAXhSLZhoL6yA3obZEImPN_jr0_7MeGOSaw3eoI2J56CAsP3u13HTrwlnvS3J5H_03pj11qCQbWlyxEAiCqdXFpy8Xfw7SboTNIgLhIDPzomCcSEWI0dV4DM99i3JVbB7SY3T3CAZHfr_xGEotol9z5fNESHz5BHnwXh8OcLU2n_E2aS8gRHknycn8Ui28dpgcNc1iSR3G_VXEy6zZyExhZ5UCvIl-b2dp6RGfFlQMdXcFqOG_wi6bzuCxn5u_cbhvPX9aCt1ilOyeTAgivncXy4uA8mBp6Q5m44DVCHchA82w_baeUz_PsIyLopIeCP355tbiRxTLT9gCY4YvUAu4YUgVKCUumVIj61VJcpK2cM_plTAsdtosnqiRV6UL46X0Xjv9jc1oPz-Rn7ZDoH72LMQ6VP9H4N9gj6pGBPfHxaHChuUnga8ezjpqRmGqi633bUQVdnugLKTlXZGC1QLFss23LrFFV7Jiq7II09IINd3GMC3WHtm7NwevuM-oM_mfg435msq5j3dhjKx6ZFiQmdxlFR8
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 593

{
  "data" : [ {
    "id" : "spc_3iRywQPmmipJXDZdOXf5WJ",
    "name" : "HUTFPPryw2",
    "active" : true,
    "created_at" : "2026-09-10T07:26:40.165656Z",
    "updated_at" : "2026-09-10T07:26:40.165656Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/species?page=1",
    "last" : "http://localhost:8080/api/public/v1/species?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/species",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Strain Resources

Strain

This is an object representing a strain. You can retrieve it to see the name and species of the strain.

Attributes

Path Type Description

id

String

The unique identifier of the strain.

name

String

The name of the strain.

species

Object

The species of the strain.

created_at

String

The created timestamp of the strain.

updated_at

String

The last updated timestamp of the strain.

active

Boolean

The active status of the strain.

Create a strain

Authorization: Your API token must include at least one of the following scopes: strain.create, strain.*, *

Fields

Path Type Description

name

String

The name of the strain.

speciesId

String

The unique identifier of the species the strain belongs to.

active

Boolean

The active status of the strain.

Request

POST /api/public/v1/strains HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMTc2NzhmYS03YTY3LTRlZjQtODNhNS0wMGRhOGQ1Zjk0M2IiLCJqdGkiOiI3NzYyNGY2NC1kM2Q5LTQxYjktYTdmNi0xOTczZjM5MjlmZGUiLCJpYXQiOjE3ODkwMjUyODcsIm5iZiI6MTc4OTAyNTI4NywiZXhwIjoxNzg5MTExNjg3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzMzZnZyNlFqakp5VVFzZjZFWmhVWnIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZdiZse4t2dTfDDJ81XROON_IBrSQ6TAMj6KNJVn_taTI0c4EhEljcgQhKepfNqXfLzHtMFAoSf7lZ0TdTM5o2g_I3_iP6c5T-MoAd5BRU7F--84lt_ROkR47LvpZA0kQ2YF2Ikx7GNzu_AZ6XpwZu5-DW0LOaS5hj7YjUxHDh2A5mo_S-WxIKk6TaHab8XqLJ46d9lBnWESjGf04-kaEeq0m6CR1OezMv7l2NbPgGwcx167zO75KyuGcPb9HJzIQILRh7UMyZ-XvM9sh-K2jO81JOJFkVwD74UZhZZGnJwWM7cVCR-VpTNyI3Xm4wWbwYX3OyWXU4IxILNwAwkSPD9H-3BIi71CbOmywxM5OwTMZlW8lta8VsX7uLxIvXGE1HbIyRLI1EJo9kTFccCZLkcaxXaZqYyi_S-OJUWALn_WUTyo4x3Pmo1BLgiI1OYGx0-HXKV4OYTKEMcRdHiCi0xaI-taKDZdbnOFTwOTHV3u8oppvKzGT1dKT8drMeRkgXl-Nw4XE0_gUWpLpFiiYrkhvjHAKyN80GCQUOsz3jF8RL-p5gqaR7EXOhUmMDVlo45uIU8ZlrlGOauYElJQgA9j8StJkezhmZbI4HO2EXzL6EV4JVXmOgpFrgdRbfn2frYY0YnPdVCXz8VYDWxai9cCre8PhTa6lupWN1hCkLZM
Content-Length: 92
Host: localhost:8080

{
  "name" : "X0MOZWa7nE",
  "speciesId" : "spc_5cy6ZS98QE0dNCkeQheCSs",
  "active" : true
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 390

{
  "id" : "stn_2FPGoXTfQPfyCzdCrJ4dwL",
  "name" : "X0MOZWa7nE",
  "species" : {
    "id" : "spc_5cy6ZS98QE0dNCkeQheCSs",
    "name" : "tdSccs1D8F",
    "active" : true,
    "created_at" : "2026-09-10T07:28:07.386569Z",
    "updated_at" : "2026-09-10T07:28:07.386569Z"
  },
  "active" : true,
  "created_at" : "2026-09-10T07:28:07.409782Z",
  "updated_at" : "2026-09-10T07:28:07.409782Z"
}

Retrieve a strain

Retrieves the details of an existing strain.

Authorization: Your API token must include at least one of the following scopes: strain.read, strain.*, *

Path parameters

Table 1. /api/public/v1/strains/{strainId}
Parameter Description

strainId

The unique identifier of the strain.

Request

GET /api/public/v1/strains/stn_5pHrO1xatW2HJnEVC57SZk HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMjQwNzU1ZC1jNjNiLTRhZjAtYWI2ZC0wZDUzM2VlODMzOTkiLCJqdGkiOiJmYTI5ZTM0YS0zMWMwLTQxYTUtOGZhNy03MzJlOWE0NzNhNjEiLCJpYXQiOjE3ODkwMjUyODYsIm5iZiI6MTc4OTAyNTI4NiwiZXhwIjoxNzg5MTExNjg2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNha0tmUDVqb0dPOXprZzVCTHV4OUoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GNyo8oS5Ptoc_I1mYQgHjASHDZno6-hOE400VHjU963aAnfnlzvsO0ipxOQNhvKGQGIwkKvVpb2SQ4zcR0fQCZEdYDl27jaAdtnULyvohxvX7RH4EAuiP3VS-3vNa1PTo0Fh6Aj8IzJgpx_XMB4rOh2flQR6AueXG_Px6cnzLNxNoFp-x51rKcA9pPtepLnzd_4skXyET2B5-4lTZoiZfUUyYK3PyqixAkCXmMQFXfw-tgqJvYcpjPPoIjnCz-6vQtPWh_4RFJdmhDvHG1XBLLMrnQN3bszuJ0b-LwADY1sXuHfzBowXt8Po61zl17cg53GqV14ZWF8lgvAOU1-2eMX6_X2vDJfs_fGF1rolxp7ynWwytm0wkcCis2kBvdd3-ifGFQekU9y2FASUpU1NteCuH5AcOuu3M_KYDeZPuoq3mYfMg_Bxh2NZWeTFsBUAxDYW0nRlz6IrVFqYTMJtoc72iFTH9w4E-hrX62bXXIfb5qC0hA9HzQJYFON9Odi74xxTNZH1nbPfJiGvXaYwdbxn8MW3k1YRWdMlDvwHCRMRjAtVzM8UdRzj88bk4mlgbXfS_Lw2inLw6Qqy03l5r3tTlqPCf19nOehSdaLs23sNWhIyrGj4CJySy0R1Td4Gs_SastIEPwbrnFd_NhpNVp3AwIhX7-MhgrR-Jv8TLAM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 24
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 390

{
  "id" : "stn_5pHrO1xatW2HJnEVC57SZk",
  "name" : "RzKxpIGRfL",
  "species" : {
    "id" : "spc_7PG8zobxeBI881I48Dm0xm",
    "name" : "gS9uVhMYIk",
    "active" : true,
    "created_at" : "2026-09-10T07:28:06.190444Z",
    "updated_at" : "2026-09-10T07:28:06.190444Z"
  },
  "active" : true,
  "created_at" : "2026-09-10T07:28:06.194435Z",
  "updated_at" : "2026-09-10T07:28:06.194435Z"
}

Update a strain

Updates the specified strain by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: strain.update, strain.*, *

Path parameters ./api/public/v1/strains/{strainId}

Parameter Description

strainId

The unique identifier of the strain.

Fields

Path Type Description

name

String

The name of the strain.

active

Boolean

The active status of the strain.

Request

PATCH /api/public/v1/strains/stn_2Ug7YHVhBlSR2Ifdv2D7rW HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkOThiZWM2NS02Y2ZkLTRjNWMtOWMzNi0xNDk5ZmQ3YWY5ODkiLCJqdGkiOiJlMTkxYzk3Ni00ZDQ0LTQ3YjMtOTYzNS1kNWE3MDc3MTBjY2QiLCJpYXQiOjE3ODkwMjUyODcsIm5iZiI6MTc4OTAyNTI4NywiZXhwIjoxNzg5MTExNjg3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFjQUZiWVZ0cGFiU1pzeE1vQ29YUmsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LKybGZmaCxEdB5L3Lh1t_iEEVugychR4DzUkMsmGTlwrTysNjXyCQPSQfEMHFZ4dPe61mdU9m4D94sxDEK6mlKMU7fahHBVkgD-QfH5scqVQfsjaTCrUfABr2DtYPvBPD0mgmISdHzQx68xqSNeRWCqxNyQAyOk68QkdVzbFApK0d12OxDrQyu3ra-ISBBqQmTlBNV5U8qj9xLIOZ9eBV5FdOpeXBy-viqmZCa2wVVPhJq9aRMZ4-Wh3uNOsQmercVtQjTMoDU7Q0Lh5eT01JhWxx2cyrTx7V-hc38cNO7Z_laWETm0paNnT0wiC1wavGOgUL1Lwab2HzEkQVtm1uirWYwuby_xP50kt9ZjkmfzHXNdhmzAR4KIxFfpoPvkeeF6ztgbC7kkuFJLYeKA_4mjH44zcKP4AoV1_K8Wyjq5xBlbq8SmwB54FJ6vdl30sSfITOlCHPnAySaMZUrs5GxhiiPnroQPs9HT3A-ADi-qWaVKKr94XOpyNe0rZiRuQkUlJaLsHp9xRfRc2v2aVeC8NnUArnmcojOWuoutQjVbKuWgPpAMDOkC3iylwoMmlSlnqBqckyjucNHwbXE0iesod67_UotaiUJsPDzpvAcNze9znCQaDqDTIKrcjIS8DokQomp6bd5L9edKpysddOKGplfN4nuWZY6BeJywv4LM
Content-Length: 60
Host: localhost:8080

{
  "name" : "Benchling In Vivo Strain",
  "active" : true
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 403

{
  "id" : "stn_2Ug7YHVhBlSR2Ifdv2D7rW",
  "name" : "Benchling In Vivo Strain",
  "species" : {
    "id" : "spc_zRgvHuxREn0wvGeHQwq4L",
    "name" : "4TVUlH3NrP",
    "active" : true,
    "created_at" : "2026-09-10T07:28:07.448205Z",
    "updated_at" : "2026-09-10T07:28:07.448205Z"
  },
  "active" : true,
  "created_at" : "2026-09-10T07:28:04.451043Z",
  "updated_at" : "2026-09-10T07:28:07.501005Z"
}

List all strains

Returns a list of your strains.

Authorization: Your API token must include at least one of the following scopes: strain.read, strain.*, *

Query parameters

Parameter Description

perPage

The number of strains to return per page.

page

The page of strains to return.

name

Filter strains to return by name.

Request

GET /api/public/v1/strains HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2YmE5MDYyOS00MTZiLTRmNjgtODgyZC00NjdhNzkzNjM3ZjgiLCJqdGkiOiJlZDliYTRhZi04YzVhLTRmMDMtOGFkMS01MjRkNDA2ODE3MDIiLCJpYXQiOjE3ODkwMjUyODcsIm5iZiI6MTc4OTAyNTI4NywiZXhwIjoxNzg5MTExNjg3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1N1eHhtQ09ZRGtjdjBZUHdGOVFGNyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.TTNmPVGUPtVPZPFB_4P4A5LGewDV3LAjTha978jGmSuN5G3Ze8sICjLaKkrpkoA7lK2u49Tyu8Qq0UmGHbUPhxRFtJtyW4hbYkn8ZPAmUcJhAgztUdWNOhe8L4oAXK5CLpIBanTmhZCi_HMz33EDHbvRUojvnvJ4xXjaTIl-DENJlOWKkmEdX9x4Np3ew2ditxGnaI49sp5xP4Ditr96YUG6BfU0ISio0Mot-FewFc60_ENw_8YOTGY3PH8ENal0VioBejb_Ackou4IlFhsyLTUeF6UFyju8kQ7HTdgWdXoshleG6vWFJaXUbCOkkN-m6MYc5OXVvsjsgnR2bUbHiPhfKuLoxovAScuQNo5VbYKnLO6X0Ih9PqcTbMXgJ04HqM8_kf7vSf3lexrPcCMu3m3Vk5z1O5bf1lXWbqxflLBPpD9XXtZG21kN6pQuHWQZQjiSM_D9Q-7JHVdeKMHamvwO9m7mc9azv-A12ISFEDQJYZnobitF9w4IyskEgH2ApAHtyXwq37QcmT_JzHmgimA2VzliXgNG5xEpR6f-HbIz7Sd7W6R7M8GoKjDF9wngMxGvHlzV6XK-kCsEGIfNalMQNBTdKWBCL46rxkmV0dxFoyQovy5VvtGweTdLbxiH9Z6X0UScgxGFd5o9Z32IfnNvebRmS9rFwcMQ593FR7Y
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 815

{
  "data" : [ {
    "id" : "stn_74c3GEO2y2qpFAVqSFNpaT",
    "name" : "soXY1Khjri",
    "species" : {
      "id" : "spc_9C4rMLPrR8Hi3POElFczJ",
      "name" : "lKvC9ZkT48",
      "active" : true,
      "created_at" : "2026-09-10T07:28:07.562280Z",
      "updated_at" : "2026-09-10T07:28:07.562280Z"
    },
    "active" : true,
    "created_at" : "2026-09-10T07:28:07.565819Z",
    "updated_at" : "2026-09-10T07:28:07.565819Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/strains?page=1",
    "last" : "http://localhost:8080/api/public/v1/strains?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/strains",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Code Resources [BETA]

Study Code

This is an object representing a study code. Study codes are used to categorize and label studies within your tenant.

Attributes

Path Type Description

id

String

The unique identifier of the study code.

title

String

The title of the study code.

created_at

String

The created timestamp of the study code.

updated_at

String

The last updated timestamp of the study code.

Retrieve a study code

Retrieves the details of an existing study code.

Authorization: Your API token must include at least one of the following scopes: study_code.read, study_code.*, *

Path parameters ./api/public/v1-beta/study-codes/{studyCodeId}

Parameter Description

studyCodeId

The unique identifier of the study code.

Request

GET /api/public/v1-beta/study-codes/sdc_5j5Sf7IuetpxlhH52JIA6g HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlNzQ3M2Y4OC1jNDY3LTRlZDktYTQ0OS05MjU4NTdhZTUxY2UiLCJqdGkiOiIxNmY2MjZkNi00YjQwLTQ1MzktYWQwZC0xOTU2NjlmNzlhMmQiLCJpYXQiOjE3ODkwMjUyNTYsIm5iZiI6MTc4OTAyNTI1NiwiZXhwIjoxNzg5MTExNjU2LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMUNCdlZOMDI1QU5RMmdSVGlEd2ZvQyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.UM2HuY1Cy7g7r8ZaFK4_GUJQ230F39MFKyo6E3EfEaYw7x6yiUSrH1WV4Wtjr8nh_PyFnSGRGqF_Gpsed7eDRfLUos8h1kAg4WxZe5lj5aJUqoOSNuyzjqEZbRlEsZUuhLe16SeanVfQ9htHBIBwcO33W8jLRqLhce4z5i1am8T-HWPaQIdEucCgHeOequ_xBgHeK0XHYQOzIrOYdwW1rErIIF-gPrX7jXoD8N0_3pV8WKzFI7BZucu2Pkfy_rXRT7fCqeDMJgrO4Ck_bwFRNQArIrFLjE7sePnJFDPkqh66CyAeP2MhmwrK_4Qa6X2K2LH-rlb2CC7jhFY29I2PbRY0MKN0mOXoIWfJ2fEukGKHoMqJtUvKSCQfPHeyD3sraTuQdIjqMJc46qsxoKOMTf78_k4-J4cTXuOnomRS3p6du1TrT_pVLLKC9Sdwd5iSCSCXJWOOR8fWg5QYwDHo4Tf_nT-UtCX1e26zX084uk3DqzEWmbAGHTssUQ3oZewH-5V-KYV8y45eAl32QT2tMYWBmKKXOL_GPNUT9CWKIbQJwbWHT6WlGFRNjD_UsfWrKy2TE13TYEHzVTd1bIqQEglc9c-qzIXwdFxS13tiCg2b0aCRTksyQGS0M9AhJCbzF2cekRG8RlxUpLSzNaZri2nlmY3c-pthzkklG3yiYys
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 24
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 162

{
  "id" : "sdc_5j5Sf7IuetpxlhH52JIA6g",
  "title" : "test code",
  "created_at" : "2026-09-10T07:27:36.340971Z",
  "updated_at" : "2026-09-10T07:27:36.342208Z"
}

List all study codes

Returns a list of tenant study codes.

Authorization: Your API token must include at least one of the following scopes: study_code.read, study_code.*, *

Query parameters

Parameter Description

perPage

The number of study codes to return per page.

page

The page of study codes to return.

Request

GET /api/public/v1-beta/study-codes HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0M2JmMjg5ZC03ZTFhLTQ1Y2YtYmFjZC05MmJiOWM3MWNjMzMiLCJqdGkiOiI4NzZiYzM1OS0yZTNhLTQ1MWQtYmZjNC02YWYwYWUzNzFjOWIiLCJpYXQiOjE3ODkwMjUyNTcsIm5iZiI6MTc4OTAyNTI1NywiZXhwIjoxNzg5MTExNjU3LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMzB2VnB5bVZscjFZdnlyRks0WTBBcSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.MhXKvfdnqkDsDV5GOMo4P7vSAk1BgOfrPb4cA5CilOQcPfr5WOOsRYmXKEyOufxeyKFxHhIVUoPycinut-QxD9za4cD3Uk4Aw-VWaAK-lvi65sr37-SUaU8EHgCgIcZ3mDgrIpVNoN0EWkz0HjV9BdiV7kSJ8-FUrAtSOVSuegISWjQ-K0ZmHo4twfxBLXeq5ID1Z653JTObLRc_bNQogaoE5iqeWhZRRqlOG8omsL9wKCkx4TMlkSuD25rx2l1InNAaNkoeMMzAwzwvJ30QEKw2o_1BxgNfYn1A6wsy1k60dxBn6LIH9FlKo3q8ZNDEF6to7wtVcDZnkZTNe6F-yhx85yzz98QtnVtEh_fOPz5S4JDYQbxIKM-Ddc85y0KuWMh5z2nxlWy-2wng_mr0DMIVvk2NlRISWxF21zaYFTSpFGPiq7-9yBbURN6xClFgYSTcRIMxNIwLaSSaDpVFZccoRZ_SbT-sDTMqA4Ky08jgbjulumqhBgd2383tPYVpRv453QbAphj4PO7mw7yeYs01ldShMHBvBacCGY5089eldMWVbKpJaujiMaBr-pybyUADYGCwooYYaDgEJX7sE_VVXgSq828Wpdi9u9Qr_xXMENGMzLiE95t8RhuZubGYKe76KaTNoSymDmnmxaBRB0b8mdCt26KnfoywpoFPYL8
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 599

{
  "data" : [ {
    "id" : "sdc_5BW69UQ0SyVKt9GYI8Xg0X",
    "title" : "test code",
    "created_at" : "2026-09-10T07:27:37.242576Z",
    "updated_at" : "2026-09-10T07:27:37.245488Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/study-codes?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/study-codes?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1-beta/study-codes",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Resources

Study

This is an object representing a study conducted in your facility by your team. You can retrieve it to see the name, the study design, notes, average calculation for treatment groups, if it’s internal or externally conducted and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the study.

name

String

The name of the study.

code

String

The code of the study.

study_code_id

String

The unique identifier of the study code template.

type

String

The type of the study.

started_on

String

The start date of the study.

status

String

The status of the study.

description

String

The description of the study.

timezone

String

The timezone of the study.

metadata

Object

The metadata associated to the study.

author

Object

The author of the study.

owner

Object

The owner of the study.

project

Object

The project of the study.

tracking_day_base

Number

The tracking day base of the study.

completed_at

String

The completed timestamp of the study.

canceled_at

String

The canceled timestamp of the study.

created_at

String

The created timestamp of the study.

updated_at

String

The last updated timestamp of the study.

Create a study

Authorization: Your API token must include at least one of the following scopes: study.create, study.*, *

Fields

Path Type Description

name

String

The name of the study.

type

String

The type of the study.

study_code_id

String

The unique identifier of the study code.

started_on

String

The start date of the study.

project_id

String

The project of the study.

timezone

String

The timezone of the study.

author_id

String

The author of the study.

owner_id

String

The owner of the study.

team

Array

The team of the study.

metadata

Object

The metadata associated to the study.

Request

POST /api/public/v1/studies HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxYTg5NzY3ZS1mMzQ0LTQxMzAtYTU5My0wYjRkNmFjYmFlNWQiLCJqdGkiOiIyMWYzMGQxOS1lNzI5LTQxM2ItYTNiYy03NDUyMjRmMDEyMTQiLCJpYXQiOjE3ODkwMjUyNTYsIm5iZiI6MTc4OTAyNTI1NiwiZXhwIjoxNzg5MTExNjU2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQzQTFrenIxUGNWVVpPTjRXZEZtcTIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.P5iz2cUFBB0aZmbebMJFoNNaQ7xnvmGHEeQUcgT4_vFRHiYS_NLPbkQaFNHizGUn9Vu4EafIwDXHFe8XYSwXZvZxwoxtRru7FYQu8lJWevvGiCQ5iDFPRQVDoFKNKTMya4TgLvIlNTLtJH4c4QUt08lNZPriBlu6acKKf8-PEpxYxyU1Ml48taEp2GuAfcGZIUd_S3JgNKjYzLymnabUptp452ApbeKSYmiXi_IQl3miIbDNyVL5mhiHnl8kXVD8IedLjG113QwoCwZCGLPs-xKNk1k3RBVMidBQYAlXO04MeM-ah5to0_nZiam1IvVtBmKLm8HEHHUrugXTtwfmF_pfafCKSRSAoGzewlNVX9XHHzyLYICo2LJ_Jh4htLLsjp1AFAOYsSt3Ytbt2JeUiiopAYUGoSW7IHv4xdCkLcD8cccmlecYWiVPoOYlzoiiN2p5A2n0bX4dgVBJjznUSJr-MCNyKL2nHyPLXtX2Q51ajT_OOg0XIRlBaB3xAKzj3jq9iEBYvkIXlZNalsGSaEj355-aW5JjzuJHpOoIHqcVe90icb4bPK99ivwy-PyNmgua1gvKcVwc7XAuGW0RSfVMSSLG1mqunaX0lca9rC6AZBdmLQBoeTIcBa72siTze82t1Y7alJw8oHWONuuzMURMnFaeRcTSsezEbzocd0M
Content-Length: 457
Host: localhost:8080

{
  "name" : "xfI2aPzR3i",
  "type" : "internal",
  "study_code_id" : "sdc_33Q7XeQBvoWCmLvp0GQMAZ",
  "started_on" : "2026-09-10",
  "project_id" : "pjt_1LPWY9mcDvDC5WdgVSmDKf",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author_id" : "usr_7Pi5ANAIdJIbSv9NKJkDFJ",
  "owner_id" : "usr_nkMxV0lNZWyoFW7cTVITs",
  "team" : [ {
    "user_id" : "usr_1Ua2eIYdPOlapHRHmg4rKQ",
    "access" : "read"
  } ],
  "timezone" : "America/Los_Angeles"
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1272

{
  "id" : "sdy_2ZUauGsBJi626n6rOg7dzv",
  "name" : "xfI2aPzR3i",
  "code" : "OW-SQ1-26-F",
  "study_code_id" : "sdc_33Q7XeQBvoWCmLvp0GQMAZ",
  "type" : "internal",
  "status" : "in_progress",
  "description" : null,
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_7Pi5ANAIdJIbSv9NKJkDFJ",
    "name" : "EfaNRbK8GA",
    "email" : "sNNI9fSC@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_nkMxV0lNZWyoFW7cTVITs",
    "name" : "0Yf7qQqA7e",
    "email" : "hyQEXSG4@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_1LPWY9mcDvDC5WdgVSmDKf",
    "name" : "n4FCdCMHXX",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:36.587472Z",
    "updated_at" : "2026-09-10T07:27:36.587472Z"
  },
  "timezone" : "America/Los_Angeles",
  "team" : [ {
    "id" : "usr_1Ua2eIYdPOlapHRHmg4rKQ",
    "name" : "Cq1tPwpoHe",
    "email" : "1ECzTix2@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read"
  } ],
  "started_on" : "2026-09-10",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-09-10T07:27:37.051745Z",
  "updated_at" : "2026-09-10T07:27:37.051745Z"
}

Retrieve a study

Retrieves the details of an existing study. You need only supply the unique user identifier that was returned upon study creation.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}

Parameter Description

studyId

The unique identifier of the study.

Request

GET /api/public/v1/studies/sdy_6y9Wop1uArRjD93UiQ5qFy HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2OWVkMTRhNC1mMzhhLTRmODctYjIwYy00NTExNGU0NTEzZTQiLCJqdGkiOiJlYTJhOGI1Ny0yODUxLTQ2Y2MtODc4OS04Y2RlYTI2M2Y4Y2YiLCJpYXQiOjE3ODkwMjUyNTQsIm5iZiI6MTc4OTAyNTI1NCwiZXhwIjoxNzg5MTExNjU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRlWlNJdGhYdnhzOTZTa09EcFdtdm0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.J6EEm5e7DaV5OIvyOOVDdTVXLCZGyuIp9Rnt4lNvRKkwzLVmVdoh3reSX1f3lVJdSiuPl2xJSIkihq9JAIfvrTcmhEsoMe70gHi38NjEpvWPCnYO24Ne-58AEmpiR44yuPqSpIjr-Inb4Hte7tMv9RTFWPUbXcf0_tZTxt4QMqAuBN0fefsJZPPljs_ZvmKEKZseSOWdSVX-CnJdb81nxtj-rs3eoWQEDISyQpXqNTyzjz__K5rn4tr1VVaMG30R249xv8Oh-vTNUg_1SHfwC53vJeh0s0l_RKcpi88yPU-37WGMu4RmqSrhAZs6FcCtEUObgTcK3ocGIWP9E_wlGUVz3Wk7_NVgn-hW2pdG7HfPNgbVFMGR_v0onveTrwPWfuqWq_tKDM0zN3_aPOmQgRBOecTXovRnBZOyG1ptOYIyUUjBop_khaGzUUuqj-dVsY2gE6Wj1wq2OtIsxpDAkbNazrq0JAzVAxOgX43yeJUejxcow1FDpzn2VZs5D9VUvcpjblmxp3Uq6E3eVnIWWCJuQAM2JTGgmFtSqbsIr46nemU41cpKBbM58qI-15KsLHHhEWxzVM0AhdLO5UQRKvVZDGJ0jzHMLJ_ykixVs6GySx9LxulsB8gDRE2EVgjxmQVSt0SqJlbWPw_tN-JGixy6HnqzagXsNagoKCfzzDY
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1081

{
  "id" : "sdy_6y9Wop1uArRjD93UiQ5qFy",
  "name" : "qSUBZIuhVy",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_n6vkWmmHoACZ15pTxztHk",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "sePqKaR4Y5",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_72aeLmlraBB7Ekzu2zTsMW",
    "name" : "4BKReh7wvq",
    "email" : "tMw81mKc@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_5TSgutt2ZHPnKOdYbaNlRo",
    "name" : "BVBDC4qYgB",
    "email" : "QfA3vom2@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_7IrvD7jMtAGvBl4AQUUr3g",
    "name" : "cKgszfBLbB",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:34.118856Z",
    "updated_at" : "2026-09-10T07:27:34.118856Z"
  },
  "started_on" : "2026-09-10",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-09-10T07:27:34.132511Z",
  "updated_at" : "2026-09-10T07:27:34.132511Z"
}

Update a study

Updates the specified study by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

name

String

The name of the study.

project_id

String

The project of the study.

owner_id

String

The owner of the study.

team

Array

The team of the study.

metadata

Object

The metadata to be associated the study.

Request

PATCH /api/public/v1/studies/sdy_49isdOaXwlUEYkru0Qntb4 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZmRhZTU5My0wY2UxLTRhNjYtYWI2NC04MjU1NTBmOWIwNTciLCJqdGkiOiI1ZmZiMGU1NS1hYmJmLTQ0YTQtOGNlYS1kN2U5MzA3ZjFhMzIiLCJpYXQiOjE3ODkwMjUyMzUsIm5iZiI6MTc4OTAyNTIzNSwiZXhwIjoxNzg5MTExNjM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1NKemlSeXVpQjhEMTBjQWxNQ3ZyRiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.F8lUTCNdq5xeyzsty6yJ8m5CNI3Xuwb_3guxW2TzjaSYAvond5WkK85ylD72wCf6IE9NE-MK3RHSf2e97Q0T-yl5_AU7PZ8RMLFu80bNTkPDexSEWzOnv0uY38O4_xUnKqGv_pQsLzSXs-pSGYqFM_c-vpgTp6dXu08OADIjpiYLixscGprjQEBBwqN3TdwKIApOSQO9JX9Yk6Yy1-1UOa6sOc3rTg4IwfGInPc7wAOYZX0SsCdk4Y40HLFNjUTrKR07bGn69Yp8T2DUA4xFKCnBqvU1vBttbl5NVvcYijsd7cJhmE0CEq1Sor5EnphiPYmVlQWofgFCe5z0Q-3AXiuDbQOmNfVAhie0QLNS_zghGOcs5fHrtwjz4asIpT0RE4dPL2OZYWDIXzxhCGT7X_nCi9dabReWKDe38Cghyj0s-Rxld4EGl0cCTHLSrZyRHEhl4xT0GITEBU6xXqZH-jYCOMiwFLadHgrJT7MRYBNwEcn4I4RIhrBzyANkELbTZhEzdHxqm7C_nn2oXBPKTB3JSgJ8R0WZtEC-sHoy_cGom0KvL8TsAB7Y-PDyYNaROV3v_5UtNn0gcjeAhVP0EpY-giPq4IXwdDnXHUTgNP13r6f_XtiH9FHy45_xmLnRssUYVvEuQgLzZiunC41gHnqfxy_DPFkW-KCMwTZ322g
Content-Length: 276
Host: localhost:8080

{
  "name" : "Benchling In Vivo",
  "project_id" : "pjt_19HC6tqwNmmuqq0l6AeXsB",
  "metadata" : {
    "study-internal-id" : "STUDY-4321"
  },
  "owner_id" : "usr_w7kzBCRf3B1DwDcUQoGaF",
  "team" : [ {
    "user_id" : "usr_2NZtgM0QCqwEdCGx9hMI7u",
    "access" : "read"
  } ]
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1096

{
  "id" : "sdy_49isdOaXwlUEYkru0Qntb4",
  "name" : "Benchling In Vivo",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_5I8xOuIrn637Bbrc5QxgUZ",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "fis1GOP6OX",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-4321"
  },
  "author" : {
    "id" : "usr_2B90FAZZYabp6TfUdO13R6",
    "name" : "jq7e6rJPGz",
    "email" : "XRUQKjuw@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_w7kzBCRf3B1DwDcUQoGaF",
    "name" : "MyACt0bsX2",
    "email" : "Oow04V5U@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_19HC6tqwNmmuqq0l6AeXsB",
    "name" : "nCNbKPTkPk",
    "metadata" : {
      "project-internal-identifier" : "PROJ-1234"
    },
    "created_at" : "2026-09-10T07:27:14.743025Z",
    "updated_at" : "2026-09-10T07:27:14.743025Z"
  },
  "started_on" : "2026-09-10",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-09-10T07:27:12.059116Z",
  "updated_at" : "2026-09-10T07:27:15.216241Z"
}

List all studies

Returns a list of your studies.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Query parameters

Parameter Description

perPage

The number of studies to return per page.

page

The page of studies to return.

code

Filter studies to return by code

metadata

Filter studies to return by metadata value

Request

GET /api/public/v1/studies HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMDA2NDFhNC0yODc2LTQ1MjEtOWUxNS01NWVhYThhZDU1YWEiLCJqdGkiOiIyZWE4ZTJhNS01MTU2LTQyODQtYmI2Yy0zMmNiYzQwYzY0M2EiLCJpYXQiOjE3ODkwMjUyNTUsIm5iZiI6MTc4OTAyNTI1NSwiZXhwIjoxNzg5MTExNjU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRQdHhmaDE3djlMZmRBU09LUFNoMEUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mGyCHgoYrfrvMkpmGi4WuhjCpA_9Tr8oWRdj6eXhryARtv6SIpr8yrugS41CsmKyEt1G8CSyK3ohzQqguPi6IpLk99WB4KWxNCvEnyaiT7VKyuKKGic0WH6ndPBpFF-3QUe2fft-4DKavEyQh8mjiG1aUQJUL3119HO_RC2gM1QVAz7jeZRs6bLqr9yhc9mqjiMa46R5oT5eBkUDjNkZF_3gkVS5bMXa8OG4Y-XZ9FdCSuSUiCpGd_ba_puqyWEumC9WwBgyQlHQ5P-PNLUsKXYRcTe5nUmSPKEGYsnMp3Xr6foZleZIDdnhGc2Dq-N1bnIGhwLlvRNXu9KAMC29wv0EXrouLD1PJvjz7Eud0xpweqedHxzrZ2DzIMs5yzoeVK6f12o1NH8huugmDFup1HZX1qo6rqRS3E32H33-uf1B90BBgyjCv8UmpnW05_ZLuRempUHTULp6BDdvU1X4bSDBaBcnFloUmwzu174_bH0dUpymNW916EkI56nYnSZwN5_U0nk1HBfMBIRhbSZ_Ew7sT01cTZR2ddKYn6pdjHwsqSzXa6hbHwe531DSb-RAWhFV1sgMIT96skG3tTfNoj32HFwAb_Y9riwH8Qta4y7UTNMqACv5eg_oq26fXubD7SOWW6BsyxWewZWM94T2_gLrBOhBqCMeaviBPjLXM5E
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 25
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1560

{
  "data" : [ {
    "id" : "sdy_7eiGDhepgq28SdVvC6VvtS",
    "name" : "iqjhdrKEx9",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7Y2jcksFS2KXpoaOkxDdhx",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "1JzSBcckPq",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7OkNjXFIpuECuy0pEd0bgA",
      "name" : "eNROq0LjLq",
      "email" : "L5Kh4uGO@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_41NlubiPKMzGtQ0wzLiu53",
      "name" : "IDZPiEnDt6",
      "email" : "LT8DLsSY@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_5wuuNi00IxVsow0Jc6VyX2",
      "name" : "sswPbDAvSr",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:27:34.910411Z",
      "updated_at" : "2026-09-10T07:27:34.910411Z"
    },
    "started_on" : "2026-09-10",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:34.921456Z",
    "updated_at" : "2026-09-10T07:27:34.921456Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Animal

This is an object representing an animal that has been enlisted in a study. You can retrieve it to see the status, date of birth, sex, species, strain, identifiers and treatment group of the animal.

Retrieve a study animal

Retrieves the details of an existing study animal.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

Request

GET /api/public/v1/studies/sdy_4J2srPX2di8ycsI1uW6hRe/animals/aml_11HK01AAkNuXzVCodHtwQQ HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMWE0NjJjNS1kYzMxLTRhYjYtYjVlNy00ZjhmMDMwYTM2YTkiLCJqdGkiOiJmZjYxZTBiOC1lMjg3LTRhZGEtYWViYi1hMjAyYWNhNWRiM2EiLCJpYXQiOjE3ODkwMjUyMzMsIm5iZiI6MTc4OTAyNTIzMywiZXhwIjoxNzg5MTExNjMzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQ1aWQ5RDUzQjdZWm9wdkFzRHJkQWgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.MhWw_XfTMN0RtDzO5qfiIGq1RYv-GY2QVmXQ4yNq_eYOhkbMhDitKQWMAQh2uvtGDc9C0s6rC3oYVOAkDMaJbW9RNPHKTxihckstod6slhO_IFXq9TrWG11i0afz7JnQVSgQRyBkyesbfWOo89z43jrMaUdq4-WBaCiSVKhekdN3_fgDKEq8aqb3U3Zty7BGUebVv249yR0fhmlHxINM5SdNCQPDSYIRw0JcFdNvNJKfZGJORfNU8hpPw2dmIgu47VWnYD45rchsLJkmr2s2uUatkBdZoI0GA9SQeyd8yCeQbDYN9nsRd_iPkcnMnFoS-Jg0cfFjknXiWk3-bykSzVn1did-y_UdwZpOH81CPaDcI2tmllBh-foLbvqvW9nEzsfzX4tW4q99usj1tBh52EODEKkFVHPDWp4lhN0DR9hUEQFhEFXfuyFipPxZSUhp4huUgO4CgLWsB-DMgSYBkzLDo_IAM5OYU_pOAyprIe6fhq7ClWW9yriRJvtOCjxlAbwNfMEHFNWq_LgLHg7crGi709RcF0krrqFwPzEaYIcvzrcDsnya8L68e53541hmLSagBClYJ0p33YHSRDW30T0LYd3c185ODGMIuek8fvDIgVbFfhNuUst81v-xWYDE3R2Z1oJYjyj9ajC3391hJL0GE68oK00IRMNDI4VTAuY
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2580

{
  "id" : "aml_11HK01AAkNuXzVCodHtwQQ",
  "catalog" : "A0000001",
  "name" : "qP1uGn0RO4",
  "number" : 1,
  "strain" : "jsBr9Dzh9e",
  "species" : "CxVJdsjp9W",
  "sex" : "m",
  "dob" : "2026-09-09",
  "tail" : "hloHq2Wpit",
  "ear" : "dPWH6M97Bx",
  "tag" : "eC8PCGOSY9",
  "donor" : "NNSGmA0eAc",
  "tracking_date" : "2026-09-10",
  "disease_induction_date" : "2026-09-10",
  "terminated_at" : "2026-09-10",
  "terminated_by" : {
    "id" : "usr_6AlpzKA1sYucTbkfewv1wZ",
    "name" : "2d23vz8L3S",
    "email" : "CZ0Luhqa@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_731FsNrsVsu0C5FwB4zi5y",
    "title" : "Found dead",
    "comment" : "px6emMcznt"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_4J2srPX2di8ycsI1uW6hRe",
    "project_id" : "pjt_5PDd9Ic21lXFKNsuxYdxba",
    "name" : "EJE5L3FxjY",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2fGxHAppJJa2Kqf6KGbcDr",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "wOoWCHbXrP",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_40jDyK04XqjlW2eaR9MMLJ",
      "name" : "HXCT1aucDI",
      "email" : "hzs2oxXH@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3gXNZjlQkI5HlLxI6KQdsK",
      "name" : "s0SRt9hT95",
      "email" : "6FXIpDSu@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:13.063207Z",
    "updated_at" : "2026-09-10T07:27:13.063207Z"
  },
  "study_group" : {
    "id" : "grp_hLfRaOdv7zEJcEKT4FOdy",
    "study_id" : "sdy_4J2srPX2di8ycsI1uW6hRe",
    "name" : "koGxjmqTNs",
    "no" : 1099861703,
    "color" : "59Ux8sLuCC",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-09-10T07:27:13.382799Z",
    "updated_at" : "2026-09-10T07:27:13.382799Z"
  },
  "cage" : {
    "id" : "cge_7gzPytaSa5570o7CXxqC15",
    "study_id" : "sdy_4J2srPX2di8ycsI1uW6hRe",
    "name" : "TrxO91UPiQ",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-09-10T07:27:13.364007Z",
    "updated_at" : "2026-09-10T07:27:13.364007Z"
  },
  "created_at" : "2026-09-10T07:27:13.394724Z",
  "updated_at" : "2026-09-10T07:27:13.394724Z"
}

List all study animals

Returns a list of your study animals.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of animals to return per page.

page

The page of animals to return.

name

Filter animals to return by name

cage_id

Filter animals to return by cage ID

study_group_id

Filter animals to return by study group ID

catalog

Filter animals to return by catalog

sex

Filter animals to return by sex

metadata

Filter animals to return by metadata value

Request

GET /api/public/v1/studies/sdy_49WbBLCbGqNT8QI0sM4kID/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjNzA2NGNiMy05YWY4LTQ4ODktYTVjOC1iZWRiZTczMWQ1ZWUiLCJqdGkiOiJmM2E4NGVlYy0wMzgwLTQxYzYtODYwNy0zZTg5ZmE2Mjg4MDciLCJpYXQiOjE3ODkwMjUyNDYsIm5iZiI6MTc4OTAyNTI0NiwiZXhwIjoxNzg5MTExNjQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzV0S3RDVkpDbDcxUlhHTEw5bHNyZFciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.MaO1XrsHOmFFzEVNv73lvEAEoM_ll9gcikeNfLyxPU8_y_OlGO90SlUFXK4ZiEdVk8iopeoIOOHcySIga1udTgzpoNJlJ5AkvhdqCzvSxcIDxJ997Oz2M9v2b0NOmkGdds_U4JsMgYfQpiMBby6oZrnP6If_MOXyCtslraf_UsHpS8kRWc_lPv6gLnFN5Osw8INKB3zfg6VhBrTtexCMqVdxZKRxsiQXXT4XwW7_eUGk2neD45vE0-xTJKeQZR1ZIgYdA-6xf3o_M4k5GxExeA0xAr9zSmC2UT5g6tkBkOFQnNRf-9nKFD-b6bFB_wHCQwVD2g8h7ZCs-QD6XqD696ThweMx23bA8pgJdf7AkM6Z5ryvOV_Ayvo9xBU3ZwhtTZ3YRodud2HtPEAaqCm2TTHrXq6a8HsGh6FWF75DCClmK7u8KiXSFxHiQ19uAopGthLBrjWRPeWWX1amYx1yUDvqDgUXq34pEwzAZaXywdOqmtRWvJxNOzJI5VFirlbBBbQ-t9sGxsR3-T_YiH8-O37wJrZ-DxBw2xJLvQnHCmh0BR7qDMyDOB0cG59PgAHbZe_WClb6zYii_1VPMkNFSvE_MBWaaY7bHVpL0wACpDERFvx9GRM46Ex2nVUu0KI1rf56T2m6surG-eMrBRQ3TwUeDMYJw9akDNc2axpbnto
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3265

{
  "data" : [ {
    "id" : "aml_6gsk2xlzPdshPVBYsERC5b",
    "catalog" : "A0000001",
    "name" : "IyxYlyFYCF",
    "number" : 1,
    "strain" : "qt6jHba8tx",
    "species" : "skrqmqHjtj",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "40RUi0vG8k",
    "ear" : "5oHoSz8Rtt",
    "tag" : "7NVxn2tRDF",
    "donor" : "CBASMh2b3v",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_3JzvG33UoFY6DvxtfEb8qn",
      "name" : "DAmvrPnkBY",
      "email" : "9yx1pgxr@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5PcmFmizkviXNRgNlhy701",
      "title" : "Found dead",
      "comment" : "5T0GhxUQRQ"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_49WbBLCbGqNT8QI0sM4kID",
      "project_id" : "pjt_2OlQ30pjQyChZ2QgjSvkcv",
      "name" : "jeskmkP4ul",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5jHcJY3RRo3fpSgOWS2Har",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "xqrGGQHb4F",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7ex6CYqaGqOEACvjLpXlJG",
        "name" : "qvyvpBeYNp",
        "email" : "lTcaKIBE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7e0ZfxiD7co48VO1RNiw01",
        "name" : "wQy7yhcSp0",
        "email" : "3RDFTLRJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:26.480878Z",
      "updated_at" : "2026-09-10T07:27:26.480878Z"
    },
    "study_group" : {
      "id" : "grp_2nHQCMDLyNGON89EqTN9Gi",
      "study_id" : "sdy_49WbBLCbGqNT8QI0sM4kID",
      "name" : "jK1Rp9NptL",
      "no" : 590510439,
      "color" : "CY5WPV6Ued",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:27:26.800586Z",
      "updated_at" : "2026-09-10T07:27:26.800586Z"
    },
    "cage" : {
      "id" : "cge_14mr69E7n7UJ2EyANLDYpR",
      "study_id" : "sdy_49WbBLCbGqNT8QI0sM4kID",
      "name" : "P60GestUXB",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:27:26.782996Z",
      "updated_at" : "2026-09-10T07:27:26.782996Z"
    },
    "created_at" : "2026-09-10T07:27:26.808475Z",
    "updated_at" : "2026-09-10T07:27:26.808475Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_49WbBLCbGqNT8QI0sM4kID/animals?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_49WbBLCbGqNT8QI0sM4kID/animals?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_49WbBLCbGqNT8QI0sM4kID/animals",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Terminate study animals [BETA]

Terminates one or more animals in a study with the specified termination reason and date.

Authorization: Your API token must include at least one of the following scopes: animal.update, animal.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/animals/terminate

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

animal_ids

Array

The IDs of the animals to terminate.

termination_reason

String

The glossary ID of the termination reason (must be of type euthanize_reasons).

terminated_at

String

The date of termination (ISO format). Defaults to today if not provided.

disease_survivor

Boolean

Whether the animal survived the disease before being euthanized.

comment

String

A comment about the termination (max 5000 characters).

Request

POST /api/public/v1-beta/studies/sdy_2U5FVrff1vomgkc476vZ3g/animals/terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMWJiZDBmMy1kYmRkLTRlZDItODdhNC1iYjRjNmUwNGE3NWEiLCJqdGkiOiJlZDUwMmEyNi1iYTZlLTQzNTItYjRkMi0zYTQ2ZGU1YjAxY2YiLCJpYXQiOjE3ODkwMjUyNDYsIm5iZiI6MTc4OTAyNTI0NiwiZXhwIjoxNzg5MTExNjQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRiVTVFdXFZZllRbTMwT2hSZTN5cFAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Gx36IUaMN5ncxDQQk0EyZomVseR88Q0WbgSChRIbejEHDcWWjb0qYgvLp9vUSosq83au7Un7IxE_Rw_myuoqslgoURncQVDkBvTxPtSr8z9pTMxR-kRoUcWnIu5FodXzAFjxObWhe3jtxxwJfdKIqVP_oYtNzUoUPXnC67sV8o-SS1pRvaO2Wfqno2-1USp0CqzxCuB53wLkaMsTWVoaQ90HlGOrSoyzLApE9V6XROSO53lhgwIR8tYPVsbQ8Qt71mGukJoj-OV2vCt-Q6iD9L_zfnYclQFGTn4ORUSAD8OBZjXQ1pKD_E6oMafcAEONaK1s17JG3rfn0WrtBnH06dchuXhSVaUr22-vTKi8miZB_2Ig_3PUopA2BrRe-xuVxkg6SUBx7vGFyygHB0H0QILHoPUSjM3prrERJK6prldfE_RqeszUXMzLizZJ8heThDhlbYrw1xcdOlmC0U6uyVkPdbMKd7zuX4A9kROnl_4-9pk8c3r4mZ0gV9tac9WR6WYdjOhA7M72dhMNE-pV4XLhRI_hnlUwVDuT4a9m-Y7WN6Aikr814hVgO-Rzg-_sQXZ4hovB1ZS678Vq2OR9TIuE7qUVBbDwcD0YAVHHT_VV3B7p9kW5Xl8Xa4hm8N5ikRQIk5Mk4gpm4wDiI6sAZaOh7BcJ1uAzIUo2qyarWWA
Content-Length: 211
Host: localhost:8080

{
  "animal_ids" : [ "aml_3SBO1vZN8a8nt7xqtLa1b9" ],
  "termination_reason" : "tgy_4PmdOGjMIeso7S2esQ3Hlo",
  "terminated_at" : "2026-09-10",
  "disease_survivor" : false,
  "comment" : "Scheduled termination"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2331

{
  "data" : [ {
    "id" : "aml_3SBO1vZN8a8nt7xqtLa1b9",
    "catalog" : "A0000001",
    "name" : "cp6jmxiEEO",
    "number" : 1,
    "strain" : "Muako9SqJg",
    "species" : "366K3WFyz2",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "SFngcFWXw2",
    "ear" : "s9BbLQf6IM",
    "tag" : "jHrG73Gj3J",
    "donor" : "9cjH7XnZRJ",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : null,
    "terminated_reason" : {
      "glossary_id" : "gly_6WGLyTKe41k01KbVr2qMrO",
      "title" : "Scheduled Euthanasia",
      "comment" : "Scheduled termination"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_2U5FVrff1vomgkc476vZ3g",
      "project_id" : "pjt_4K1IAxrF0MJbVsCXf10lpa",
      "name" : "MSuHFsFRAo",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_54LdOOi5mPCL0qQsNmdMk4",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "7mGWuAlZvg",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_11TONNdNBgUBKuPu3tCAtH",
        "name" : "5Q0WgfIQsU",
        "email" : "YvIqoYMX@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5zsBQBmehuxb3eEcrXqohI",
        "name" : "EOWfYGulr6",
        "email" : "xasD57Iz@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:25.773051Z",
      "updated_at" : "2026-09-10T07:27:25.773051Z"
    },
    "study_group" : {
      "id" : "grp_1A6uyykAtBvpRgbaRqfWDj",
      "study_id" : "sdy_2U5FVrff1vomgkc476vZ3g",
      "name" : "x4ggFPgbYp",
      "no" : 1689046329,
      "color" : "CTKKIy8ksb",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:27:26.140327Z",
      "updated_at" : "2026-09-10T07:27:26.140327Z"
    },
    "cage" : null,
    "created_at" : "2026-09-10T07:27:26.153396Z",
    "updated_at" : "2026-09-10T07:27:26.294167Z"
  } ]
}

Undo terminate study animals [BETA]

Reverses the termination of one or more animals in a study, restoring them to active status and assigning them to the specified cage.

Authorization: Your API token must include at least one of the following scopes: animal.update, animal.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/animals/undo-terminate

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

animal_ids

Array

The IDs of the terminated animals to restore.

cage_id

String

The cage ID to assign the animals to after restoring.

Request

POST /api/public/v1-beta/studies/sdy_6xX1gjwPQzwvDZXbnCK2y2/animals/undo-terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1N2ViM2M2ZC0wMzcxLTQwOWItODNjMi03NmExYzhiMDBiNjIiLCJqdGkiOiJiODlmNzgzMy0zYmY1LTRkMzctYmFhOC1hYTdhZmJkZjk3MzUiLCJpYXQiOjE3ODkwMjUyMjMsIm5iZiI6MTc4OTAyNTIyMywiZXhwIjoxNzg5MTExNjIzLCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzU1U3NtOE11SktLUzJuSFRNYmJDTEciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.j46rLa-yHF1ZoF7ZB5X0NGwhJnEKxxq-nX2bjONoxo-CZ3V3-yVZhiMCKHQ0EQFGSrFEFo6rMu-nxlfj940eGavp3A3JRtx68kSWyP_rXnrV25M2iyhZloKRztN1wNTh7l32WgHdOVpDK1Jh44xsI2G_7xYQ2Jd-PnpFykSP8PzOY9BRhcZhHWVjXesSmdgEuX-84MvxV2_RwuYXA55Fl_Q5Gd5zvG959tOGXSqo2aCj0O9gh6l6Twl4T5iLQiU_rzGRz6nrbEbBU-_t1cyybX_HX7ybVJMZr2MudhFSckyeg2CBf8ExDF94yuEB9Y9nXpv5-O22XrGZqZ8xF_iUcM4Xo8w098t5Nb9-oBsLzi0kmHzf8KBYQduCgGMI5ylcE_THqUAR2pX-0T7JkhS6MNeq9EnOM1s0H5gPOTG1TMYI9iCT_LYYrHGcnzPIOMaL-upaaV3TguMv_OLCVI5ClLKXGHvq7xuYt1r5WOnN6s_bgJ0ccLhXPVkInya90hGC7erpUm1ShqaZ5H0N8Te0MHONa0w9f2763JuTTA1GNvUYBLyuBAxgM0agDoOOM2PQ9ULlX1ioJuECB1p_CBR39yflrTI4WM5T3nNWl3GN4WxCyOGecDChOQLBRJ3Rd8XHOcznadRHHb_oJy1pa8LSdPGnguEoycyQBOFA6UTIQxc
Content-Length: 97
Host: localhost:8080

{
  "animal_ids" : [ "aml_2nzr5xQAGmtk5NPEGTiouq" ],
  "cage_id" : "cge_4hq4eBNRoA7j8xuE2TLoYg"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 27
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2466

{
  "data" : [ {
    "id" : "aml_2nzr5xQAGmtk5NPEGTiouq",
    "catalog" : "A0000001",
    "name" : "c4lS40g9Fu",
    "number" : 1,
    "strain" : "t1VnhfkpT3",
    "species" : "iHTUiw3j5i",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "jHSBtZASLf",
    "ear" : "5XD5yYUv3O",
    "tag" : "G9k8u3wkNk",
    "donor" : "HBrWK6xlmg",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_6xX1gjwPQzwvDZXbnCK2y2",
      "project_id" : "pjt_72OwvlcQ69yvXX1BlZ0Lyr",
      "name" : "PO4LvoJogN",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3oMZl0WPccCSChCLLqqWd7",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "JOpw2jQ7xo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6jNmxtGub4dHzBvCFnTdtE",
        "name" : "pt7FSfW2hF",
        "email" : "wIn0SiQx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1dUeYId6HGJ2rvZ3zIdnub",
        "name" : "Kk1sZDYt2Y",
        "email" : "05Kl1xk2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:02.285648Z",
      "updated_at" : "2026-09-10T07:27:02.285648Z"
    },
    "study_group" : {
      "id" : "grp_3OuSYn6ArCv9AfyTNHROHD",
      "study_id" : "sdy_6xX1gjwPQzwvDZXbnCK2y2",
      "name" : "OyHEoLgRf6",
      "no" : 302417908,
      "color" : "UhIlxQXMJ1",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:27:02.887280Z",
      "updated_at" : "2026-09-10T07:27:02.887280Z"
    },
    "cage" : {
      "id" : "cge_4hq4eBNRoA7j8xuE2TLoYg",
      "study_id" : "sdy_6xX1gjwPQzwvDZXbnCK2y2",
      "name" : "nUH5qmuAUY",
      "catalog" : "C0000002",
      "metadata" : null,
      "created_at" : "2026-09-10T07:27:02.938679Z",
      "updated_at" : "2026-09-10T07:27:02.938679Z"
    },
    "created_at" : "2026-09-10T07:27:02.906015Z",
    "updated_at" : "2026-09-10T07:27:03.693811Z"
  } ]
}

Study Animal Dosage

This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.

Attributes

Path Type Description

id

String

The unique identifier of the dosage.

name

String

The name of the treatment type.

dosed_at

String

The created timestamp of the dosage.

comments

String

The comments associated with the dosage.

dose

Object

The dose concentration associated with the dosage.

dose_volume

Object

The dose volume associated with the dosage.

stock

Object

The stock concentration associated with the dosage.

volume

Object

The volume of the dosage.

study

Object

The study associated with the dosage.

animal

Object

The animal associated with the dosage.

measurement

Object

The measurement associated with the dosage.

user

Object

The user associated with the dosage.

treatment

Object

The treatment associated with the dosage.

weight_at_dosing

String

The optional weight that’s taken during a dosage.

created_at

String

The created timestamp of the dosage.

updated_at

String

The last updated timestamp of the dosage.

Retrieve a study animal dosage

Retrieves the details of an existing study animal dosage.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/dosages/{dosageId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

dosageId

The unique identifier of the dosage.

Request

GET /api/public/v1/studies/sdy_5mlfTKkI9Vmgl0PiLx1b4y/animals/aml_3GIpER5YttCUU3ZiW2VuCm/dosages/dsg_3qkm348zRfiD7fZjVx8PZD HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNjRkYzViYy00ZjBkLTQzOTYtOTg4Ni1lOWUzYTAwZGM0ZDAiLCJqdGkiOiIwZjY5NWY0OS00ZGNmLTQxOTYtOTgzNC1kYzNkN2UzOGY0MDAiLCJpYXQiOjE3ODkwMjUxODMsIm5iZiI6MTc4OTAyNTE4MywiZXhwIjoxNzg5MTExNTgzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzEyUWJPUHJtejk0SVdxdnNLSU5rZmMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PcPGxE7ejuzNlY0qRFhnn08t4ExRiES-PHhkTN3SkUvVYL6dv_gVw209Dkzy7a5ZlN_xLKA865dO5PBsP_FLHfSbGzMyp8a2dNFreaGTKVYNtzjNMl5409FydL1jrl8EEN3ft0M1dKk8otC9TTIUtNyTdUiPCxpGH-vmg6QkoYh4X-nVOJcBuytw3rqYD1_z2Cp3lAWNu2sLrxqRkM7t1ufIOu3oEfRQdPtqczqDFEAVIzdVscc_wNbN-2vxQeFesOCosKYmh8JMD6fKTc-F3pOdD2OitdeXmkJGzCrdMa0z11EyWOyrNRgxp02rXCXQilbMaEe3U-uF0NXv3BpIWsBtHVy-LjwyySkPRvxWd5zXNQR_SMatb0kkRDCMl8HcO4J0w6AW5YsfxiQ016gvVcOEb49WqT50Rb5OuSfbA1qCEC7lyGfC1NdFqSAh4b-sNwhLFjhKePEAHRn7UW0UxfJULN1LSJBF11da_s4-2jcMJ5Srhkof2QPHTM037Qka5GxGiqrdgCwCMUy5fnMZ9LZX1gdRdvLCgcmA3UYcO5LtHA6nLEm1SM3s6gX91LNpu3Da4NgcjyyiUJ5e-mlB7gZGs1336a05O6X8psmBuKTbXoFHR4CCn3t4w0bIsSk6SxQu6NcmwG_ZJTqESYcd49u2yj3RaXN9d2rnEPem_vU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 7
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4792

{
  "id" : "dsg_3qkm348zRfiD7fZjVx8PZD",
  "name" : "Example dosage",
  "dosed_at" : "2026-09-10T07:26:23.242957Z",
  "comments" : "yjm9xx8Sks",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "1.32",
    "display_unit" : "mg/kg",
    "display_value" : "1.32"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "12.17",
    "display_unit" : "ml/kg",
    "display_value" : "12.17"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "29.72",
    "display_unit" : "mg/ml",
    "display_value" : "29.72"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "38.81",
    "display_unit" : "µL",
    "display_value" : "38.81"
  },
  "study" : {
    "id" : "sdy_5mlfTKkI9Vmgl0PiLx1b4y",
    "project_id" : "pjt_2VyO6zc3l0xnK5XJuZ6UYt",
    "name" : "xZGH66o3X3",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4tOAiynafFyULMhA48mpvx",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "Y3fSXxsr0n",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_7aAkvErUVXIJIBjmy2dTcr",
      "name" : "NIaU5hQhyB",
      "email" : "RRGp6aCW@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5pNuFGg29oO2BXQKWwyYra",
      "name" : "fCgnBDvdu2",
      "email" : "TcRaf8NS@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:26:22.613938Z",
    "updated_at" : "2026-09-10T07:26:22.613938Z"
  },
  "animal" : {
    "id" : "aml_3GIpER5YttCUU3ZiW2VuCm",
    "study_id" : "sdy_5mlfTKkI9Vmgl0PiLx1b4y",
    "study_group_id" : "grp_3lduZ0Hqldiy6upPpgotOO",
    "cage_id" : "cge_7c1tzgeF31hw8BUsqFom92",
    "catalog" : "A0000001",
    "name" : "sdxsDKTNZh",
    "number" : 1,
    "strain" : "qwVSn8xItS",
    "species" : "mNxLd53DMg",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "YgCdRUgqs9",
    "ear" : "CsnkKJ3IHi",
    "tag" : "XB9qrs58Zr",
    "donor" : "cDwLcMtGeM",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_5K5PIIOXXzsCXEWvZfJ66O",
      "name" : "kNyXMvr9ei",
      "email" : "iQIPDf8e@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3VhsiCq01LZrOnFiOxbmwe",
      "title" : "Found dead",
      "comment" : "rdyZyuQN3T"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:26:22.971828Z",
    "updated_at" : "2026-09-10T07:26:22.971828Z",
    "disease_induction_date" : "2026-09-10"
  },
  "measurement" : {
    "id" : "mst_1EXI6Q21M1sOZcK0bX9B19",
    "study_id" : "sdy_5mlfTKkI9Vmgl0PiLx1b4y",
    "animal_id" : "aml_3GIpER5YttCUU3ZiW2VuCm",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_5ypKSyKgNIzfqBAp5nazzn",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_5ypKSyKgNIzfqBAp5nazzn",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-09-10T07:26:23.182698Z",
    "updated_at" : "2026-09-10T07:26:23.182698Z"
  },
  "user" : {
    "id" : "usr_7mJeS2tBXdn5SjjjPshaqg",
    "name" : "guL0P Overwatch",
    "email" : "zsvcW5N2@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:26:22.555505Z",
    "updated_at" : "2026-09-10T07:26:22.555505Z"
  },
  "treatment" : {
    "id" : "tmt_1pNEDa3tQGAdTYVHMfGXvT",
    "study_id" : "sdy_5mlfTKkI9Vmgl0PiLx1b4y",
    "type" : "concentration_mlkg",
    "name" : "eeNLY9di3w",
    "label" : "Test Treatment Label",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "created_at" : "2026-09-10T07:26:23.207159Z",
    "updated_at" : "2026-09-10T07:26:23.207159Z",
    "external_entity_id" : "M6jdpDiOMC"
  },
  "created_at" : "2026-09-10T07:26:23.243000Z",
  "updated_at" : "2026-09-10T07:26:23.243000Z"
}

List all study animal dosages

Returns a list of your study animal dosages.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/dosages

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of dosages to return per page.

page

The page of dosages to return.

Request

GET /api/public/v1/studies/sdy_2EI0UeXDiUCXyNFLkgV5aK/animals/aml_6pYdGDG0VRubFQdRqYKpGA/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMWU2ODU0NC05OTk3LTRkZmEtYWIzYS03NDE3NzZlNzdiNTYiLCJqdGkiOiI2MTk4MzU5Yi03ODRjLTRhYzEtOGU1MC0zOTIzOTE4Njg3NWMiLCJpYXQiOjE3ODkwMjUxODgsIm5iZiI6MTc4OTAyNTE4OCwiZXhwIjoxNzg5MTExNTg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0lQYTdyRmJVQURNR3dGVTgxRG5SZCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.bmZr1V6290llKjFVnlfWDYaNmVtrHXMmSdxQJE5vKnOZfLIGdWhsT4cTmKEuNkwugltT-P_2r0bHDC-tW7Y8xkIJ79pN4qwX-w2TD80qU4vpk8Zp0-oUEct9srf9EOr8x_dYBs8u7Pay0b8av01OH9i3Xzdz51An7V7NUfwsu49nNmvLed7TihSOQ5i0ZVJQaox9kt13Es5Zowc1gAjcBr9-MU7mUJPbEnxJZuUq7674mo1oUcfTXRFKV3g5gs1Zu3kzYw47-XphyGjDw0lOB6gbmTP8zUPN-Mt5HGMRNBb9k8HVqEuHAhS49o-GU9Ex92LnZc7YPEnq7zZW8efyC3Ik5t5q0TYJvXRzw6-IWDB5aTFgbxndkaTtZ9fM-oBepxkDMqKwRKWxuMrFNHU6a6Xxc9sfkR-4D2RydP6WEDgifdydrUOx2sIYJKNsfQsp3q8YTqAa_s7p_DNuqC-J0sGdXl6cwVyuufZg2XcDc_kMz_frAcmVf6DVjUIdLl5Kl8Cej3R334VIn5v561YF7rsvp1e--w6FVLPcfkw_ZOS1SngiV4fgIMHzSyVYsHda6f5KKtuDiZG3Sn9mz2P7dHj1ASYlMeavapPqm0tqsGymmIHoz7sRJHgdrrSgsPL2HMYGmjhU6puegsJ75HbdUxhSNOsQ-uBhwJfDlMuLZ78
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 2
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5748

{
  "data" : [ {
    "id" : "dsg_1Tmg4nGusxrlHwx5v023t1",
    "name" : "Example dosage",
    "dosed_at" : "2026-09-10T07:26:28.207846Z",
    "comments" : "gAzYFmhcl2",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "9.11",
      "display_unit" : "mg/kg",
      "display_value" : "9.11"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "13.10",
      "display_unit" : "ml/kg",
      "display_value" : "13.10"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "28.10",
      "display_unit" : "mg/ml",
      "display_value" : "28.10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "36.12",
      "display_unit" : "µL",
      "display_value" : "36.12"
    },
    "study" : {
      "id" : "sdy_2EI0UeXDiUCXyNFLkgV5aK",
      "project_id" : "pjt_4FySzLG5kBYuNoGsaahK7Q",
      "name" : "PwxFLguZgt",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6eL8gTC1XjK7qa6pHZAzkc",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "IHB4slYvpQ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6GBXIXkAy0EcmsYsgiVBIW",
        "name" : "bRew2W9ism",
        "email" : "gD0v3AlN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6Jvp40HcdYs3KDBIPuE42F",
        "name" : "FQCeJ5EOuY",
        "email" : "mdyikrpl@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:27.644222Z",
      "updated_at" : "2026-09-10T07:26:27.644222Z"
    },
    "animal" : {
      "id" : "aml_6pYdGDG0VRubFQdRqYKpGA",
      "study_id" : "sdy_2EI0UeXDiUCXyNFLkgV5aK",
      "study_group_id" : "grp_2KfLWzCKX6LVdv0hkkIzYT",
      "cage_id" : "cge_5lrG9r50dk9XGXRC84GlRG",
      "catalog" : "A0000001",
      "name" : "yqWEG4zloU",
      "number" : 1,
      "strain" : "Y5oaxa3hWT",
      "species" : "XBofUY8WPv",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "FILuS7ly5z",
      "ear" : "K2rRVwssG3",
      "tag" : "U120EMV4He",
      "donor" : "fnpt28xeEX",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_7HrBNgJ0M0ZLWIoiVrD9ny",
        "name" : "kEOKc0T8SF",
        "email" : "yzZz8QoW@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4Qzs1sH7W1H4rBEs0y8Hv9",
        "title" : "Found dead",
        "comment" : "Yvrc4pDzbS"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:26:27.953236Z",
      "updated_at" : "2026-09-10T07:26:27.953236Z",
      "disease_induction_date" : "2026-09-10"
    },
    "measurement" : {
      "id" : "mst_1WyYX8rrQzmsgjYlsCxH6g",
      "study_id" : "sdy_2EI0UeXDiUCXyNFLkgV5aK",
      "animal_id" : "aml_6pYdGDG0VRubFQdRqYKpGA",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_5AdOzQ35bS9Fe847BrQ6pT",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_5AdOzQ35bS9Fe847BrQ6pT",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:26:28.170420Z",
      "updated_at" : "2026-09-10T07:26:28.170420Z"
    },
    "user" : {
      "id" : "usr_1tG5QqcCXHRNBuvB30YrF6",
      "name" : "15l7i Overwatch",
      "email" : "web2LyOn@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:26:27.596601Z",
      "updated_at" : "2026-09-10T07:26:27.596601Z"
    },
    "treatment" : {
      "id" : "tmt_5k51UYBpIJsmvVHh7FuUoa",
      "study_id" : "sdy_2EI0UeXDiUCXyNFLkgV5aK",
      "type" : "concentration_mlkg",
      "name" : "lrTVN6vLgY",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "created_at" : "2026-09-10T07:26:28.185514Z",
      "updated_at" : "2026-09-10T07:26:28.185514Z",
      "external_entity_id" : "frgeDABhhq"
    },
    "created_at" : "2026-09-10T07:26:28.207879Z",
    "updated_at" : "2026-09-10T07:26:28.207879Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2EI0UeXDiUCXyNFLkgV5aK/animals/aml_6pYdGDG0VRubFQdRqYKpGA/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2EI0UeXDiUCXyNFLkgV5aK/animals/aml_6pYdGDG0VRubFQdRqYKpGA/dosages?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_2EI0UeXDiUCXyNFLkgV5aK/animals/aml_6pYdGDG0VRubFQdRqYKpGA/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Animal Measurement

This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.

Attributes

Path Type Description

id

String

The unique identifier of the measurement.

measured_at

String

The measured at timestamp of the measurement.

calculations

Array

The calculations associated to the measurement.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the measurement.

updated_at

String

The last updated timestamp of the measurement.

calculations[].variables

Array

The measurement calculation variables.

Retrieve a study animal measurement

Retrieves the details of an existing study animal measurement.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/measurements/{measurementId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

measurementId

The unique identifier of the measurement.

Request

GET /api/public/v1/studies/sdy_5Ed9QaqfIZbbp2cHnLkw23/animals/aml_7VcQRL0DwZliqTl6e058l7/measurements/mst_2OdTD5GVNAou2fxD2rjj9A HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ZWY4MjlhZC1mZjFlLTQ1ZjctOWUxNC05NGZhZGM5MmViNWIiLCJqdGkiOiJmNTMyYzM4Ni1iNjNlLTQwMzMtOWZmZS1hM2IzMzA0ZWM1NDYiLCJpYXQiOjE3ODkwMjc2NjksIm5iZiI6MTc4OTAyNzY2OSwiZXhwIjoxNzg5MTE0MDY5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJqcGl3VkxHemp1SUc4RUtDUFpicTAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XWPahyJpM4MJgT1wYc4513OWq1PyFVn5YFSrxLJPUeKdQdXFq3CBtsge2Mj7luZKvo1G8hjxxXeTcztMHbrEzjLLDVClvcZ5yZamaAHc_EACQzAXUo7e-MYHmc0UmPnyZG_hVGEi3sujVUo7OktS6_2EtDryhq1_1cmkrt4dkkKRQ_bE2DpsO8pmJhXyqApfK5BR5Ob1Qf1aZUuqe7Jrj7bOgafT7-hlf1s2T7qz8yBxDMCo095PI4HxB1RtqCMl7sPg6UT9YUjgAOFfVIJNSrQZ-WhHt-Vu6PSKD-_ld57uI795R9euEGCGCx56oTVyC49Zm9sNrLEZGlelgANmRdmIWxgAD5Rv_3dcDN4rtr9kI8wcQaZFGSPqlrEpsf8AdEgTa-n_f_ru-yIe_ILLO0dIKj1FGpvkfrN5j6hsL3Kj5d56M8zm1IpjlMpx1W2OHxajvhGZTvPxE7w0PlBo0C4ZwvaZKyaVi1w6dYYoGtG-ee-vwW1KyIYoHHOeKAQjMkMi1zW5SU5rD3l-7acZ9ZhL7U7NcB4bOH9oIDajFatVi9D359BdHIG3_gBXrOmtyAKLU-vEUxv_SliVlds_zDgnAInIOb4lH77Mh9SMt2oPJYcXk4HSZtrj--TTmP9EGyegcwCZ1XLaASis8L8Xquwcdg5E_fnIR5teZXHw-IU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 11
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3400

{
  "id" : "mst_2OdTD5GVNAou2fxD2rjj9A",
  "measured_at" : "2026-09-10",
  "calculations" : [ {
    "id" : "vbl_5tEmzlfPekMcoGcktKlWna",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_4SAUBaQ2RUlScVDUeHoyfB",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_4865jDGnnId0vogeFDPMIi",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_7n0dqBedkDGXrshOhTTiiR",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_7n0dqBedkDGXrshOhTTiiR",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_5Ed9QaqfIZbbp2cHnLkw23",
    "project_id" : "pjt_6AqchBNxlTy99bJsWmuNtt",
    "name" : "XIVk1qkRIm",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7bWCsiI13U8UMKnUvIxpk5",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "d1ThQSDsbr",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5mn3c8WJs6KrfWbSP2ggHR",
      "name" : "YvLhGhr9Ne",
      "email" : "65WXJCkM@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2HEemYqAeU1UiG6uqukSBG",
      "name" : "Zqr0Fsqcx4",
      "email" : "BdQf7eKP@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:49.305038Z",
    "updated_at" : "2026-09-10T08:07:49.305038Z"
  },
  "animal" : {
    "id" : "aml_7VcQRL0DwZliqTl6e058l7",
    "study_id" : "sdy_5Ed9QaqfIZbbp2cHnLkw23",
    "study_group_id" : "grp_ESeddnBM9gaV1ePnKzEEr",
    "cage_id" : "cge_3jadFezdqeAVKxLjlhFhQB",
    "catalog" : "A0000001",
    "name" : "jf9U9rtDdm",
    "number" : 1,
    "strain" : "xtEP49ReZr",
    "species" : "7PMabk0oMY",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "xGg41NqWhx",
    "ear" : "eo159qjLSh",
    "tag" : "XXADhnY1yi",
    "donor" : "PxXAi96IBK",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_5kWVNH5sYCnYTjBi0Luic9",
      "name" : "PthWHE9lmu",
      "email" : "cORugWOg@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3xAWovkbOP7KeKFwoEuMxO",
      "title" : "Found dead",
      "comment" : "EPySjhvn0s"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T08:07:49.606726Z",
    "updated_at" : "2026-09-10T08:07:49.606726Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_6e6aGaGkq3xoqmaRcNx7bs",
    "name" : "bmLtE Overwatch",
    "email" : "p0YECBn5@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T08:07:49.250271Z",
    "updated_at" : "2026-09-10T08:07:49.250271Z"
  },
  "created_at" : "2026-09-10T08:07:49.784471Z",
  "updated_at" : "2026-09-10T08:07:49.784471Z"
}

List all study animal measurements

Returns a list of your study animal measurements.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/measurements

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of measurements to return per page.

page

The page of measurements to return.

measured_at

Filter measurements to return by date (yyyy-mm-dd).

Request

GET /api/public/v1/studies/sdy_6ZMBTJQOWT4Hx4HOnV0vDK/animals/aml_32iqCrLkj8CC5ppC7fsL4l/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNmUyNTQ1ZC0yNzI4LTQ4ZWItODEwMS1kM2RkNGU4MmU1NDciLCJqdGkiOiIxYzg1OTQ3Yy1hZjQ2LTQxNTMtODBkOS0wYmM0NDYxNjhhOTIiLCJpYXQiOjE3ODkwMjc2NjIsIm5iZiI6MTc4OTAyNzY2MiwiZXhwIjoxNzg5MTE0MDYyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFwZzZLYmduMWduQjV3M3V0YlVnSlQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.VNy7E0tTRLDt_CZ7HFx-UlPBq_5l8xWe2P7lrcVGFBE5qbZCBBv0NtU57pdfwa2SOGnWc43z_huiN5LowzKiZ-Sb1RZpioWd1EowfFw_MRLJtuAL6e85yYUANOa_vms_sG32fZsEw9MLexEGfsOFbYGf6QeIbGVy-xnSAUUqFawtcy2qBFd-sY_3EapOjGaJYEpHm9dMzAkQv1SZxschNUoKrVjFJfvM1GmE1iWDwIzN_O2VVQcngloNJ68KMLcB4qQ2sURJXHgVVlz8_YZX2eVmrsoM_Y2XI7OS2rSIQltlHp6khj-BADR38PMIT5URLIlkyor9FQrToC0yIcYGErmu8qwMl42_9cqnTn-zyW4Y6RMV5fHWPVaUHCxPYsvrb2S9cWiopoZyFKGxqeahXpihD_QRvXXe58MA7AKVejAji1gK5TLPXcwype2LubaFRLFPlu-AR-3egs5r4f3MF8dkRktCpz6RKjuxyE-rxFae4udQlurzuJcqzxAhmCbEqucVHnsUGxOnEYUEj3eiE0-Ywtmetn7NzvLfKrr5nx24Hh__CpeVOMA0yzCxxme01ABo_7WEbATJDMVI2FNQ29lAve7dbFJ5deilMrZpYUv4uKPmh-ptex6zq3yg4sOxSw5cFiH_0iDtPYnx6XLiDPn61YPtAqTnLRR2MXiK4lI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7908

{
  "data" : [ {
    "id" : "mst_4lMHltcst5gOWLBTZLSKHV",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_75sR8nfr96qPZvhE52lvdW",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5pbpBzgzBdl0s5RDKFgiWC",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_4m0wQwgseI1BOdaldB8CtL",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1s9aK1y2RYDr9zhzpstd13",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1s9aK1y2RYDr9zhzpstd13",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6ZMBTJQOWT4Hx4HOnV0vDK",
      "project_id" : "pjt_6HCjD2GhskL7fIdD4lkGfX",
      "name" : "oaUgLymSkZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5QIT1TCS89dqBY2rfOjywr",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "NrN8h0dEwl",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6V4uJj72Tc1RpnRgxtuoUk",
        "name" : "xGA01k6RA5",
        "email" : "iRCzqXBL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5vCf7RZPTGtp3f8VtOsUu6",
        "name" : "27m0rhLIvN",
        "email" : "gpkuihfh@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:41.687354Z",
      "updated_at" : "2026-09-10T08:07:41.687354Z"
    },
    "animal" : {
      "id" : "aml_32iqCrLkj8CC5ppC7fsL4l",
      "study_id" : "sdy_6ZMBTJQOWT4Hx4HOnV0vDK",
      "study_group_id" : "grp_10EqL3qrKIgt6EhK4IRxvB",
      "cage_id" : "cge_6fvmL0R4s5U6VKxZlvk8fc",
      "catalog" : "A0000001",
      "name" : "UZErDZ1Hos",
      "number" : 1,
      "strain" : "7jNup2xEO9",
      "species" : "QuE2O8e8r6",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "n2hbPAxpyv",
      "ear" : "qwhzs2uMUD",
      "tag" : "54PaprphOF",
      "donor" : "SsCkeoHDJb",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_zMj2xN214mRHllmULXuP3",
        "name" : "qvv2QBdhgs",
        "email" : "iqiSi2jy@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2q59ZSHXcuUhEzAVPjViWB",
        "title" : "Found dead",
        "comment" : "QmYLNfKfCb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:42.153555Z",
      "updated_at" : "2026-09-10T08:07:42.153555Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_3BYYnmG3KPBRCQk7vPZxQb",
      "name" : "y9GPz Overwatch",
      "email" : "KBnbsP6W@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:41.660946Z",
      "updated_at" : "2026-09-10T08:07:41.660946Z"
    },
    "created_at" : "2026-09-10T08:07:42.307404Z",
    "updated_at" : "2026-09-10T08:07:42.307404Z"
  }, {
    "id" : "mst_6kgWRfWTVOMnBmIwPqOEBx",
    "measured_at" : "2026-09-09",
    "calculations" : [ {
      "id" : "vbl_4ySr6DulOJrWNw4Ghg5hIr",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_2NjAWT77A2Yn3hh9OACjIw",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_3VaS7U3YNaoRVUIYWPNoKI",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1dMJjIYg0CsINn8ooaOv0L",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1dMJjIYg0CsINn8ooaOv0L",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6ZMBTJQOWT4Hx4HOnV0vDK",
      "project_id" : "pjt_6HCjD2GhskL7fIdD4lkGfX",
      "name" : "oaUgLymSkZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5QIT1TCS89dqBY2rfOjywr",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "NrN8h0dEwl",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6V4uJj72Tc1RpnRgxtuoUk",
        "name" : "xGA01k6RA5",
        "email" : "iRCzqXBL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5vCf7RZPTGtp3f8VtOsUu6",
        "name" : "27m0rhLIvN",
        "email" : "gpkuihfh@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:41.687354Z",
      "updated_at" : "2026-09-10T08:07:41.687354Z"
    },
    "animal" : {
      "id" : "aml_32iqCrLkj8CC5ppC7fsL4l",
      "study_id" : "sdy_6ZMBTJQOWT4Hx4HOnV0vDK",
      "study_group_id" : "grp_10EqL3qrKIgt6EhK4IRxvB",
      "cage_id" : "cge_6fvmL0R4s5U6VKxZlvk8fc",
      "catalog" : "A0000001",
      "name" : "UZErDZ1Hos",
      "number" : 1,
      "strain" : "7jNup2xEO9",
      "species" : "QuE2O8e8r6",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "n2hbPAxpyv",
      "ear" : "qwhzs2uMUD",
      "tag" : "54PaprphOF",
      "donor" : "SsCkeoHDJb",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_zMj2xN214mRHllmULXuP3",
        "name" : "qvv2QBdhgs",
        "email" : "iqiSi2jy@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2q59ZSHXcuUhEzAVPjViWB",
        "title" : "Found dead",
        "comment" : "QmYLNfKfCb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:42.153555Z",
      "updated_at" : "2026-09-10T08:07:42.153555Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_3BYYnmG3KPBRCQk7vPZxQb",
      "name" : "y9GPz Overwatch",
      "email" : "KBnbsP6W@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:41.660946Z",
      "updated_at" : "2026-09-10T08:07:41.660946Z"
    },
    "created_at" : "2026-09-10T08:07:42.323957Z",
    "updated_at" : "2026-09-10T08:07:42.323957Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6ZMBTJQOWT4Hx4HOnV0vDK/animals/aml_32iqCrLkj8CC5ppC7fsL4l/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6ZMBTJQOWT4Hx4HOnV0vDK/animals/aml_32iqCrLkj8CC5ppC7fsL4l/measurements?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_6ZMBTJQOWT4Hx4HOnV0vDK/animals/aml_32iqCrLkj8CC5ppC7fsL4l/measurements",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Study Animal Observation

Retrieves the details of an existing study animal observation.

Attributes

Path Type Description

id

String

The unique identifier of the observation.

glossary_id

String

The unique identifier of the glossary item.

team_glossary_api_id

String

The unique identifier of the team glossary.

team_glossary_id

String

The unique identifier of the team glossary.

title

String

The title of the glossary item.

label

String

The label of the glossary item.

text

String

Text related to the observation.

type

String

The type of observation recorded.

value

String

The value of the observation taken.

observed_at

String

The timestamp of when the observation occurred. This value can include a timezone postfix.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the project.

updated_at

String

The last updated timestamp of the project.

Retrieve a study animal observation

Retrieves the details of an existing study animal observation.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/observations/{observationId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

observationId

The unique identifier of the observation.

Request

GET /api/public/v1/studies/sdy_UTLybFKVW7K0ht96iwlYo/animals/aml_3pjGzg4txas1g3cpiKCNIa/observations/obs_59a9UT2WQg0g4g8uYyMfGo HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjOGI4YjE3Mi0xNmZjLTRkMGMtODI5OS1iYzdjOWIwMGE5YjkiLCJqdGkiOiI3ZDgyMmM4NC00ZmJmLTQ3NTktYmU2OC05NWM4NGY2ZGJlZmUiLCJpYXQiOjE3ODkwMjUyNDgsIm5iZiI6MTc4OTAyNTI0OCwiZXhwIjoxNzg5MTExNjQ4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNtTjE2d1BIUnF5V2VTQ0NhSGFTSXIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LzQPmVnPvwwzU6PuCl92xEZM05En0TTNxOJ9egMkA6FsTnLprsCwjZ-1VfxOZicDv08QH4GX051kVHXBNDYz1B8ooFaHEk0Xmrf6iXoI8GYUr2VlKnZfXzW25q6c-9gTji82LZM64gr7pc7bKkQVTJt4TypQiRjyh81ajEbgm9flAR7iFAQhW5gTlAZpeIiUJC6F7l0M9LioVbp-3hQ9GV4LTy7NIoE_kBnhHeOJf-7RJIMd4WnjiMg_Ugz_9fC0SRdxzx0JJ08pQjJRASs-Fy7vbUZpBJ6NSA9pTldbJ5qHb5AFRtCznW4TQ9kd4MLtTbk382SDN06NK-uWLaeWJGsSQfNl98lJbuFj0dkg_CWL515zVb4R4NfamrGj7pKk91FCyiwqCNLrMGnCxr0O_SJe_VYc3NkyVFOWw6kmU7YtueQL9jxgzy8mZNNFm8pqad6u6ducnJrY0gWW5zy-yUQ4o-sQVsPH4jhYVDu3uFLQXnD63mTgwK6lWLSnzilzSUdrz-2Ixy3f3QhD6drB-Xdj0cubR1yzds9DOgbD21G12X9sNO2Oxuf0f1pL5WCF2570YriMmPbTSz8wt1Q7fEGWS_2aappBjijMNeodV2ga3z1x-btK7l681KnbS6Aaa1JT67Zh4-ex8G2BU3fsIciNeufvJLRCHELBEpOLAcM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 2
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2805

{
  "id" : "obs_59a9UT2WQg0g4g8uYyMfGo",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_7TRnEMFZOoIkdi4XnLruUA",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-09-10T07:27:28.468387Z",
  "study" : {
    "id" : "sdy_UTLybFKVW7K0ht96iwlYo",
    "project_id" : "pjt_2ORRq0uDDeJ7XT0EfmJJpT",
    "name" : "SQTSVND2S3",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2qBInIXAuRHuZ4ar7hhgaX",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "wwfdg7aghP",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2Q3OJ1ClTM3GTTpzIzntLK",
      "name" : "IqeDfY0rAw",
      "email" : "cz6wy8JY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2zOhbQCqer7PDKzro7eMV2",
      "name" : "RLf4xnYc6F",
      "email" : "tL3ZfItk@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:27.801646Z",
    "updated_at" : "2026-09-10T07:27:27.801646Z"
  },
  "animal" : {
    "id" : "aml_3pjGzg4txas1g3cpiKCNIa",
    "study_id" : "sdy_UTLybFKVW7K0ht96iwlYo",
    "study_group_id" : "grp_1PKoNj9Z951oaD7F6NsfLr",
    "cage_id" : "cge_3S27iqCSz7LP0LnqcMZEN8",
    "catalog" : "A0000001",
    "name" : "X9Lr5O5hq2",
    "number" : 1,
    "strain" : "o8RXXfOIex",
    "species" : "iE0V7o5pUr",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "dYJWKXC50J",
    "ear" : "5XAhHrafd9",
    "tag" : "9XQvlq9C5y",
    "donor" : "hRfOgpneVP",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_2aDeU2jPRfyTRkZeA8ZTux",
      "name" : "N5htC6YZwZ",
      "email" : "rumrszAb@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_EBX23jPX7V1fGEhszPBrU",
      "title" : "Found dead",
      "comment" : "AnZPiLIKBk"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:28.290412Z",
    "updated_at" : "2026-09-10T07:27:28.290412Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_N0l0qhOOn6ZH7RXTonzS0",
    "name" : "6tHmG Overwatch",
    "email" : "ERjm4pKn@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:27:27.776919Z",
    "updated_at" : "2026-09-10T07:27:27.776919Z"
  },
  "created_at" : "2026-09-10T07:27:28.468469Z",
  "updated_at" : "2026-09-10T07:27:28.468469Z"
}

List all study animal observations

Returns a list of your study animal observations.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/observations

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of observations to return per page.

page

The page of observations to return.

Request

GET /api/public/v1/studies/sdy_73jiHCQjgH1bOYZ5Xlibsa/animals/aml_1esS6hjwSo5zTFtOHob6Qs/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMTU2MDIwMy0zYmEyLTQxNGEtOGE5Ny1hN2Q3M2JhZGQ4MmEiLCJqdGkiOiJkNWRmMzAwNi05NWMwLTQzZTQtYTJlNS03YjE5YmVhNzA2MzciLCJpYXQiOjE3ODkwMjUyNTUsIm5iZiI6MTc4OTAyNTI1NSwiZXhwIjoxNzg5MTExNjU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzc4Z0hvN1pIejhab1RKcmhzNkRHZXgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.U3gs0et9-oloqdAPkKfX8WSBBTge8Whw7jqnkZuuBOM3HEu2SNCNxHTRg8VHPlWRZUwTkGkyxEzOFq849aDsA_CdojDTr0nFJLodRz31xcFc1ErqpGlo9OnniTlPV3LgQkQKH2J-G5D7f-Cy5BGF3K3KJ0XX9d6LuxLH-vjtzUysvLrt4CTkywrouAKuS4-rA0Iao2c6wTlu4GhAPFI49n5g_94LUOTybIodPTaRRH711qLyPInDAWp8-vsAJSOc5Q6rw8U3C1aFgFdj81Pi-xj1Qa5LL3ow4NdPz7VBLJqmKI2snnNAqsd-7wrC97_tIpQYFaERa_3x5dmtD5QcmwsMY3310zAFXLJPjEeyHoV36THOEPVGAlUteyX-3URSux0UWI88-4oK8eSgi-hHe3wOkcjH1eqNnWqBYCObUSgRsoajChDvlvlZ0vtrsUv7FdfV7c8dI8lS2ONOsJvrY3j7pz331Izp7yNHmxtPNRfoEJbVGKlg21CfLGCeR_r_bn7Dkj39tisT6ZURvqdD8DZ_B4fSFsCqzNEk3yD77bHXpOQjO4yEx-eJpnrDRXS5fLcWS_75M1vdu0VMaPODu9vFiYqQzWfyA4jSlIbW_qUYuwE17chH8Ow6yH--NZSvndzkTjvin8SqQOUQKod1VR998PIncle3kohJjAjlaCw
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 25
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3619

{
  "data" : [ {
    "id" : "obs_43lj1NlZX2zpgS5oKfMwSs",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_7EIt3pMPAJOBZGzD6DUyro",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:27:35.238629Z",
    "study" : {
      "id" : "sdy_73jiHCQjgH1bOYZ5Xlibsa",
      "project_id" : "pjt_3srwZjVa8BfwmWLqM6hkWH",
      "name" : "ZZvMcRU3SC",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5JXb9LkcchI9SL6Kuiciei",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "bvqpb003N8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2dpL2lnROFqOh5Gjdu6uOW",
        "name" : "y5F5oLkyuR",
        "email" : "TforADux@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_xATa00vihJvf2gWZIxXmd",
        "name" : "HvSugjPMwi",
        "email" : "2jhQXUOT@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:34.630284Z",
      "updated_at" : "2026-09-10T07:27:34.630284Z"
    },
    "animal" : {
      "id" : "aml_1esS6hjwSo5zTFtOHob6Qs",
      "study_id" : "sdy_73jiHCQjgH1bOYZ5Xlibsa",
      "study_group_id" : "grp_2iS3fye6k18NW6HGM7oKov",
      "cage_id" : "cge_6A1m4FikT2cNBwoT1kejpf",
      "catalog" : "A0000001",
      "name" : "f5caNHq7p1",
      "number" : 1,
      "strain" : "O8UGfFEmxo",
      "species" : "IZlCxHOgjJ",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "KmkLdZwfpf",
      "ear" : "PJ5NqwmcNx",
      "tag" : "SO3gHmiuNV",
      "donor" : "jw0gjcOlSJ",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_5hhcsaQwtVqoqI4i2eeEhT",
        "name" : "1g5oB6Mxc8",
        "email" : "ROfqHMNi@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_5wNM3QL5oJSVhgPpzQyNjC",
        "title" : "Found dead",
        "comment" : "PILHO4qGJm"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:35.077370Z",
      "updated_at" : "2026-09-10T07:27:35.077370Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_6chv5L4wDGHsBA5CJPEoPj",
      "name" : "TVBDB Overwatch",
      "email" : "Bqa3vtVJ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:34.590070Z",
      "updated_at" : "2026-09-10T07:27:34.590070Z"
    },
    "created_at" : "2026-09-10T07:27:35.238727Z",
    "updated_at" : "2026-09-10T07:27:35.238727Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_73jiHCQjgH1bOYZ5Xlibsa/animals/aml_1esS6hjwSo5zTFtOHob6Qs/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_73jiHCQjgH1bOYZ5Xlibsa/animals/aml_1esS6hjwSo5zTFtOHob6Qs/observations?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_73jiHCQjgH1bOYZ5Xlibsa/animals/aml_1esS6hjwSo5zTFtOHob6Qs/observations",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Animal Sample

This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, status (collected, planned, cancelled), timepoint, details like volume or mass and any metadata assigned.

Retrieve a study animal sample

Retrieves the details of an existing study animal sample.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/samples/{sampleId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/studies/sdy_wHBto20SKs2KYdEAzWiy7/animals/aml_4MLW7qdMW3aLgSt9TrGTRW/samples/spl_63UjNUlYH5Khg56C1abH30 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMDQ2ZWExNS0wZGZjLTQ0YzAtODJmMy0xYWM5NTQ3ZmU1MzciLCJqdGkiOiI2MTJhNzE4My1lNGVjLTRjZjMtODU1Ny0xNTVmYzhjNmRmM2EiLCJpYXQiOjE3ODkwMjUyNjcsIm5iZiI6MTc4OTAyNTI2NywiZXhwIjoxNzg5MTExNjY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1g5RHVxNnVRUlloNmRHQ1UxZzJLZiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.FFt0m8TuRrqQiH1e1cvad2qpF4rq2oK4AsxT28kDSGBaSvseBPm18E2RDBja1ALbzgXlTM3Nwo6jaWoi8ZOlnVa8Sq4uvz0qDfghVOienOOfWwbuC1RTXmX2esOGCG8K208V2bUoHgv9BIce1n2Utn4i6dXgVbw1l29e8fxQwvt9MxQSsLRqZBc8Fkcwm05olpPNX5agjJNUTpDRADmnjYNRTgbU-327geuxeriWeMZrPPPmJ6HSfOarJhyE-YTEMlCfzbxUgVUSWH18Sj78VpAxzyUyO-AoOyIBJUvoHu2RsBthdDmU5jRVixKqx3BpByohWo5KQhHYI2y3Y3eQHR1fLfBEzBJOj3ugEG8DvNU57Mgca9u4fNnXUJ_0iVQuY3YYs3vxpBR-_DYthEWf3GEov2dqKW-p4h0CNBEnXCUZwphBO9znE2x4tWG7NZicsRTK7XoeuWGX6kc1tjtJI5SOBI860LqeKc5OooTxQZ3RWsKWqkZGizO736LDGIRQbFt_wB47DKg98tCUxLotebsRJG7i5cs3qB7auvFOM4QwM-er4BNrnfMjZil-TpGyGOpdLEXj0goo58WluGNo0terjeIUdJCtMRqJKi0GlF6IeyOVdTHhRnaw5AxU6WQdgU38llbS1duwX91eM6wHlutxJ8xtel9-o5NUbqLsO50
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2959

{
  "id" : "spl_63UjNUlYH5Khg56C1abH30",
  "sample_id" : "S806253116",
  "sample_definition_id" : "sdf_5vniPSz3DUreuGYxkWUhFK",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-09-10T09:27:47.016221Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1455856346" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_wHBto20SKs2KYdEAzWiy7",
    "project_id" : "pjt_49a41E6oagHPwasLzBBrS0",
    "name" : "aMEu2srILx",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3RowWJo2xwcQRRFqE3MrJb",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "RNdIyAM6Ki",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_66klSLTtUjMpH6mJ5bSMFi",
      "name" : "2RpdUCKatX",
      "email" : "0jOEV2fk@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5zptu8cjjoUWtp0NXfTZ7H",
      "name" : "O9QETTw05w",
      "email" : "SXvGMdd7@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:46.272285Z",
    "updated_at" : "2026-09-10T07:27:46.272285Z"
  },
  "animal" : {
    "id" : "aml_4MLW7qdMW3aLgSt9TrGTRW",
    "study_id" : "sdy_wHBto20SKs2KYdEAzWiy7",
    "study_group_id" : "grp_3LIWUHJovhxPcEwWu4eNPE",
    "cage_id" : "cge_1s5UgVBdFA5V0pH198NQ1z",
    "catalog" : "A0000001",
    "name" : "TkWyZnt9yr",
    "number" : 1,
    "strain" : "C7Pw9ozP6G",
    "species" : "JOjnHeYX2D",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "SUx0F9JwZN",
    "ear" : "e4PlTjO4OG",
    "tag" : "enkdc3GPLe",
    "donor" : "juXiaW0IbW",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_4ZQZaj42yc5BmINkpvxb7V",
      "name" : "qwnWZHnci4",
      "email" : "HXGK4pXG@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_6m0C1oFjEvmBJDbXjj8o3X",
      "title" : "Found dead",
      "comment" : "QzXu2DlEfZ"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:46.639928Z",
    "updated_at" : "2026-09-10T07:27:46.639928Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_4Sn3RIP0az062RtxfDz8Lh",
    "name" : "0x4BpdWI4T",
    "email" : "SlyIs3Gx@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "oNb778fskH" : "Sbfiwill4d"
    },
    "created_at" : "2026-09-10T07:27:47.000849Z",
    "updated_at" : "2026-09-10T07:27:47.000849Z"
  },
  "created_at" : "2026-09-10T07:27:47.016438Z",
  "updated_at" : "2026-09-10T07:27:47.016438Z"
}

List all study animal samples

Returns a list of your study animal samples.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/samples

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

Sort samples based on an attribute (animal, cage, date, group sample, study or type).

order

The order in which the samples will be sorted (asc or desc).

sample_definition_id

Filter samples by sample definition ID(s).

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/studies/sdy_22lquXkPgZRvxUNr32nuwe/animals/aml_463ixVNxIKLt174XgpkHQl/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NjQ1NWE5OC1mNDU5LTQ2MjgtOTI1NC03OTBiZTQ5NTg0MGIiLCJqdGkiOiI4MDBhZDQ3Ni04ZDU3LTQwYjYtYmRlMy1lNDc4Mjc1MzdlMTciLCJpYXQiOjE3ODkwMjUyNzUsIm5iZiI6MTc4OTAyNTI3NSwiZXhwIjoxNzg5MTExNjc1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZqTkFHaXc4OUdQOUUxRXJjWGJVMnYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ASYnqDYXvzu1gm7Zx8QTPBRwkZTnohCjQn3H12s9gLFaC__CmhVtjHUqqpFAaiF4orKY9FjBQB3Db6V-TR1b1WqzDULlih9kWsTwOsngv0qYluhHcgBVXZr91ikFYayaenbrsb5dtAk9GKc_MHPVeFuwvkHMQ9-shyxY2v08mk3muq4l11sgZJQsLx7ny3n5ZL2P_PvKTed2sZk33Mto-0g61_LecQK2uS4-KdG7AQ7b73CfDh7_JQQzlz-3LIl9rwdz2VMvafgz65evUMTcS0IKhWLGaBsg4qtM76fiAjNI0tanAbMWzLYFT2LdD908qODf9tyLp2TSPB7pO59IiWoZoG6Zi9xJnpPRjdK4zKMrsmcciupXwCBWkxUuAYx98NBb2xMZosYjvEYqcazWhkTZL3b0KIklhZ-5fMOrjd2MyQcHRU9cDehCDXSGUZ_r_-bhIGbm9X6PopTpdapWBoHF152H_bi7tMjblIkrd150QnrT09NDQTayrjjl3o-qVh6BDaXy-VNcYO072qmDUwbGWb1UGln0D4lLUQ45TrhHmj_OVDXTlLcufLDi07qtBt8vNu_JPehbzXXeS-1AlJm7nkTmrlq1MMiTVG2OE2AVD62NIs-9h8FjsEteISuNowvitzcqdbrXimE_mYI9QX3ox0DUwIDyF4UP7HzgBKM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 5
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3769

{
  "data" : [ {
    "id" : "spl_69ChfdBQDhSZRsQDeE9NOD",
    "sample_id" : "S413923426",
    "sample_definition_id" : "sdf_2VwTnJXVnKJbuZ9AWQuvG",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:27:55.423277Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1582238500" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_22lquXkPgZRvxUNr32nuwe",
      "project_id" : "pjt_4UE6glsPuxvEamWhnvTWzK",
      "name" : "LweeaBGtyq",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_Lli6JWdzB1XqbqNIItKCw",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "70TbkSL7jB",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_SbxVpsSY13zNxNaRa1pO8",
        "name" : "1pusZh6g5O",
        "email" : "cKbusmTZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5Bo61SJhEwhmKBJUfkXdxo",
        "name" : "XpoVavYe6r",
        "email" : "LafzrnYJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:54.653228Z",
      "updated_at" : "2026-09-10T07:27:54.653228Z"
    },
    "animal" : {
      "id" : "aml_463ixVNxIKLt174XgpkHQl",
      "study_id" : "sdy_22lquXkPgZRvxUNr32nuwe",
      "study_group_id" : "grp_1C6xvTIJguiClbX6gdJAkT",
      "cage_id" : "cge_hOwCal52fJOr50d8VYTug",
      "catalog" : "A0000001",
      "name" : "XtZlqhafxg",
      "number" : 1,
      "strain" : "1ybKRD8dAQ",
      "species" : "o0mL20LQHT",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "F5sf34rTDm",
      "ear" : "PnQZu6BEvm",
      "tag" : "ngthk1YbAq",
      "donor" : "MvhnQ0W8ON",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_556xJgu2Ax5EVRtQgaoLuB",
        "name" : "Tnf5J3ophg",
        "email" : "Uqi1CbEx@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2ndjunpsfBzCQOR0voc6G6",
        "title" : "Found dead",
        "comment" : "5caqpzZivK"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:55.015622Z",
      "updated_at" : "2026-09-10T07:27:55.015622Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_6fBregYheACad8Ch6rX2GU",
      "name" : "c6kr0oymXu",
      "email" : "0OLHdARi@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "9wI33pZeB5" : "9t6e5caReJ"
      },
      "created_at" : "2026-09-10T07:27:55.405204Z",
      "updated_at" : "2026-09-10T07:27:55.405204Z"
    },
    "created_at" : "2026-09-10T07:27:55.423465Z",
    "updated_at" : "2026-09-10T07:27:55.423465Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_22lquXkPgZRvxUNr32nuwe/animals/aml_463ixVNxIKLt174XgpkHQl/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_22lquXkPgZRvxUNr32nuwe/animals/aml_463ixVNxIKLt174XgpkHQl/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_22lquXkPgZRvxUNr32nuwe/animals/aml_463ixVNxIKLt174XgpkHQl/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Group

Study group blurb.

Attributes

Path Type Description

id

String

The unique identifier of the study group.

name

String

The name of the study group.

no

Number

The sequence number of the study group.

color

String

The color of the study group.

max_animals

Number

The maximum number of animals allowed in the study group.

control

Boolean

Indicates this group is a control.

metadata

Object

The metadata associated to the study group.

study

Object

The study of the study group.

created_at

String

The created timestamp of the study group.

updated_at

String

The last updated timestamp of the study group.

Retrieve a study group

Retrieves the details of an existing study group. You need only supply the unique user identifier that was returned upon study group creation.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/groups/{studyGroupId}

Parameter Description

studyId

The unique identifier of the study.

studyGroupId

The unique identifier of the study group.

Request

GET /api/public/v1/studies/sdy_5zoAgYcjhGMATh1c14w1Uf/groups/grp_1Upe37eBEjLWUVs8vNQhr8 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyZWM4NDg5Yi05ODM2LTQ2ZjktOGY5YS00ZjA3YTkzZWJiZjQiLCJqdGkiOiI2YzdlZGQ5Yi1mZjRlLTQzZWMtOWU0Yy1iYWI4ZjYyYmU2NTQiLCJpYXQiOjE3ODkwMjUyNTgsIm5iZiI6MTc4OTAyNTI1OCwiZXhwIjoxNzg5MTExNjU4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVPTWN4MnVxSjhzemMyVDg3bUdQQkgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.hQSVrgu7nIi7rDDVkNOhxpeMIUfmC_BEmC-Or6wwNNvp5kyM0r9xxEk9j4FZUhO3dnz1m9iTxkDVQZgCq5E_nXHRe8UoXywq9wLG82dTF3U-ip7ahW9j8b3wVaXHuKep6FyLNCe5BucBvvXY7iOuRlH7PA66xnZA3EnwhEWQaSvz02c6TQ8UWsoRa6s8WyzQ5XHmuQ3T18PSyehBeDCdbrPolA5UA0AZhFJsXReVuDf4b4s3IMnt2UfK8v2U-R-ZFBac-bKalegFLBDBMsoBHLEpLjqDS-tzNAqKEAA8LvwEM8ncUIQJI4bA55eRs7x5kG0JoKmQRmxlz40eVRm9dti0p-NSLzsazQjHYZe_vP3Haq3SlVs9KCSwHRTVkUIg-S9vSjedvo7qvmN16ZZdcOuPhVlMYHcglzI81VkW3jq2P8pW45n4o78NH4V2fQPYTNcGay_uN_4Yni2CRGy1S7KRVQEdDPC23ykU2b5K7FbOvGria3NuE63Nh-Q3GXi4R1OnEXaLoLi6GaemJG8Fo3uhbJgK4Yt3AZy4kbYtLjtZjzAhXAWPRTDkisMbNKwtgorCyp_4mC9LDgsjuTW37vtzbLYU5VYWF5hlsjRlt6x4n5kVFiQbpvn1dP4A1r2cFZNBr_pVCn2IZh5mHq9KcNJvnuAjKaNH9foe5n-C-5M
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 22
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1247

{
  "id" : "grp_1Upe37eBEjLWUVs8vNQhr8",
  "name" : "A",
  "no" : 1,
  "color" : "#34e8eb",
  "max_animals" : 10,
  "control" : false,
  "metadata" : {
    "study-group-internal-id" : "SYSGROUP-A1"
  },
  "study" : {
    "id" : "sdy_5zoAgYcjhGMATh1c14w1Uf",
    "project_id" : "pjt_2KYKeOeRD6ZQM1eWnyl4L5",
    "name" : "d3hPjFknUw",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7mzYylos0N9rTFk1fPY79z",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "D2StGYG8x7",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_6yyFOuZM9P3uhwhAeU6j5S",
      "name" : "qPY1xskWis",
      "email" : "1nYz4CaY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_KjeEsFWMzTsK1LJ9OGAiC",
      "name" : "duF8Pt48en",
      "email" : "uJg1Q77A@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:38.612910Z",
    "updated_at" : "2026-09-10T07:27:38.612910Z"
  },
  "created_at" : "2026-09-10T07:27:38.910372Z",
  "updated_at" : "2026-09-10T07:27:38.910372Z"
}

List all study groups

Returns a list of your study groups.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Query parameters

Parameter Description

perPage

The number of study groups to return per page.

page

The page of study groups to return.

metadata

Filter study groups to return by metadata value

treatment_id

Filter study groups to return if they have an associated treatment

Request

GET /api/public/v1/studies/sdy_2l9ECbAwxGr4bK3Iz3J2TJ/groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZmYwZTY4Yi03MGU4LTQzMTQtYjE0My02MjQyZGFmOTA1Y2IiLCJqdGkiOiJmNzBlYzhhZS01ZmU1LTRjZGMtOTRlOC00OTMzMWViOTQzZGUiLCJpYXQiOjE3ODkwMjUyNjAsIm5iZiI6MTc4OTAyNTI2MCwiZXhwIjoxNzg5MTExNjYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNpYmo4NzFENTdVVzRPRjBLZUJiR2IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZWyUKcjBPQDHsz3IL0c6aNQlkMoA6gwrdwdClJ9xnE1JB1kKcHYDoLIAcIqN5axNEpVxZPzztdpEb9QkRHoovwv-nLvvOjXkuBIPeIIz1kiVUN7iB5BN2X7Oq23NX1XsrOlvCEQySvnErmDXGLZMt9f73Uv5J_OIZM7X3AdeR8GSbqFRo8ui86Gz4pWNkqcnXqOHTf9m3yeyDXY50AMJe6q3dMkSpRnrTAwqY1sPFTUGuHgr70AG3d12XhRfEg0G3t2HXza_vIYSmTOIBw9lmvRrLIHi5hFH9BlOIE_OkYmEieq2nuKDyzpf2Y07bzZJZFfdJvvyxJwyM34i3u2R0lbHBHN17531Oh04QcQqvs92vIwET5wgfhLZivSfdEOwOLEgjf1_gaxdz6-4kNCr6K7bNKGnRKzRDBxM5P9jSC4hkTuFIXU0vtTuVKVt4HeveCTQuHv0dnSNCU_-N7kL5yvfH2AI2Qtna7-Tkxu3w0P5_yhevXfKVbIhNrnajA4W0GJ0N-GFo7FAJwlGZq24zxX_ZbrzQoxG64g1cNCOUCPDuyLC38Vi98Yf5lwk4XBbl0XP042cl0ThCSLDwHKi4kGPI5xB6gYR5Q1TqMxJgnDt-_sQiwSb4boYNOXHiTgQxrMCh9AkG4I8wqcBoSGGULt88SGn5tVGh11N1h_kMko
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4514

{
  "data" : [ {
    "id" : "grp_3iJOMZCeQveAAyCYd1UDX9",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_2l9ECbAwxGr4bK3Iz3J2TJ",
      "project_id" : "pjt_1nk7vEls9pYIzUBUrK4Ox4",
      "name" : "sgGwd9E1ch",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7TVEMKkOcrIN5nWPXeYKmv",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "vVCCcH9zAP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6hALT5rMiCc4qDvMhMuVFc",
        "name" : "jjptrJIlje",
        "email" : "rohUQtK3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60fQCjwvIY8hoT8HZvCJpS",
        "name" : "Be26FjS2cR",
        "email" : "hVIrsOqP@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:40.039869Z",
      "updated_at" : "2026-09-10T07:27:40.039869Z"
    },
    "created_at" : "2026-09-10T07:27:40.395890Z",
    "updated_at" : "2026-09-10T07:27:40.395890Z"
  }, {
    "id" : "grp_5dU9rK2agUpurkOUANycVB",
    "name" : "B",
    "no" : 2,
    "color" : "#4a7d4b",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-B3"
    },
    "study" : {
      "id" : "sdy_2l9ECbAwxGr4bK3Iz3J2TJ",
      "project_id" : "pjt_1nk7vEls9pYIzUBUrK4Ox4",
      "name" : "sgGwd9E1ch",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7TVEMKkOcrIN5nWPXeYKmv",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "vVCCcH9zAP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6hALT5rMiCc4qDvMhMuVFc",
        "name" : "jjptrJIlje",
        "email" : "rohUQtK3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60fQCjwvIY8hoT8HZvCJpS",
        "name" : "Be26FjS2cR",
        "email" : "hVIrsOqP@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:40.039869Z",
      "updated_at" : "2026-09-10T07:27:40.039869Z"
    },
    "created_at" : "2026-09-10T07:27:40.405645Z",
    "updated_at" : "2026-09-10T07:27:40.405645Z"
  }, {
    "id" : "grp_4PEuACw4h67PR6DLACgruM",
    "name" : "C",
    "no" : 3,
    "color" : "#ad2f70",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-C2"
    },
    "study" : {
      "id" : "sdy_2l9ECbAwxGr4bK3Iz3J2TJ",
      "project_id" : "pjt_1nk7vEls9pYIzUBUrK4Ox4",
      "name" : "sgGwd9E1ch",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7TVEMKkOcrIN5nWPXeYKmv",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "vVCCcH9zAP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6hALT5rMiCc4qDvMhMuVFc",
        "name" : "jjptrJIlje",
        "email" : "rohUQtK3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60fQCjwvIY8hoT8HZvCJpS",
        "name" : "Be26FjS2cR",
        "email" : "hVIrsOqP@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:40.039869Z",
      "updated_at" : "2026-09-10T07:27:40.039869Z"
    },
    "created_at" : "2026-09-10T07:27:40.413335Z",
    "updated_at" : "2026-09-10T07:27:40.413335Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2l9ECbAwxGr4bK3Iz3J2TJ/groups?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2l9ECbAwxGr4bK3Iz3J2TJ/groups?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_2l9ECbAwxGr4bK3Iz3J2TJ/groups",
    "per_page" : 10,
    "to" : 3,
    "total" : 3
  }
}

Study Group Treatment

Study group treatment blurb.

Attributes

Path Type Description

id

String

The unique identifier of the treatment.

type

String

The name of the treatment type.

name

String

The name of the treatment.

label

String

The label of the treatment.

external_entity_id

String

The external identifier of the treatment.

dose

Object

The dose concentration associated with the treatment.

dose_volume

Object

The dose volume associated with the treatment.

stock

Object

The stock concentration associated with the treatment.

volume

Object

The volume of the treatment.

metadata

Object

The metadata associated to the treatment.

study

Object

The study associated with the treatment.

study_group

Object

The study group associated with the treatment.

created_at

String

The created timestamp of the treatment.

updated_at

String

The last updated timestamp of the treatment.

Retrieve a study group treatment

Retrieves the details of an existing study group treatment.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/groups/{studyGroupId}/treatments/{treatmentId}

Parameter Description

studyId

The unique identifier of the study.

studyGroupId

The unique identifier of the study group.

treatmentId

The unique identifier of the treatment.

Request

GET /api/public/v1/studies/sdy_QPy6VrujxoMvIEpe5xm3B/groups/grp_1ph5ZKIx0icx6lhHsYozyE/treatments/tmt_10DQrKxGvUKeQDvGX3eWXe HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MjIyYWMwZi04NDFmLTRjNzMtOTA5Yi1jYmU5NWI4ZjI4MTAiLCJqdGkiOiJhMmVhY2I0Mi0xMTVkLTRhYmYtYTEyMi00YmNiZDhjNjRjMjkiLCJpYXQiOjE3ODkwMjUyNzYsIm5iZiI6MTc4OTAyNTI3NiwiZXhwIjoxNzg5MTExNjc2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0xVZDNYeEVvZVRZRmdJS3NUcGZneSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.dcF_JrDi6qDSCNsGUpYJC2lQIRkFVp33rnylVSEbHtq9q9FQkGOA7iNTfPx4cPuZAXTGEe_1hktegmRH2Yz_sP31SHkrnLYZ8J-EqXKrsTtTAeNYjJYwEyST3p-NtUuZle7zbsAohP6XkPizcmhyqlewzoKA6CBHE6Y5RUa3xTQwgxLK23NvmigjGVzwxROasYmPc4rTnSKlhXzrf8YHd3BqBmogxrITnSw_3k07jkW6bz30U8KTULNk8_NoOv40oAPmtUksmWy0zcgzFgQjEN_ydVclDJF_OWc-1y44zFNfR9t-KAgdvEwA5RAd32GSW8CBamysvtQQltOM4egfmbuehd4U_Pfi9K2s-lG0tNLvsuqr3hlBQ-Qspg_EjHE0Zudi9iZSpD-59fl5_hvXOIoK4A-ObiPjxwOD9M1bDmP21jN3_pSxTWIdS3mmlVkyX41DRL_NHjyFolS3ujCOexDmhL2qdrUtP0RGZiWbicRTGv9yCXjX6KCXUHg2q7K9vM3PcKuAdzeNLJszbKjhXO4g2WBLHvbIQsPk9tLLWrZB_Qv2sHAVceWtJdn09Eh_wWDdIkKjtb8UWQJAwuaWjssTBxBDYQh2DVudCNb0GxVgpqY8x4qH1fgQ_ZoWPiqh74zet-21olBudm7ccyFP1aFc6mZoRQ7-wqVq_cpceEA
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2157

{
  "id" : "tmt_10DQrKxGvUKeQDvGX3eWXe",
  "type" : "dose_volume",
  "name" : "1qwqCSLRsI",
  "label" : "Test Treatment Label",
  "external_entity_id" : "ObKIWOLRUR",
  "dose" : {
    "unit" : "mg/kg",
    "value" : "5",
    "display_unit" : "mg/kg",
    "display_value" : "5"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "15",
    "display_unit" : "ml/kg",
    "display_value" : "15"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "10",
    "display_unit" : "mg/ml",
    "display_value" : "10"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "8",
    "display_unit" : "µL",
    "display_value" : "8"
  },
  "metadata" : {
    "treatment-internal-id" : "TREATMENT-1234"
  },
  "study" : {
    "id" : "sdy_QPy6VrujxoMvIEpe5xm3B",
    "project_id" : "pjt_VbnqaaXQI5otN8ejs5oUo",
    "name" : "pJJjQclxFv",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6kcOqzQ6n62P49az9EM2ID",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "7joZ2QHqqh",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4pQUlAFvPNGz9MDCiTNvec",
      "name" : "8QnH6DMLEt",
      "email" : "kQaiuzlz@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6FQMDrlcpZG22AJLO3En68",
      "name" : "naDUhjJrBG",
      "email" : "nbJVgWPS@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:55.750930Z",
    "updated_at" : "2026-09-10T07:27:55.750930Z"
  },
  "study_group" : {
    "id" : "grp_1ph5ZKIx0icx6lhHsYozyE",
    "study_id" : "sdy_QPy6VrujxoMvIEpe5xm3B",
    "name" : "sTOkoM3jWL",
    "no" : 709025751,
    "color" : "vGMtjX5Qy6",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-09-10T07:27:56.106293Z",
    "updated_at" : "2026-09-10T07:27:56.106293Z"
  },
  "created_at" : "2026-09-10T07:27:56.264033Z",
  "updated_at" : "2026-09-10T07:27:56.264033Z"
}

List all study group treatments

Returns a list of your study group treatments.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Query parameters

Parameter Description

perPage

The number of measurements to return per page.

page

The page of measurements to return.

metadata

Filter studies to return by metadata value

Request

GET /api/public/v1/studies/sdy_39v96QV3vHLGuBrfSeRglw/groups/grp_5r9gdyyRGqGNwidFNor5BD/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzODEyZWQyMi1kYzkzLTRjYjItYWVlOC00MjA3ZjVmMjRkY2YiLCJqdGkiOiI5YTJjM2UwOS1lNTI1LTQ1NzItYWE5Yi05ODgxYzFkOGI3NjAiLCJpYXQiOjE3ODkwMjUyNzIsIm5iZiI6MTc4OTAyNTI3MiwiZXhwIjoxNzg5MTExNjcyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdJUWhrZXV0SzFFOG1jU2JwMnJVOGkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Y2IC7Yj6VR8rBVHEhDtOEQRoFbGw5uGNpzm9502CwNmoyJ8IeIDG89G10k1TXOe05m5UlvtSDMLA_TGGhe3sgEWCO5FX-bBVlxZOY3eznWYARHC_i4Rnv1C_aB0dGMUGtYJL8hhMLWUTaXm7mkMzdqmTxxhuqcU09P0kpOEC5cZu4eRh7MSmKG2DUunMrur2zG802epdXwrLX2LR5N5cfl--Whz670dkXzki2bYDLSTmawgd031Zg7158Gac5nkEGHpFcjeHiMrwFKWBjnuioOFaf5B3Yuxftz0SZDzeDD8T-fYYm7scT9rZk_3zgO18F4OQQj7NTyb_RyuqG-Xt36BMRxKefzXD3EyTZeTqQW3KmpyPs1SAAFNle1XAVLzZl7u1Iy0-LAh9lCuSQZJmTGgbjdWy7qhdUAf9e9catnmMV6Vpm88JxzKHNpnjk2QHwy919SH3-czvFfMxz4bTTdEhKsrNCtSZjlXg3cicladZn87MbqXv_lgorKU6G4q9dy-rKuYFdzA0Cheaj-1JNY12-E9jQx52PJOf8_FwKd--aMgcJs5YAMvGkah8aP6UqsgKG-ZDb6425upoTMVSsMQpfwXMz1EWDEsvpUfHSif_BD7PcxSFPOJfFXAkoh4bfNUDR8w26c-hesbNMrrSltgP-coFtweFIbhizwupJu4
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 8
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2946

{
  "data" : [ {
    "id" : "tmt_3xZFqjnzlJQPL2IgKZM7eg",
    "type" : "concentration_mlkg",
    "name" : "qzG71QLYci",
    "label" : "Test Treatment Label",
    "external_entity_id" : "UiyFJh1Uch",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "study" : {
      "id" : "sdy_39v96QV3vHLGuBrfSeRglw",
      "project_id" : "pjt_2GLJHFCK7d9hQlxl9jEDmC",
      "name" : "KJc9igla0m",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_26p9OZPFmo4HC1PpRlcY5i",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "2dhLr22XqN",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1ouBxpgqZvwOiT52MiO94O",
        "name" : "MKlicToxIR",
        "email" : "pCBJaHdf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1ZirGxFJcOpQN6xGtHhUXj",
        "name" : "TdUUysjHSN",
        "email" : "nFAGyagp@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:51.520744Z",
      "updated_at" : "2026-09-10T07:27:51.520744Z"
    },
    "study_group" : {
      "id" : "grp_5r9gdyyRGqGNwidFNor5BD",
      "study_id" : "sdy_39v96QV3vHLGuBrfSeRglw",
      "name" : "yTGDhrcg94",
      "no" : 1955582151,
      "color" : "lqmu9qwcf6",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:27:51.883045Z",
      "updated_at" : "2026-09-10T07:27:51.883045Z"
    },
    "created_at" : "2026-09-10T07:27:52.076472Z",
    "updated_at" : "2026-09-10T07:27:52.076472Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_39v96QV3vHLGuBrfSeRglw/groups/grp_5r9gdyyRGqGNwidFNor5BD/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_39v96QV3vHLGuBrfSeRglw/groups/grp_5r9gdyyRGqGNwidFNor5BD/treatments?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_39v96QV3vHLGuBrfSeRglw/groups/grp_5r9gdyyRGqGNwidFNor5BD/treatments",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Dosage

This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.

Attributes

Path Type Description

id

String

The unique identifier of the dosage.

name

String

The name of the treatment type.

dosed_at

String

The created timestamp of the dosage.

comments

String

The comments associated with the dosage.

dose

Object

The dose concentration associated with the dosage.

dose_volume

Object

The dose volume associated with the dosage.

stock

Object

The stock concentration associated with the dosage.

volume

Object

The volume of the dosage.

study

Object

The study associated with the dosage.

animal

Object

The animal associated with the dosage.

measurement

Object

The measurement associated with the dosage.

user

Object

The user associated with the dosage.

treatment

Object

The treatment associated with the dosage.

weight_at_dosing

String

The optional weight that’s taken during a dosage.

created_at

String

The created timestamp of the dosage.

updated_at

String

The last updated timestamp of the dosage.

Create study dosages [BETA]

Creates dosages for one or more animals on a study. Each item specifies the animal to dose, the treatment to administer, and the date and time it was administered.

Values are computed from the treatment and the animal’s latest weight, so an item can omit them entirely and inherit whatever the treatment defines. Supplying any value computes the dosage from your values instead of the treatment’s defaults, and any value the treatment marks as required must then be supplied alongside them.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/dosages

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

animal_id

String

The unique identifier of the animal to dose.

treatment_id

String

The unique identifier of the treatment to administer.

dosed_at

String

The date and time the dosage was administered. Must be a full ISO 8601 UTC date/time: either an explicit UTC instant (offset 'Z' or '+00:00') or an offset-less date/time taken as UTC (e.g. "2026-03-25T10:00:00Z" or "2026-03-25T10:00:00"). A date-only value is not accepted and non-UTC offsets are not allowed.

comments

String

An optional comment recorded against the dosage.

dose

String

Optional dose value in the treatment’s display units. When any value is supplied the dosage is computed from the supplied inputs instead of the treatment defaults, and any value field the treatment marks as required must be supplied with them.

stock

String

Optional stock value in the treatment’s display units.

volume

String

Optional volume value in the treatment’s display units.

dose_volume

String

Optional dose volume value in the treatment’s display units.

weight_at_dosing

String

Optional weight to use for the calculation and to snapshot onto the dosage. Read per object: when omitted this object falls back to the animal’s latest weight measurement, which a non-custom treatment requires to exist. It is not a value field, so supplying it alone still computes the dosage from the treatment defaults.

induct_disease

Boolean

When true and the treatment is a disease induction treatment, sets the animal’s disease induction date to the earliest dosing time if not already set.

Request

POST /api/public/v1-beta/studies/sdy_3Xfd4y7rZ0k97NSWyRKTGa/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5NWNiNDc3Yi0xNmIwLTQyN2UtYTgxNC03NDgwMjNhOGE5ZWEiLCJqdGkiOiIyZTE5NzU3Zi0wNDQ0LTQ2YzktYWQwZi0zN2E3ZTllMDNmNmMiLCJpYXQiOjE3ODkwMjUyMTAsIm5iZiI6MTc4OTAyNTIxMCwiZXhwIjoxNzg5MTExNjEwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJoWUZCZUFsSlJjNHpLSExuRGsxOEQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.iY8YCw91elq2z91_Ef0azdhe83ctzzILkOTH2vo-I0JG5uKyR4LrntuPCtiA_B6RBT9URKVNA5a0liFbfYNDRR5KRwylP9TFF4E3__r_d3p5uMZu6Z-ntAQ5TOdbtXt87Iouu2yk30g6DrtJ-qcFrqFbiwD_H8y1RmOQqB8Gi6G75k3UnNJjV7snZvhtERBQUiOB3-jVlmHq-Iew5rsDmQ6-8vrNtYzH_fYQwTI6UHhUpVESGrcxcM_CHCAAm8k2z6hQcTROh9Cu3ptjxAVAJtPpREparENXOwLN0nKhGywF-kbRFDPhF_yjFNX2TCUXxvs_4q5LgTqMGs3RwQs5o8nayvf6G1Sqq2e5Bw5tNOTxbxZ9brbYQ53dGj6eCjbbd5bzD-IRLTpAJuNx_1hBrb1-WL0OHE1v49BhYZBgWlK80MvPZCGefYVrM50qNFq7U2QwQwbZfybux8KJfJrVToiVMzUt2x-UFtA-FfkQiYBMj_K70bglk2uPfRmz0DLSlSZcFACmBvM52VvI904h7lAIYg53yviYjox-HhCMoHkdPAfwjzg2mzYF9KWIV211w8f8YY7RWztw349o4ykrf5hw0N5DXx7qSocsYUTuWfOq2xmkxp2eqYl15xm6eVJSF_8ZfsFWjPIKCO92r6J5M87d0XHEwd5arRnv7rD_c24
Content-Length: 365
Host: localhost:8080

[ {
  "animal_id" : "aml_5wEHzesql3fwrOBl5q0NH1",
  "treatment_id" : "tmt_2FVVJXC8r7raJ0k6QMCDod",
  "dosed_at" : "2026-03-25T10:00:00Z",
  "comments" : "Morning dose",
  "induct_disease" : false
}, {
  "animal_id" : "aml_5wEHzesql3fwrOBl5q0NH1",
  "treatment_id" : "tmt_2FVVJXC8r7raJ0k6QMCDod",
  "dosed_at" : "2026-03-24T10:00:00Z",
  "induct_disease" : false
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 8170

{
  "data" : [ {
    "id" : "dsg_1auUAhYt8JMPNGSGHLAO17",
    "name" : "YN4tkutAJt",
    "dosed_at" : "2026-03-25T10:00:00.000000Z",
    "comments" : "Morning dose",
    "weight_at_dosing" : "55",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "2.13",
      "display_unit" : "mg/kg",
      "display_value" : "2.13"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "1.38",
      "display_unit" : "ml/kg",
      "display_value" : "1.38"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "2.02",
      "display_unit" : "mg/ml",
      "display_value" : "2.02"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "57.995056",
      "display_unit" : "µL",
      "display_value" : "58.00"
    },
    "study" : {
      "id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "project_id" : "pjt_2SWZCxb8R2nv9nTsfpamyi",
      "name" : "2RIga0FeGp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6shlh9O3hFo39UbAYodm49",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "oNSnQ35FKR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:50.742961Z",
      "updated_at" : "2026-09-10T07:26:50.742961Z"
    },
    "animal" : {
      "id" : "aml_5wEHzesql3fwrOBl5q0NH1",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "study_group_id" : "grp_6Silk8mJWycxA496ZbwMDd",
      "cage_id" : "cge_2d3iK4zah22MCnwINwcLvE",
      "catalog" : "A0000001",
      "name" : "0Ol65f6Lnc",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2020-01-01",
      "tail" : "LuQf24pnI3",
      "ear" : "OuJGR6qwD2",
      "tag" : "YwQ6tqzqb1",
      "donor" : "MPKACeYzdK",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-09-10T07:26:50.794613Z",
      "updated_at" : "2026-09-10T07:26:50.794613Z",
      "disease_induction_date" : null
    },
    "measurement" : {
      "id" : "mst_6XsPDmRgYfBY645Rjk2ESC",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "animal_id" : "aml_5wEHzesql3fwrOBl5q0NH1",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_4wKdPeu06CxKnIeFaxxyqB",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_4wKdPeu06CxKnIeFaxxyqB",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:26:50.807490Z",
      "updated_at" : "2026-09-10T07:26:50.807490Z"
    },
    "user" : null,
    "treatment" : {
      "id" : "tmt_2FVVJXC8r7raJ0k6QMCDod",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "type" : "concentration",
      "name" : "YN4tkutAJt",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "2.13",
        "display_unit" : "mg/kg",
        "display_value" : "2.13"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "1.38",
        "display_unit" : "ml/kg",
        "display_value" : "1.38"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "2.02",
        "display_unit" : "mg/ml",
        "display_value" : "2.02"
      },
      "volume" : {
        "unit" : "µL",
        "value" : null,
        "display_unit" : "µL",
        "display_value" : null
      },
      "metadata" : null,
      "created_at" : "2026-09-10T07:26:50.821660Z",
      "updated_at" : "2026-09-10T07:26:50.821660Z",
      "external_entity_id" : "sb2fVBHMvI"
    },
    "created_at" : "2026-09-10T07:26:50.929280Z",
    "updated_at" : "2026-09-10T07:26:50.929280Z"
  }, {
    "id" : "dsg_Id5WxhqXJJUJX4xdwQhXT",
    "name" : "YN4tkutAJt",
    "dosed_at" : "2026-03-24T10:00:00.000000Z",
    "comments" : null,
    "weight_at_dosing" : "55",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "2.13",
      "display_unit" : "mg/kg",
      "display_value" : "2.13"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "1.38",
      "display_unit" : "ml/kg",
      "display_value" : "1.38"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "2.02",
      "display_unit" : "mg/ml",
      "display_value" : "2.02"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "57.995056",
      "display_unit" : "µL",
      "display_value" : "58.00"
    },
    "study" : {
      "id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "project_id" : "pjt_2SWZCxb8R2nv9nTsfpamyi",
      "name" : "2RIga0FeGp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6shlh9O3hFo39UbAYodm49",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "oNSnQ35FKR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:50.742961Z",
      "updated_at" : "2026-09-10T07:26:50.742961Z"
    },
    "animal" : {
      "id" : "aml_5wEHzesql3fwrOBl5q0NH1",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "study_group_id" : "grp_6Silk8mJWycxA496ZbwMDd",
      "cage_id" : "cge_2d3iK4zah22MCnwINwcLvE",
      "catalog" : "A0000001",
      "name" : "0Ol65f6Lnc",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2020-01-01",
      "tail" : "LuQf24pnI3",
      "ear" : "OuJGR6qwD2",
      "tag" : "YwQ6tqzqb1",
      "donor" : "MPKACeYzdK",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-09-10T07:26:50.794613Z",
      "updated_at" : "2026-09-10T07:26:50.794613Z",
      "disease_induction_date" : null
    },
    "measurement" : {
      "id" : "mst_6XsPDmRgYfBY645Rjk2ESC",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "animal_id" : "aml_5wEHzesql3fwrOBl5q0NH1",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_4wKdPeu06CxKnIeFaxxyqB",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_4wKdPeu06CxKnIeFaxxyqB",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:26:50.807490Z",
      "updated_at" : "2026-09-10T07:26:50.807490Z"
    },
    "user" : null,
    "treatment" : {
      "id" : "tmt_2FVVJXC8r7raJ0k6QMCDod",
      "study_id" : "sdy_3Xfd4y7rZ0k97NSWyRKTGa",
      "type" : "concentration",
      "name" : "YN4tkutAJt",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "2.13",
        "display_unit" : "mg/kg",
        "display_value" : "2.13"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "1.38",
        "display_unit" : "ml/kg",
        "display_value" : "1.38"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "2.02",
        "display_unit" : "mg/ml",
        "display_value" : "2.02"
      },
      "volume" : {
        "unit" : "µL",
        "value" : null,
        "display_unit" : "µL",
        "display_value" : null
      },
      "metadata" : null,
      "created_at" : "2026-09-10T07:26:50.821660Z",
      "updated_at" : "2026-09-10T07:26:50.821660Z",
      "external_entity_id" : "sb2fVBHMvI"
    },
    "created_at" : "2026-09-10T07:26:50.929280Z",
    "updated_at" : "2026-09-10T07:26:50.929280Z"
  } ]
}

Retrieve a study dosage

Retrieves the details of an existing study dosage.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/dosages/{dosageId}

Parameter Description

studyId

The unique identifier of the study.

dosageId

The unique identifier of the dosage.

Request

GET /api/public/v1/studies/sdy_7Bxyztx4YkDTOH9hk2WzGh/dosages/dsg_7igWtQen8WABE6JZH4zBkI HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YWE0MzYxZS00M2M3LTQ0MzgtOTg4OS1mNTRjZGE0ZmQ1NTYiLCJqdGkiOiI2NDJkOGUwYy1jNjk0LTQ4MTEtYjMyMS05OGY3NGMxMmY5NWMiLCJpYXQiOjE3ODkwMjUxODYsIm5iZiI6MTc4OTAyNTE4NiwiZXhwIjoxNzg5MTExNTg2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJUQmRqU2xuWnlPb1JQYXVZeUVlb2UiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZO1541zLw_Yk4x3W-sisHYfIuvU4jimyoZ8YYoEMz3LI-2q52qF5XbGPTegWu73RddS4MMsW0YpicTwIMhj2QL_ZRO1lNKjreNB2iHJmX-SM-SY2zdcZlPsrol5JXzB2wS7D_pUTM7Rr7jLMijFe_T5PI8Pta93xocOlrt8XX2DaOzQ73nI8EJ5EFJEwLiJ9SKXCoJyC5YXkRImVfO_-R31XSDk8T-6JPWu_wLeDrVp5FyM-q5pljCMrRDS1LMyqBLeR7P_OstCB6XqrkxRfojPSdNcPG34TXyZqIaCDas0t8Ec7D-tPO5J1tpiAZfvq52AXmrPAYTWiu4_2x0bSTtgF_ZQW8uiUGyLs_mQmbiCUlQZJ04YSFCM40fgoS4SL_SBZx3iIAbBroAWohEHDj2hRG8M8pmn4iTkC1V6q_7QWREX86sCuo5JscbPbx_1u47TsoZUUUi1OwhAzRmAQ6yZOqEZ81XSi2fkJR3jDJPmWoJmWH-h1ZgqNxdMTeTYTJUxjBj65jnWnxT26gwUyRk5iQmOGzeulWQPi1csPqW0y9PNLYiK68zDzPtNraIsI6IGq0GjbQS5ySS9gJuA_VGty8MPo2J7hF_E0Lpm_pW9_7AY-uCZo0yA9emS5OEqZLHMHN2RghWZyPf1iieUDKxPpVJIq_fQtvkOvekRNJEg
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 3
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4774

{
  "id" : "dsg_7igWtQen8WABE6JZH4zBkI",
  "name" : "Example dosage",
  "dosed_at" : "2026-09-10T07:26:26.836576Z",
  "comments" : "Fa8giIHD0U",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "8.86",
    "display_unit" : "mg/kg",
    "display_value" : "8.86"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "12.96",
    "display_unit" : "ml/kg",
    "display_value" : "12.96"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "26.59",
    "display_unit" : "mg/ml",
    "display_value" : "26.59"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "39.90",
    "display_unit" : "µL",
    "display_value" : "39.90"
  },
  "study" : {
    "id" : "sdy_7Bxyztx4YkDTOH9hk2WzGh",
    "project_id" : "pjt_ZS6zLmRhk5H9ictuhvujt",
    "name" : "KDaoAoUCbv",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6XJbiNfKrGOqj7c1QPzvbU",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "vNNSSyrIAC",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_7PujWCOJWbXTMU9RJKDZtE",
      "name" : "jxBNykfVNm",
      "email" : "XGBhMCCJ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3Ok94HlsSZTx2Ob4SWsWjy",
      "name" : "awpzFGWdTi",
      "email" : "CxvPX2R9@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:26:26.133821Z",
    "updated_at" : "2026-09-10T07:26:26.133821Z"
  },
  "animal" : {
    "id" : "aml_7Sk0HL8oGjR8KefXzF3H1E",
    "study_id" : "sdy_7Bxyztx4YkDTOH9hk2WzGh",
    "study_group_id" : "grp_6NCA43dkcZlFOXLwR4f7AS",
    "cage_id" : "cge_LMmWKmUNM4EQMB3B2T54c",
    "catalog" : "A0000001",
    "name" : "JDM16FwXrf",
    "number" : 1,
    "strain" : "VlqBoeYRN1",
    "species" : "gNQ29ZrwOR",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "Gu8G7zGbxY",
    "ear" : "kTPscBAEuJ",
    "tag" : "uxGa134IDB",
    "donor" : "66wEn8eQ0q",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_UVfs0FSv29kAGvJ2KgQGR",
      "name" : "3aBPAAJ8jb",
      "email" : "aQYHaWIm@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7bbYyLC45K6eoMaxmZYIIc",
      "title" : "Found dead",
      "comment" : "buDUIrmShv"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:26:26.647907Z",
    "updated_at" : "2026-09-10T07:26:26.647907Z",
    "disease_induction_date" : "2026-09-10"
  },
  "measurement" : {
    "id" : "mst_3UWEyBNznEXrtAYt1wo4lW",
    "study_id" : "sdy_7Bxyztx4YkDTOH9hk2WzGh",
    "animal_id" : "aml_7Sk0HL8oGjR8KefXzF3H1E",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_66CfW8HwFHO4kDzWV8d9lU",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_66CfW8HwFHO4kDzWV8d9lU",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-09-10T07:26:26.787544Z",
    "updated_at" : "2026-09-10T07:26:26.787544Z"
  },
  "user" : {
    "id" : "usr_BjG1jbn0AJn3JAbnW2X0o",
    "name" : "k67ae Overwatch",
    "email" : "gMMA68R6@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:26:26.080530Z",
    "updated_at" : "2026-09-10T07:26:26.080530Z"
  },
  "treatment" : {
    "id" : "tmt_dJjKcM6yh7l552L5cR0s",
    "study_id" : "sdy_7Bxyztx4YkDTOH9hk2WzGh",
    "type" : "volume",
    "name" : "Poll0J7jvh",
    "label" : "Test Treatment Label",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "created_at" : "2026-09-10T07:26:26.802942Z",
    "updated_at" : "2026-09-10T07:26:26.802942Z",
    "external_entity_id" : "55ZdwE4sbv"
  },
  "created_at" : "2026-09-10T07:26:26.836611Z",
  "updated_at" : "2026-09-10T07:26:26.836611Z"
}

List all study dosages

Returns a list of your study dosages.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/dosages

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of dosages to return per page.

page

The page of dosages to return.

Request

GET /api/public/v1/studies/sdy_3VDjwxylUvdDOxtmhGpndV/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwYzFiMzY4MS1hY2IwLTRmYWEtOWZjNi0wNjZlOTAxY2M4MWEiLCJqdGkiOiI5MWFjYmFhOC03NTY5LTRhZGEtOTc0Ni03Zjg2OTIwZWNkNjgiLCJpYXQiOjE3ODkwMjUxNzAsIm5iZiI6MTc4OTAyNTE3MCwiZXhwIjoxNzg5MTExNTcwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVXeGtuNlJBWndxaDJRdzYxbHZUSE8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.idq-7KrVhvK9UGg0ACVQYpbbgxZfpVxX7qJ2MrO6RJSODMHymJQO0oaZY3-SSUBRdawIxmZ6S5SdF_4jIuj_fOZvZ4Xsid_SZSHWRC5UtClBG3cy9MBFoL0mFs_EkSsbTMfnj7ZuiZC7RzGdMC89qbB8bntRJrc3OeASuCcB9Bdfr84VlK6puo__V0f5EAF1-uWJ1nL-28ICv29OVdjkDEdZtUmhi-pNrszYjTSY-4mDNHrkcg0j15p3YW4HBT5Vf6MEgfZr3Af7-QJNYPoBieaN39hyPnzO7btWattu5hqoY2tsrXDPLNZUUrCW9eMDfouzYBK3Fmx80n9hfLMT8kuDCofcR3GDlSQfIWk7RlktZjViwvoMw3QG4I99F8Iax8WcbOsyKVngBjXsBeZQBRk8OySZ7QR2l4KiuH6wHyLWqanzr7sRLL_9lOuaK00WW07j5QA4rpyDqvifUnXEJCBcrey8x3uVZpSVZ1tcBV015RIQFjqS9A9Qy-Gac46pjyP3adw6GbDob2ig6sjsLryfoUuwjWRgzomggWmGxTjxIY_Dy6LOoJDePyIHh6r8uaLQVorvrZeEPZfsaxqdQoGM4KlU0PkB5L-WO4c88XB6_bGFEQxoCeHBBGHnLXRDJftXMmPfd50E4dye6afcpF2UKk-yI_Z-C5kXxcAro3k
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 19
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5643

{
  "data" : [ {
    "id" : "dsg_6qLqkgBYzkPYqBuk9V3o02",
    "name" : "Example dosage",
    "dosed_at" : "2026-09-10T07:26:10.416600Z",
    "comments" : "FZbiQceVa6",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5.12",
      "display_unit" : "mg/kg",
      "display_value" : "5.12"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "12.49",
      "display_unit" : "ml/kg",
      "display_value" : "12.49"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "25.47",
      "display_unit" : "mg/ml",
      "display_value" : "25.47"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "34.86",
      "display_unit" : "µL",
      "display_value" : "34.86"
    },
    "study" : {
      "id" : "sdy_3VDjwxylUvdDOxtmhGpndV",
      "project_id" : "pjt_4BTjqrgeUkwWnbiuLoEfwW",
      "name" : "PVXLpCwk38",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_33Q278FhRQwVLmgjDlgaRj",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "8yvcCj6IVD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3NqahevSg2PlRIzmBogLFf",
        "name" : "oYGiCWr9ee",
        "email" : "6LQoROFL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4UjzLLl8rrtBKky8LZB79N",
        "name" : "z72cLprH0k",
        "email" : "zXAAKc25@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:26:08.759174Z",
      "updated_at" : "2026-09-10T07:26:08.759174Z"
    },
    "animal" : {
      "id" : "aml_4y9QRFxsiNvFOgubifNO0g",
      "study_id" : "sdy_3VDjwxylUvdDOxtmhGpndV",
      "study_group_id" : "grp_1NJskfawdRrEQ8ss5yUMk9",
      "cage_id" : "cge_7UpA9AQmc2vfMMM4ykSdl7",
      "catalog" : "A0000001",
      "name" : "AeCkU3E6Kh",
      "number" : 1,
      "strain" : "FlIafIdux9",
      "species" : "PJ2Ksd0U9F",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "Dd7nlCUxvi",
      "ear" : "wGelLjYxwp",
      "tag" : "s377BFxWH9",
      "donor" : "LyqCFIzIGW",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_377RYOD4mDNZB84vMm74sl",
        "name" : "xWV7Gxabty",
        "email" : "Kxll4udj@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2PJ6XLfE8vgdrv78kflEkF",
        "title" : "Found dead",
        "comment" : "cMePeU3ZfX"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:26:09.809391Z",
      "updated_at" : "2026-09-10T07:26:09.809391Z",
      "disease_induction_date" : "2026-09-10"
    },
    "measurement" : {
      "id" : "mst_2R4lsqTSMmrVYLPOENzGW9",
      "study_id" : "sdy_3VDjwxylUvdDOxtmhGpndV",
      "animal_id" : "aml_4y9QRFxsiNvFOgubifNO0g",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_70AVoLSIe1AJ0ssxUIrrl9",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_70AVoLSIe1AJ0ssxUIrrl9",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:26:10.190604Z",
      "updated_at" : "2026-09-10T07:26:10.190604Z"
    },
    "user" : {
      "id" : "usr_6fqGuD2GvZtxmPRMcf2tjA",
      "name" : "eZCYL Overwatch",
      "email" : "8gBFophN@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:26:08.308047Z",
      "updated_at" : "2026-09-10T07:26:08.308047Z"
    },
    "treatment" : {
      "id" : "tmt_1P231E53XI7iQdaqxyJy1C",
      "study_id" : "sdy_3VDjwxylUvdDOxtmhGpndV",
      "type" : "concentration_vgkg",
      "name" : "kFH0CKg5QP",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "created_at" : "2026-09-10T07:26:10.288760Z",
      "updated_at" : "2026-09-10T07:26:10.288760Z",
      "external_entity_id" : "yteEWB3O3Y"
    },
    "created_at" : "2026-09-10T07:26:10.416855Z",
    "updated_at" : "2026-09-10T07:26:10.416855Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_3VDjwxylUvdDOxtmhGpndV/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_3VDjwxylUvdDOxtmhGpndV/dosages?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_3VDjwxylUvdDOxtmhGpndV/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete study dosages [BETA]

Deletes one or more dosages from a study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/dosages

Parameter Description

studyId

The unique identifier of the study.

Request fields

Path Type Description

dosages

Array

List of dosage IDs to be deleted.

Request

DELETE /api/public/v1-beta/studies/sdy_7eeEQI7qBePaJ8pBA90qqO/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NDZhOTczMC1iNGFhLTQ5MzQtYmE0YS02NDJjMjUzYjcyYzIiLCJqdGkiOiIyZDg5NTU0Ni05MjllLTQ0MDctYTY4Mi05OWE3M2ExMTBmYzEiLCJpYXQiOjE3ODkwMjUxNzMsIm5iZiI6MTc4OTAyNTE3MywiZXhwIjoxNzg5MTExNTczLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN2SndLTFJhOEkycEFiOUpXSnJFYW0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.DCivh13QSVVjYL7kDRdhQ2uHeJ7YiDRnKuQ0QVTmDAk-1pOL2hE3ObqfiBe5zs6u-r95QURT6PxMyK2aic4gLmpxtOLAcUV14ZGgd2DUaYvbrs92D58qw6Q96pJwe-yHZAP3dR5G8UlNSvvkr6MYn4tagjJWDL7ZRZjZ8Gll34Y-vnBW_KK05dKt_0qrfpsgP3DlGRGmaJeKDjYbV5gTCEIynuik9a7eHbOwYqf5aThmnuvgurQnIZeDP_YEzqx5nGsRh1o8Rt5MviZL8TGJqVdtzdAjv_fTxYRnVBud1uKNTklem0cbcJim0vFJGWWn6g4FmPxs9HyJydUW2Odtq7vzaNAdHRwLjGpiNzloJIPVIZceLEfcSdB-U9Bs4ztqHMRscMKqyRWvSK9kOOZRoXWDBPu9-qQdb_qT39Vo7E2dELIU5BiMS0KXyZeeKeHAtEhTKUQtZLBbTXmVDj6IS920uQ8PFb4pGS5SXWtZgGBCXdqcleOHcdqcQCTxnb-t2dV5tBsamEDp2GLfqBiCX0uyKv_L6AUgomExShTNxo5aXsdib4twH2nvFRwCxB9GyQchodT0ijzwQzNuysmHs9OOo3_3mF2R3dtaOSJZ9OJFc_BENP1P5nK8OtPlxzt-xMcnPNSi3ce_ubXp7pV3NzmHn0PmyTgSSAr4zct2cTI
Content-Length: 80
Host: localhost:8080

{
  "dosages" : [ "dsg_5yHEtRFngAvtq2cSsjYdVr", "dsg_2TH2ky3CXaiP6GfrGWcOTi" ]
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 16
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Study Measurement

This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.

Attributes

Path Type Description

id

String

The unique identifier of the measurement.

measured_at

String

The measured at timestamp of the measurement.

calculations

Array

The calculations associated to the measurement.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the measurement.

updated_at

String

The last updated timestamp of the measurement.

calculations[].variables

Array

The measurement calculation variables.

Create study measurements [BETA]

Creates measurements for one or more animals on a study. Each item in the request specifies an animal, a measured date, and the measurement variables to record. Derived calculations (e.g. tumour volume) are computed automatically when all required inputs are provided.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/measurements

Parameter Description

studyId

The unique identifier of the study.

Request

POST /api/public/v1-beta/studies/sdy_60ityvwCMD4oPe43dSejwW/measurements HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNWFiNDM5Yy0xNDZkLTRmNGMtOTU0Yy1iMzlkNmUwNjUzYzMiLCJqdGkiOiJjOTE5M2Y5MS1lZmY5LTRiN2MtYTc1Yy1hYmRhNjgwNTRjMTAiLCJpYXQiOjE3ODkwMjc2NzEsIm5iZiI6MTc4OTAyNzY3MSwiZXhwIjoxNzg5MTE0MDcxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZvM3g1dzU4R1YzdFY0MGJCTUh5djUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.U5KX8X4SgAYDyWKIexWKW2fKpAYNyfa8h3rrtsi90R4ciea0lPl_CwMhraQgEBpScSq7CGl9fCof047Hey0lENbLysv1MLFZHUzvM8Ay11NunPYDDS_tEdrxj2DYgji2h7UVTzNuUZxPo2vJe5Nb-KfmfGmBvXW8F5-cORQWvf7NrQVh7TvEAx01CsjplQ6T9m6DIbb6g5L_Z7ytuvyov1klwJ3Z-9P178468qZ73nA5-zp7bFAVPWfDWKY6G2fBToO2E1dHU-kllgjTmLRSuXzp2E3zmAUC0QesBSkNrzS2ONnENTMF4zIDDrxbrvgzv_cf_XR2tQi3XVGrIgMlSEXJgxFG2SyDuf_fqMj39y64Mm-tYJ8R8Bgllc31RmnNwoj8NyM9qevnn5inJAhM2Wz13lyFHbX55jT8oTzkHyyKGVClYyNp1sbnA-HiN2_F2FnHXt6tIZ1Hpo5IayTV9eA2trIlw-JG3naEa-xZl-CYuPNX703F_qBxKi3HWBC4QR3pGEuD2snMHGZ7bzBCfNjjqsBjVHZ8ws0ivxtiyCPAXO9mPSJ_hb_NSSHzcJgUvUApzYI5sRGf9poIqxon4AUbFMc3ZglwMWMDlIWxBrETbeUBei8bDRh2sW2HCBJDR7dQ7L29hsNWJNa6M17lg7SB5B9fO0cvKq3l8V4PwnY
Content-Length: 742
Host: localhost:8080

[ {
  "animal_id" : "aml_6DmXk7TmgOLdyKRIbvFHzE",
  "measured_at" : "2026-03-25",
  "calculations" : [ {
    "key" : "weight",
    "variables" : [ {
      "key" : "weight",
      "value" : "5"
    } ]
  }, {
    "key" : "tumour_volume",
    "variables" : [ {
      "key" : "length",
      "value" : "3"
    }, {
      "key" : "width",
      "value" : "2"
    } ]
  } ]
}, {
  "animal_id" : "aml_3rTrcBCVS53UsPStnNfX4N",
  "measured_at" : "2026-03-25",
  "calculations" : [ {
    "key" : "weight",
    "variables" : [ {
      "key" : "weight",
      "value" : "3"
    } ]
  }, {
    "key" : "tumour_volume",
    "variables" : [ {
      "key" : "length",
      "value" : "4"
    }, {
      "key" : "width",
      "value" : "3"
    } ]
  } ]
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 9
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5227

{
  "data" : [ {
    "id" : "mst_kIv6XsXvfHZiD61rR4jGd",
    "measured_at" : "2026-03-25",
    "calculations" : [ {
      "id" : "vbl_3yyLq2ZA0rmeoPatkscN5u",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "6",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6CNmwZ3RWM2LxqLqAqbU4W",
        "key" : "width",
        "value" : "2",
        "unit" : "mm"
      }, {
        "id" : "vbl_7CBOQIrZG2OWCm5id68A45",
        "key" : "length",
        "value" : "3",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1E0xGWgWyhhZVKeEioAOdy",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "5",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1E0xGWgWyhhZVKeEioAOdy",
        "key" : "weight",
        "value" : "5",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_60ityvwCMD4oPe43dSejwW",
      "project_id" : "pjt_70FOY1AKBqA73AC5VRvSun",
      "name" : "BAgM708tO4",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ePVhtKrjVIXU1q8gTUD3u",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "Sgu5JNiBVV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:51.194362Z",
      "updated_at" : "2026-09-10T08:07:51.194362Z"
    },
    "animal" : {
      "id" : "aml_6DmXk7TmgOLdyKRIbvFHzE",
      "study_id" : "sdy_60ityvwCMD4oPe43dSejwW",
      "study_group_id" : null,
      "cage_id" : "cge_7S2pplbI1OZT8bLBihvc9m",
      "catalog" : "A0000001",
      "name" : "FVH3uwO2ea",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "wirhnq8Fl4",
      "ear" : "5GF1ZiwzUM",
      "tag" : "73YVgH6jjb",
      "donor" : "giiQb4rR9X",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-09-10T08:07:51.242363Z",
      "updated_at" : "2026-09-10T08:07:51.242363Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-09-10T08:07:51.317192Z",
    "updated_at" : "2026-09-10T08:07:51.317192Z"
  }, {
    "id" : "mst_5ojLxUZJywts3g4P24m6Dp",
    "measured_at" : "2026-03-25",
    "calculations" : [ {
      "id" : "vbl_6tXgqWUJnbLZLEzQ3LJUZd",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "18",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6xTRj2HzNnQw5Zm0HVnjj8",
        "key" : "width",
        "value" : "3",
        "unit" : "mm"
      }, {
        "id" : "vbl_1nNGFP3RTs7bryKaCUlG5H",
        "key" : "length",
        "value" : "4",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_7K0tB0NOANiWy6dbA6TcKg",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "3",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_7K0tB0NOANiWy6dbA6TcKg",
        "key" : "weight",
        "value" : "3",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_60ityvwCMD4oPe43dSejwW",
      "project_id" : "pjt_70FOY1AKBqA73AC5VRvSun",
      "name" : "BAgM708tO4",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ePVhtKrjVIXU1q8gTUD3u",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "Sgu5JNiBVV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:51.194362Z",
      "updated_at" : "2026-09-10T08:07:51.194362Z"
    },
    "animal" : {
      "id" : "aml_3rTrcBCVS53UsPStnNfX4N",
      "study_id" : "sdy_60ityvwCMD4oPe43dSejwW",
      "study_group_id" : null,
      "cage_id" : "cge_3xaAUm0sj9bNt5ocfbpLnw",
      "catalog" : "A0000002",
      "name" : "fQX73kBEoo",
      "number" : 2,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "tFKMZGHv8o",
      "ear" : "L8nTbHHe4k",
      "tag" : "qCDq0woMgt",
      "donor" : "CbI7E6CL7P",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-09-10T08:07:51.253775Z",
      "updated_at" : "2026-09-10T08:07:51.253775Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-09-10T08:07:51.317192Z",
    "updated_at" : "2026-09-10T08:07:51.317192Z"
  } ]
}

Retrieve a study measurement

Retrieves the details of an existing study measurement.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/measurements/{measurementId}

Parameter Description

studyId

The unique identifier of the study.

measurementId

The unique identifier of the measurement.

Request

GET /api/public/v1/studies/sdy_5vdPo7AXrsrkdWQ1GyRzOf/measurements/mst_2YL7oUndrtkzOHFKDykJ0Y HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZjJhMjNjYy1hZjY1LTRiZDUtYTlmZS0xMTgzNTE2Yjk1YzMiLCJqdGkiOiI1ZGFjNzEyYS0xNDNjLTQxZTgtODg2Ny1jODgxYTIyZGY0NTIiLCJpYXQiOjE3ODkwMjc2NjcsIm5iZiI6MTc4OTAyNzY2NywiZXhwIjoxNzg5MTE0MDY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVDaWJOd2VROTBCSGhkNndWMkpMem4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ehFRKt8zy96_S3VyR3HODyR4CJQ6n-JaCn0KkHzbGeSBnpIzYY0CWAPkSf9hddysnbplBCv9uJNnk2VU8XKkk5R93rfqjegiYQCgeUG_mMNhoP7A-C0rK-EkpdpyfCaMpVbm11oOKDTB97B0TZVaWD5b1VTZm8SKQMv0XJPKAds_JPC3p1cXrcYJr5MMaLFpKODAD605j4sgwwADgXzJRfJye47ovJWORtKHR9XDoU8KWI8M_Kj9KKhvaow_eHU8kS2mIzxLlargCyNWpoNHgn53BEDasJyH47Ht-Su5LqbZkUbeuXLQgGTOUoqnAIbszKOKV1LD6SqwvJzJrEK8PzVOWeIOqLjXJFAD6BePbe34ZCov-OtF31C10Fqb5Tjj-Nb_GsNm_U2i7zS2XCGw0xTycu7KxmrzksrEJZXTCL-GUK1Jwooo5JL4WjTksveaMLAzJfgLItBe7I1eWCpg86SJASEcw1Chprj0Yr_95YMWgrVzp6AvgrZLMeuEeQu3OvZLAyeoRPdv92-DcMd_39Wz5PLxrO7hs64dAqeJjS7Pp_sMb-wVJUBso4wdfdDpQo-DeRv0jXuukzKlvWj-u4cA8Y1k0usTH01n6WlzTJNxRdpd2urifhGtxEQ7MQYBWYDHLYxO7SEB3NNwDWC8B-Ns_0DKhxc9Nu5BVi_2-wk
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3400

{
  "id" : "mst_2YL7oUndrtkzOHFKDykJ0Y",
  "measured_at" : "2026-09-10",
  "calculations" : [ {
    "id" : "vbl_3qmP2pJkg7aDaNkKEU7L2T",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_6G0qd1REIEQrvPgBXJD5qT",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_63datGuhUc7JUEaP4gPdgu",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_1Y3z1RubqvA4FhHLxigCci",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_1Y3z1RubqvA4FhHLxigCci",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_5vdPo7AXrsrkdWQ1GyRzOf",
    "project_id" : "pjt_7bvPdUB9klvvGofhxfQHQM",
    "name" : "2yDCQ3bGuG",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5VuUfY6PR37KB3RvejR7Jn",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "7eSDdudFNZ",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2SGM3yVzJ3s4gzGA6ea6KF",
      "name" : "Z9k2zCo3Im",
      "email" : "eYWMtFV7@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6f2RdncoqlXJCMpT4Iv4Za",
      "name" : "3a7OTGG9aw",
      "email" : "hOe1DNUN@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:47.376595Z",
    "updated_at" : "2026-09-10T08:07:47.376595Z"
  },
  "animal" : {
    "id" : "aml_36W7DP4iePjScvSQjGyYyE",
    "study_id" : "sdy_5vdPo7AXrsrkdWQ1GyRzOf",
    "study_group_id" : "grp_xTEXI00WsOsxvgoixO9DO",
    "cage_id" : "cge_6ip1CduMy7gKE18ys6ey5c",
    "catalog" : "A0000001",
    "name" : "N0WB7niWZU",
    "number" : 1,
    "strain" : "0PPlYQRcGC",
    "species" : "UHJamzAaFF",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "Pjflqo973L",
    "ear" : "s2i5Cbe7iL",
    "tag" : "LrdgPOa6Dr",
    "donor" : "zkGwerrXg5",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_6UzlZMCxi1I2qwAeo51Wcn",
      "name" : "TStyAIpfLT",
      "email" : "vX2wyjm3@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_28q1jUCEobf4ehnla1JwK0",
      "title" : "Found dead",
      "comment" : "LRY1jDcZUn"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T08:07:47.632801Z",
    "updated_at" : "2026-09-10T08:07:47.632801Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_1sEGxDYwvNPVUTsa61ESGX",
    "name" : "mDCQy Overwatch",
    "email" : "dPD0GV7s@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T08:07:47.309879Z",
    "updated_at" : "2026-09-10T08:07:47.309879Z"
  },
  "created_at" : "2026-09-10T08:07:47.797425Z",
  "updated_at" : "2026-09-10T08:07:47.797425Z"
}

List all study measurements

Returns a list of your study measurements.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/measurements

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of measurements to return per page.

page

The page of measurements to return.

measured_at

Filter measurements to return by date (yyyy-mm-dd).

Request

GET /api/public/v1/studies/sdy_2OKRvDtUrCGq01KQ5mna6h/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3OTFjODU5My0zY2Q4LTQ2MmYtYjA5Yy1kZmEzZjUzOTc1ZTMiLCJqdGkiOiI0NjU2MjFkNy1kY2I0LTQ2NWMtYjc2MC05MDI0ZTlmNjY5YjgiLCJpYXQiOjE3ODkwMjc2NjQsIm5iZiI6MTc4OTAyNzY2NCwiZXhwIjoxNzg5MTE0MDY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdVTklQTlZzcjNHSE12WVFZOEs0cE8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.g9EpjPfrdbxvdrkQ8QwK6ZQp2IwbMdK_G0_aaXOw1yZVt2BtAjWakhyo-Ruxa9x21b60Pmc25UdDeuUotodjidkuvkwebpc52av9UQ1VQtoViUsFxL6mF1p0cBSsX8Ktv2I2L1IfXguIgQ2RsF1DJuyMplfSRSgaCUCny3R02NdHSP6_tlI_zLc_b0jDf-ZjnIzL3lc3FrV7xuur2JEyxBQAeSrX0VkneYP7uVwaFjKwV2-v3S2wlJQghKNSZYE8LP2eUkBWv3JktOnyz5VoSehjFHRGpvnhZ-BiDlHL-CrE_dhSG4yBF6Ju0FtpZt2Y08J6EZaLQR-lPlSGaXXlOuQKr8xAkOSTSoM5GLUM2kMpCSD21ols0kHX-8cMYYThc_BYH5TRHs28hkJR-rnZtLjJC6wfD193SOLx8Ml6yTi4SdOXeOLyx6hbe5Oy1Lk2sH1FZNPRpbNnGpjmsFM7tTVmCVsOAUJE-V9omSQ9Xpw4jWungbJCOWvEUJ7tNP7WrYoFOevt1TYOmAo5fhZehohgSWVkJAdb_i2HwZqvCndu7T7sHH2wN9shg9Hd3slEST5RGFpWr-9h3HUnriPXPnV0QUv9GSGQ7PHv2saPKpkUYN8wY9RwQchSz3obQ7o2ZdVzeNt8x1UKdINE8RkNfN8ae4AnFoK844HdJ7vF9pQ
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 16
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7800

{
  "data" : [ {
    "id" : "mst_ZiJlloLZYFfU2r9bKj5VN",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_7isi9GuIcYjJfZhavra0jQ",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_13VGsnok7WNoX7BqRdk3D6",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_2s32P7cFXccBUCLTMdEykN",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_JoEYLAelqkABCMWPITSVx",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_JoEYLAelqkABCMWPITSVx",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2OKRvDtUrCGq01KQ5mna6h",
      "project_id" : "pjt_y27JDZq5L8HtlQQktTRVP",
      "name" : "eTsXOvpawH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5ZQ0zvEpTSxpEJPUcE0xXp",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "qGclnuj8K9",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4Na3LIMhlUWZpkUz4tCjnS",
        "name" : "e4plJpVpaA",
        "email" : "dVsWEBs7@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4B867CcgJLiv4jBm9qdZH6",
        "name" : "1xZ6tOr2ac",
        "email" : "3scy3TcG@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:44.405775Z",
      "updated_at" : "2026-09-10T08:07:44.405775Z"
    },
    "animal" : {
      "id" : "aml_57E7s0MJ3i4a7cC8AbemVt",
      "study_id" : "sdy_2OKRvDtUrCGq01KQ5mna6h",
      "study_group_id" : "grp_7hAtMCuxqLxaVMcB5O7PGm",
      "cage_id" : "cge_5Gc3OpjO9UBBDaoCQ6LvDA",
      "catalog" : "A0000001",
      "name" : "b1UtKus2pm",
      "number" : 1,
      "strain" : "MIQIWUpMdP",
      "species" : "MqXHlhDol4",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "iaGycTBt6z",
      "ear" : "6TSagk2F3N",
      "tag" : "IVVQv6ZHPq",
      "donor" : "6vUNF0UdXt",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2IatwMPkEtTwoZRURBFMfs",
        "name" : "ZY6P5tpzd6",
        "email" : "6SXk5Qn8@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1AzFi7cky70hufnIr6GNPc",
        "title" : "Found dead",
        "comment" : "c1C9rWhcSo"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:44.761530Z",
      "updated_at" : "2026-09-10T08:07:44.761530Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_4lKtxmEpS7wWDImptgZ551",
      "name" : "VPLTM Overwatch",
      "email" : "NBXDZqKZ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:44.376242Z",
      "updated_at" : "2026-09-10T08:07:44.376242Z"
    },
    "created_at" : "2026-09-10T08:07:44.863400Z",
    "updated_at" : "2026-09-10T08:07:44.863400Z"
  }, {
    "id" : "mst_3cD9cshyJtuSNZXXo4nEx1",
    "measured_at" : "2026-09-09",
    "calculations" : [ {
      "id" : "vbl_4DwmYRgv82jukBXdT7wKf4",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_72TVMKlt0PDuzxwvcs6Jxp",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_4ZsWHmVPKdBIDzSYFD2ZJb",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_3nJ2Tndl8BA6lWB1sk0zKr",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_3nJ2Tndl8BA6lWB1sk0zKr",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2OKRvDtUrCGq01KQ5mna6h",
      "project_id" : "pjt_y27JDZq5L8HtlQQktTRVP",
      "name" : "eTsXOvpawH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5ZQ0zvEpTSxpEJPUcE0xXp",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "qGclnuj8K9",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4Na3LIMhlUWZpkUz4tCjnS",
        "name" : "e4plJpVpaA",
        "email" : "dVsWEBs7@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4B867CcgJLiv4jBm9qdZH6",
        "name" : "1xZ6tOr2ac",
        "email" : "3scy3TcG@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:44.405775Z",
      "updated_at" : "2026-09-10T08:07:44.405775Z"
    },
    "animal" : {
      "id" : "aml_57E7s0MJ3i4a7cC8AbemVt",
      "study_id" : "sdy_2OKRvDtUrCGq01KQ5mna6h",
      "study_group_id" : "grp_7hAtMCuxqLxaVMcB5O7PGm",
      "cage_id" : "cge_5Gc3OpjO9UBBDaoCQ6LvDA",
      "catalog" : "A0000001",
      "name" : "b1UtKus2pm",
      "number" : 1,
      "strain" : "MIQIWUpMdP",
      "species" : "MqXHlhDol4",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "iaGycTBt6z",
      "ear" : "6TSagk2F3N",
      "tag" : "IVVQv6ZHPq",
      "donor" : "6vUNF0UdXt",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2IatwMPkEtTwoZRURBFMfs",
        "name" : "ZY6P5tpzd6",
        "email" : "6SXk5Qn8@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1AzFi7cky70hufnIr6GNPc",
        "title" : "Found dead",
        "comment" : "c1C9rWhcSo"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T08:07:44.761530Z",
      "updated_at" : "2026-09-10T08:07:44.761530Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_4lKtxmEpS7wWDImptgZ551",
      "name" : "VPLTM Overwatch",
      "email" : "NBXDZqKZ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T08:07:44.376242Z",
      "updated_at" : "2026-09-10T08:07:44.376242Z"
    },
    "created_at" : "2026-09-10T08:07:44.869172Z",
    "updated_at" : "2026-09-10T08:07:44.869172Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2OKRvDtUrCGq01KQ5mna6h/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2OKRvDtUrCGq01KQ5mna6h/measurements?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_2OKRvDtUrCGq01KQ5mna6h/measurements",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Study Observation

Retrieves the details of an existing study observation.

Attributes

Path Type Description

id

String

The unique identifier of the observation.

glossary_id

String

The unique identifier of the glossary item.

team_glossary_api_id

String

The unique identifier of the team glossary.

team_glossary_id

String

The unique identifier of the team glossary.

title

String

The title of the glossary item.

label

String

The label of the glossary item.

text

String

Text related to the observation.

type

String

The type of observation recorded.

value

String

The value of the observation taken.

observed_at

String

The timestamp of when the observation occurred. This value can include a timezone postfix.

study

Object

The study of the measurement.

animal

Object

The animal of the measurement.

user

Object

The user that recorded measurement.

created_at

String

The created timestamp of the project.

updated_at

String

The last updated timestamp of the project.

Create study observations [BETA]

Records one or more observations against animals on a study. Each entry in the request array targets a single animal via its animal_id.

To record a normal observation, set team_glossary_id to your team’s Normal glossary and omit value. Normal and other observations can be mixed in the same request.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/observations

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

animal_id

String

The unique identifier of the animal being observed.

team_glossary_id

String

The unique identifier of the observation team glossary entry.

observed_at

String

The date and time the observation was made. Must be a full ISO 8601 UTC date/time: either an explicit UTC instant (offset 'Z' or '+00:00') or an offset-less date/time taken as UTC (e.g. "2026-03-25T10:00:00Z" or "2026-03-25T10:00:00"). A date-only value is not accepted and non-UTC offsets are not allowed.

text

String

Free-text notes for the observation.

value

String

The observation value, required for numeric and severity glossary types.

Request

POST /api/public/v1-beta/studies/sdy_4dJTD8inDXE60UpmXZY9dx/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4NTk1NjQ2MC0zMmQ1LTQyOWYtODQ3MS01MDNlYzVmMGY3NzkiLCJqdGkiOiJiYjAzYTBlZC0yNWE2LTQwZGQtOTBkYS1mMWMxNGUyYzg1YzQiLCJpYXQiOjE3ODkwMjUyNDYsIm5iZiI6MTc4OTAyNTI0NiwiZXhwIjoxNzg5MTExNjQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZWaXZobEZ1a3RXOWdvdkFRM2hrc3AiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XdSQv9qnrXzJ6e-UbwIQn7SaLVQofQl5jLEZ8NE0SJeZsIJWd1NZWHjHsyiemcIHG4coZ_NtvHXRBm4Jw7Z52QA5LWCKFSuTDL2gw0vov2lzzJcnCIAvFsUj_TD05TIs8LManc3lfjWSU_AzuhB29Tu6Efvk-u6WKgQfT0yaRng3Oa1sqSWU3BFRoqMMzHgWALiVJumfZOCV-99ljqxcuWnUfV_sqkW0UtJQBE9rmk069R1sXwgGLFfq5BZF39sDfJZ9FPa7aPbHmAxh_8pmLy8nYQZEGLZz3ePxkFaKEJxoyVuWt6oM0SFbuauom5jLUf9sjqazYYKR9BvAWLxzFHNDJtb0trd7MyZ_Uqbpma0T_LLOJLY0z2n4l66wloE1l8ZiIh_6TEbMHkbQ__YHs9r2Vm5qMsxLQN-nZ6h_LPLCXly2cYhA5ze4LD3CzBSN0_WBPxPmkiHPBCB82Hw15PBfd4eP7jeQWTCDbcx5zzHYqxfystkyrlvjZ_GCXVxsTNs3EEuYKbYrAt1-Ku7pE0_2ysGcPDRwOAk6ZIyKGVig0apLKWBtTRew_Duh7V7PocIwLcniLh2IdBxvzoz9PSMMj2PT0RmvfRkSytnE_DvGqEUGDrk6pxF5fCBOT3Hk4y-WV2yAfElWGQF28ZZl9FePb8AD1MNGT6e90OZAf6k
Content-Length: 621
Host: localhost:8080

[ {
  "animal_id" : "aml_5ID6bo775VOT7LsS0NudlX",
  "team_glossary_id" : "tgy_3jedIYdXW85LEFJJRNgYDT",
  "observed_at" : "2026-03-25T10:30:00Z",
  "text" : "Animal appears lethargic.",
  "value" : "Severe"
}, {
  "animal_id" : "aml_5ID6bo775VOT7LsS0NudlX",
  "team_glossary_id" : "tgy_6pUlP104tXz7r1baXrYsQo",
  "observed_at" : "2026-03-25T10:30:00Z",
  "text" : "Measured with calipers.",
  "value" : "1250.5"
}, {
  "animal_id" : "aml_5ID6bo775VOT7LsS0NudlX",
  "team_glossary_id" : "tgy_6Xsk5Ao5pzyfZuafAllkOC",
  "observed_at" : "2026-03-25T08:30:00Z",
  "text" : "Coat condition looks healthy.",
  "value" : null
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7953

{
  "data" : [ {
    "id" : "obs_2QpihQqJh2uvTGIH6Ao58x",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_3jedIYdXW85LEFJJRNgYDT",
    "title" : "Body Condition",
    "label" : null,
    "text" : "Animal appears lethargic.",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-03-25T10:30:00.000000Z",
    "study" : {
      "id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "project_id" : "pjt_1ADjQEmGIpDR1pcBOuIyYy",
      "name" : "A8iVoJubTh",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ejEs0j7EokhF8cLiS62Jb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "YQcfvfOf1s",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_tLA4oH7YwDCOp6ehzw8BW",
        "name" : "O7dxpQVxQC",
        "email" : "n7MyU6vx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7kXyZnmJk4Xk7L9BYOVLnO",
        "name" : "1nrEBHnEAa",
        "email" : "YrtrUpPQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:25.991653Z",
      "updated_at" : "2026-09-10T07:27:25.991653Z"
    },
    "animal" : {
      "id" : "aml_5ID6bo775VOT7LsS0NudlX",
      "study_id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "study_group_id" : "grp_lTXXZyuQn8SMuMcZsZHVk",
      "cage_id" : "cge_41rGnyXSvm9Gy2d2FqovZA",
      "catalog" : "A0000001",
      "name" : "aNGFo9S2Bm",
      "number" : 1,
      "strain" : "mxZxEwTaYZ",
      "species" : "TUWCGZMgUi",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "ofKYL1EC30",
      "ear" : "El9Obhf7kW",
      "tag" : "TBvS65k8JR",
      "donor" : "Zys48CbMQ8",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2bti2DhFNu7oO7nDEdYAXG",
        "name" : "ErRB2Q2gNH",
        "email" : "nIBgqaf4@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_585EKOKvaGKdqyqqy7xN90",
        "title" : "Found dead",
        "comment" : "krPmoi1Lsb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:26.384555Z",
      "updated_at" : "2026-09-10T07:27:26.384555Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : null,
    "created_at" : "2026-09-10T07:27:26.694208Z",
    "updated_at" : "2026-09-10T07:27:26.694208Z"
  }, {
    "id" : "obs_ZR3eBO3ydYM6IYCNwVpcq",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_6pUlP104tXz7r1baXrYsQo",
    "title" : "Tumour Volume",
    "label" : null,
    "text" : "Measured with calipers.",
    "type" : "numeric",
    "value" : "1250.5",
    "observed_at" : "2026-03-25T10:30:00.000000Z",
    "study" : {
      "id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "project_id" : "pjt_1ADjQEmGIpDR1pcBOuIyYy",
      "name" : "A8iVoJubTh",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ejEs0j7EokhF8cLiS62Jb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "YQcfvfOf1s",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_tLA4oH7YwDCOp6ehzw8BW",
        "name" : "O7dxpQVxQC",
        "email" : "n7MyU6vx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7kXyZnmJk4Xk7L9BYOVLnO",
        "name" : "1nrEBHnEAa",
        "email" : "YrtrUpPQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:25.991653Z",
      "updated_at" : "2026-09-10T07:27:25.991653Z"
    },
    "animal" : {
      "id" : "aml_5ID6bo775VOT7LsS0NudlX",
      "study_id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "study_group_id" : "grp_lTXXZyuQn8SMuMcZsZHVk",
      "cage_id" : "cge_41rGnyXSvm9Gy2d2FqovZA",
      "catalog" : "A0000001",
      "name" : "aNGFo9S2Bm",
      "number" : 1,
      "strain" : "mxZxEwTaYZ",
      "species" : "TUWCGZMgUi",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "ofKYL1EC30",
      "ear" : "El9Obhf7kW",
      "tag" : "TBvS65k8JR",
      "donor" : "Zys48CbMQ8",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2bti2DhFNu7oO7nDEdYAXG",
        "name" : "ErRB2Q2gNH",
        "email" : "nIBgqaf4@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_585EKOKvaGKdqyqqy7xN90",
        "title" : "Found dead",
        "comment" : "krPmoi1Lsb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:26.384555Z",
      "updated_at" : "2026-09-10T07:27:26.384555Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : null,
    "created_at" : "2026-09-10T07:27:26.694208Z",
    "updated_at" : "2026-09-10T07:27:26.694208Z"
  }, {
    "id" : "obs_EFBxaNZfloMzEmxXX81s",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_6Xsk5Ao5pzyfZuafAllkOC",
    "title" : "Clinical Notes",
    "label" : null,
    "text" : "Coat condition looks healthy.",
    "type" : "none",
    "value" : null,
    "observed_at" : "2026-03-25T08:30:00.000000Z",
    "study" : {
      "id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "project_id" : "pjt_1ADjQEmGIpDR1pcBOuIyYy",
      "name" : "A8iVoJubTh",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ejEs0j7EokhF8cLiS62Jb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "YQcfvfOf1s",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_tLA4oH7YwDCOp6ehzw8BW",
        "name" : "O7dxpQVxQC",
        "email" : "n7MyU6vx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7kXyZnmJk4Xk7L9BYOVLnO",
        "name" : "1nrEBHnEAa",
        "email" : "YrtrUpPQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:25.991653Z",
      "updated_at" : "2026-09-10T07:27:25.991653Z"
    },
    "animal" : {
      "id" : "aml_5ID6bo775VOT7LsS0NudlX",
      "study_id" : "sdy_4dJTD8inDXE60UpmXZY9dx",
      "study_group_id" : "grp_lTXXZyuQn8SMuMcZsZHVk",
      "cage_id" : "cge_41rGnyXSvm9Gy2d2FqovZA",
      "catalog" : "A0000001",
      "name" : "aNGFo9S2Bm",
      "number" : 1,
      "strain" : "mxZxEwTaYZ",
      "species" : "TUWCGZMgUi",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "ofKYL1EC30",
      "ear" : "El9Obhf7kW",
      "tag" : "TBvS65k8JR",
      "donor" : "Zys48CbMQ8",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2bti2DhFNu7oO7nDEdYAXG",
        "name" : "ErRB2Q2gNH",
        "email" : "nIBgqaf4@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_585EKOKvaGKdqyqqy7xN90",
        "title" : "Found dead",
        "comment" : "krPmoi1Lsb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:26.384555Z",
      "updated_at" : "2026-09-10T07:27:26.384555Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : null,
    "created_at" : "2026-09-10T07:27:26.694208Z",
    "updated_at" : "2026-09-10T07:27:26.694208Z"
  } ]
}

Retrieve a study observation

Retrieves the details of an existing study observation.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/observations/{observationId}

Parameter Description

studyId

The unique identifier of the study.

observationId

The unique identifier of the observation.

Request

GET /api/public/v1/studies/sdy_1vfTGOd4QKoSuvvitFL8JE/observations/obs_Vg1eSTx80se2PJuD3Zy1p HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1OTcyNDQwNy0yMzgzLTQ2ODQtODUwNC1iNzNiMjIyNmJiYjQiLCJqdGkiOiI0MDU0OGQ1OC04YTYzLTRlY2YtODY3ZC04OGRlZWQ2NTM0MGMiLCJpYXQiOjE3ODkwMjUyNDEsIm5iZiI6MTc4OTAyNTI0MSwiZXhwIjoxNzg5MTExNjQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3NPTERiMTlOU1dqdzR1RldadjIxRSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.KZSI8AT6sRRpk_BGyhA77c_nSZa1O_yFBT4_xiI59lkQw3o5adukrhW6cbcVrJEuLPQ7i0rNalZkp-0n9vzt2vtUgs59HVfEkHMtoAJ37ve1AH-HJlvGPaAXn1BZs6z5dIqBBe90duUKaAOCx8a6uAvMbTC5ZyGSQ0io7tTPDgdBTSRex09jRuZvEM4_npa-AXs3sX4vpmzfcXhCjSVRkaUe2fgt34e8QHN97CSqOCMBzT9lAP6hv7qNs0-UVGiDW1hOiGQbVhGtdpWp09fazzGcrK6q6cXekEt2Vqq5hL-hd_BWB2K-LBgK9IYNfAu2ze98o39rC8yc5NQqcofQJBn2E4rVDF-NWPE_8ZTfIddtPEBt_cwsytp5HvVRw6Bww5uT7zcrUEuWCVO0pj8j5-jOoFLtMo5HUkedBv2rTWEgjkyeW9mJ6AgsWprGz5Bn37VhSwqx6lH6XrcQ0QtXfBM6nEOqlYuVgCXWpmamMJjB4AoCrsw9vpbHCbNaE1GoW3ua6EyuvwSRbmKC3oMX4asym5RAoGhBN_iW_zRg1bjhabFCsIWYpgP7wycSbh4VOID3GnXe1Yq76l8D5fbanPEHjg-W_9ZtL0LiKNeT8djGO8sNGjMg_fu3pTXm-wC_DfFuuziWPgwNXuUizmyqpHNokKOg6QOJdWy5ddk9qrk
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 9
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2808

{
  "id" : "obs_Vg1eSTx80se2PJuD3Zy1p",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_7Q3xOG7zAwAM0exhgzfqBy",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-09-10T07:27:21.062329Z",
  "study" : {
    "id" : "sdy_1vfTGOd4QKoSuvvitFL8JE",
    "project_id" : "pjt_2UPl5Kpz0F1mok4NAOFqxt",
    "name" : "jkyYFKKPj7",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2bA98Jh8iGVMh6EDdYFEpS",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "mvO7wiKIsT",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4GcqM5wIYl1KOsum5Sd0Kc",
      "name" : "6WHergOhiO",
      "email" : "AGGuM8xI@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1o2gOXYcBFHvzmkV5lxftt",
      "name" : "wbf2jmnLB5",
      "email" : "DDLwXA1h@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:20.278207Z",
    "updated_at" : "2026-09-10T07:27:20.278207Z"
  },
  "animal" : {
    "id" : "aml_187R8B86PZM0174eF1WqvP",
    "study_id" : "sdy_1vfTGOd4QKoSuvvitFL8JE",
    "study_group_id" : "grp_50o7g3SkW5yTfuQtl7fVQW",
    "cage_id" : "cge_2Op4INjRvV8mI3RbcvkEfC",
    "catalog" : "A0000001",
    "name" : "CaF094CnH6",
    "number" : 1,
    "strain" : "UVVT2hN4zJ",
    "species" : "CQ93qNgfVP",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "q6kGfiYjqr",
    "ear" : "6bgcv4n6md",
    "tag" : "ysJ8gei8FM",
    "donor" : "nczfXqMOSb",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_4honfoV2c4nPjnv4cpjgvo",
      "name" : "FlfAMNESHd",
      "email" : "FYk7QZ3S@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_14sweT3ZRgybZL1PpdRlOZ",
      "title" : "Found dead",
      "comment" : "KrHlkOysb1"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:20.840694Z",
    "updated_at" : "2026-09-10T07:27:20.840694Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_2QxK4ZqUMluVEaBEYGyigW",
    "name" : "qYKzd Overwatch",
    "email" : "HhKNGebY@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:27:20.221793Z",
    "updated_at" : "2026-09-10T07:27:20.221793Z"
  },
  "created_at" : "2026-09-10T07:27:21.062418Z",
  "updated_at" : "2026-09-10T07:27:21.062418Z"
}

Update study observations [BETA]

Updates one or more existing observations on a study. Each entry is identified by its id only the fields you include are changed.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/observations

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

id

String

The unique identifier of the observation to update.

observed_at

String

The date and time the observation was recorded. Must be a full ISO 8601 UTC date/time: either an explicit UTC instant (offset 'Z' or '+00:00') or an offset-less date/time taken as UTC (e.g. "2026-03-25T10:00:00Z" or "2026-03-25T10:00:00"). A date-only value is not accepted and non-UTC offsets are not allowed.

value

String

The observation value. Required for numeric and severity observations; must be omitted for free-text or normal observations.

text

String

Free-text note. Set to null to clear.

Request

PATCH /api/public/v1-beta/studies/sdy_1cMi2nLBKaSpFxM8FtZKW7/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NjFiMTExNy1jZWU5LTRkY2YtYjBkZi03NjI4MTJmMGE2MWEiLCJqdGkiOiIwYTUwNmQ4MS04ODBiLTQ0NWYtYjY1Yy1iN2ZiYzRkM2JmYzUiLCJpYXQiOjE3ODkwMjUyNDksIm5iZiI6MTc4OTAyNTI0OSwiZXhwIjoxNzg5MTExNjQ5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2cyVzRkRVhkT0NscXNKN1dBdUwxdiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.EIjPLy8_N18BevrGPRp-HoR9E8DSHM5oaAJjxGemVfhuQLTG75NBIFBD_65rwOWfsxlX3UpyuxGuWGGNhalFdS5XmP4zm74XlxpL4If7YuRTgf6Kdj79jfcVtsvGm0BkYEwNOlk6iJoOLfqwVIv8UPMKvaINiEH9jA6dfRBow1fNLdzPJ9A9TDxFTYdxlNVVHCI4dZt0ITjMi1dsQkq5Nl2enHX-uTy-jK5pwAUMK4UBUncRcgoLiGixUJyd7M_iqvI7TPbDCKJu_QvvKD8jZq6VCTiuZEMFnxKsdKj6vkk4DObvLyaNtilChvPIWyOExrtVNzbTMX1QNc3qIkKmLAbymxwrr0htSLGF4azBSF7RAGshcB7ryViE0pqjPAgy6jjpSPorwDvRtTffEtjVXkGc0p6Rj7UGGbvZ-3c80mFdv1M4u8gIJ1yXU5FCxW7YYmRu8efmmDC16R8EoE9SwaSGrscUSSGeFSZq19R5ZXRJzjBANaPsJ3LVZO8cksIspH_mIVuZP7WQHyTcmldmkaF2RznSyLKtZQqp8Fuk5zbn5YSLQ5YIsZ9fZUc4hkRssRRots2KL5me70XflLdainXyG_GPP9_gX_08p08yV__f-TQxDMR2ifocG2kgnBxp_UxCIEV0Iyf57AsfUbyBBMvwREJ2LvfgwE0zlL0hWUo
Content-Length: 411
Host: localhost:8080

[ {
  "id" : "obs_24WoIHvQoPUTq9VMvba5De",
  "observed_at" : "2026-03-26T09:00:00Z",
  "value" : "Moderate",
  "text" : "Condition improving."
}, {
  "id" : "obs_5deNaQNLS3Vwg6k2a1GHd6",
  "observed_at" : "2026-03-26T09:15:00Z",
  "value" : "1300",
  "text" : "Re-measured with calipers."
}, {
  "id" : "obs_4M3gj75nnHgUnPRXzK1J66",
  "observed_at" : "2026-03-26T08:00:00Z",
  "text" : "Coat still healthy."
} ]

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 30
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 8990

{
  "data" : [ {
    "id" : "obs_24WoIHvQoPUTq9VMvba5De",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_5CKVSRDhPKPlfhYxxADv3I",
    "title" : "Body Condition",
    "label" : null,
    "text" : "Condition improving.",
    "type" : "severity",
    "value" : "Moderate",
    "observed_at" : "2026-03-26T09:00:00.000000Z",
    "study" : {
      "id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "project_id" : "pjt_4O5CcyinMbj4e40PMKO3wZ",
      "name" : "ZCVFi29YAB",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TN5pI5saG20jQE3AOxIke",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "W6QvkVf4yO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7C8aoumoYswZf7oZgPZofo",
        "name" : "upaK55cKiu",
        "email" : "TgcAUzf0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_50E1F0Eys8qwE5Nm2lReZY",
        "name" : "cVEoDWtAeh",
        "email" : "KhERQ58Q@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:29.267872Z",
      "updated_at" : "2026-09-10T07:27:29.267872Z"
    },
    "animal" : {
      "id" : "aml_38CFsjqfi857xbtnlR68Um",
      "study_id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "study_group_id" : "grp_6OQBpfUCE85t98ahV9mQi3",
      "cage_id" : "cge_26TBh3enaV6QcT6nipDbHy",
      "catalog" : "A0000001",
      "name" : "KP4M12Bt8w",
      "number" : 1,
      "strain" : "rZpoCmXc0e",
      "species" : "NcIx5SmvH2",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "xcY6W7TKfh",
      "ear" : "cHPemILf2A",
      "tag" : "jkLKPGAi6T",
      "donor" : "ar1kEMMbxU",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6PrXZH7kC95pfZBJuAJ58",
        "name" : "vXR25la8zV",
        "email" : "OJ9QAdGX@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6JklDgIbWF3nkdjLoaonaS",
        "title" : "Found dead",
        "comment" : "bclPelXQfL"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:29.754393Z",
      "updated_at" : "2026-09-10T07:27:29.964521Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_26pvBRIuNzT5eWRFBDLE4X",
      "name" : "w03G4 Overwatch",
      "email" : "whnSDXo4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:29.234675Z",
      "updated_at" : "2026-09-10T07:27:29.234675Z"
    },
    "created_at" : "2026-09-10T07:27:29.976579Z",
    "updated_at" : "2026-09-10T07:27:30.064015Z"
  }, {
    "id" : "obs_5deNaQNLS3Vwg6k2a1GHd6",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_7kLEGjiwBTRMvQWXGKKPmd",
    "title" : "Tumour Volume",
    "label" : null,
    "text" : "Re-measured with calipers.",
    "type" : "numeric",
    "value" : "1300",
    "observed_at" : "2026-03-26T09:15:00.000000Z",
    "study" : {
      "id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "project_id" : "pjt_4O5CcyinMbj4e40PMKO3wZ",
      "name" : "ZCVFi29YAB",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TN5pI5saG20jQE3AOxIke",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "W6QvkVf4yO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7C8aoumoYswZf7oZgPZofo",
        "name" : "upaK55cKiu",
        "email" : "TgcAUzf0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_50E1F0Eys8qwE5Nm2lReZY",
        "name" : "cVEoDWtAeh",
        "email" : "KhERQ58Q@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:29.267872Z",
      "updated_at" : "2026-09-10T07:27:29.267872Z"
    },
    "animal" : {
      "id" : "aml_38CFsjqfi857xbtnlR68Um",
      "study_id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "study_group_id" : "grp_6OQBpfUCE85t98ahV9mQi3",
      "cage_id" : "cge_26TBh3enaV6QcT6nipDbHy",
      "catalog" : "A0000001",
      "name" : "KP4M12Bt8w",
      "number" : 1,
      "strain" : "rZpoCmXc0e",
      "species" : "NcIx5SmvH2",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "xcY6W7TKfh",
      "ear" : "cHPemILf2A",
      "tag" : "jkLKPGAi6T",
      "donor" : "ar1kEMMbxU",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6PrXZH7kC95pfZBJuAJ58",
        "name" : "vXR25la8zV",
        "email" : "OJ9QAdGX@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6JklDgIbWF3nkdjLoaonaS",
        "title" : "Found dead",
        "comment" : "bclPelXQfL"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:29.754393Z",
      "updated_at" : "2026-09-10T07:27:29.964521Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_26pvBRIuNzT5eWRFBDLE4X",
      "name" : "w03G4 Overwatch",
      "email" : "whnSDXo4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:29.234675Z",
      "updated_at" : "2026-09-10T07:27:29.234675Z"
    },
    "created_at" : "2026-09-10T07:27:29.981384Z",
    "updated_at" : "2026-09-10T07:27:30.064015Z"
  }, {
    "id" : "obs_4M3gj75nnHgUnPRXzK1J66",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_blXnUYR99LWBPR7sBfkJ0",
    "title" : "Clinical Notes",
    "label" : null,
    "text" : "Coat still healthy.",
    "type" : "none",
    "value" : null,
    "observed_at" : "2026-03-26T08:00:00.000000Z",
    "study" : {
      "id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "project_id" : "pjt_4O5CcyinMbj4e40PMKO3wZ",
      "name" : "ZCVFi29YAB",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TN5pI5saG20jQE3AOxIke",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "W6QvkVf4yO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7C8aoumoYswZf7oZgPZofo",
        "name" : "upaK55cKiu",
        "email" : "TgcAUzf0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_50E1F0Eys8qwE5Nm2lReZY",
        "name" : "cVEoDWtAeh",
        "email" : "KhERQ58Q@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:29.267872Z",
      "updated_at" : "2026-09-10T07:27:29.267872Z"
    },
    "animal" : {
      "id" : "aml_38CFsjqfi857xbtnlR68Um",
      "study_id" : "sdy_1cMi2nLBKaSpFxM8FtZKW7",
      "study_group_id" : "grp_6OQBpfUCE85t98ahV9mQi3",
      "cage_id" : "cge_26TBh3enaV6QcT6nipDbHy",
      "catalog" : "A0000001",
      "name" : "KP4M12Bt8w",
      "number" : 1,
      "strain" : "rZpoCmXc0e",
      "species" : "NcIx5SmvH2",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "xcY6W7TKfh",
      "ear" : "cHPemILf2A",
      "tag" : "jkLKPGAi6T",
      "donor" : "ar1kEMMbxU",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6PrXZH7kC95pfZBJuAJ58",
        "name" : "vXR25la8zV",
        "email" : "OJ9QAdGX@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6JklDgIbWF3nkdjLoaonaS",
        "title" : "Found dead",
        "comment" : "bclPelXQfL"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:29.754393Z",
      "updated_at" : "2026-09-10T07:27:29.964521Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_26pvBRIuNzT5eWRFBDLE4X",
      "name" : "w03G4 Overwatch",
      "email" : "whnSDXo4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:29.234675Z",
      "updated_at" : "2026-09-10T07:27:29.234675Z"
    },
    "created_at" : "2026-09-10T07:27:29.983887Z",
    "updated_at" : "2026-09-10T07:27:30.064015Z"
  } ]
}

List all study observations

Returns a list of your study observations.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/observations

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of observations to return per page.

page

The page of observations to return.

Request

GET /api/public/v1/studies/sdy_1qkvhEGmyTcWfGm79hkRRr/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiOTUwMmQ0ZC00ZDIyLTRiYzEtYmY5ZS1lYTcyODdmNTFmYTIiLCJqdGkiOiI4NDFiNThiZS00M2FkLTRkNTktYTNmMC05MWY2MGY3YzU2YTIiLCJpYXQiOjE3ODkwMjUyNTcsIm5iZiI6MTc4OTAyNTI1NywiZXhwIjoxNzg5MTExNjU3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZUR2hIR2FqWGpYU1FPSUo2c3VSU2EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.V5N_hPYEBMgk-hVTAD9q4IRpzQHkr7sFfQVHJmLOLfJYj1NumtXBC0t4SsPvt6IZUcl0nhxmIn4DTHiYOJGXHr4TZyhoGWrZU-GQNcGMLCuj39VXl9BpQHYLGjUmS0HVgvctpFxNN1xpzsmflFgDzYEHIe2cqvWkMWIS4A4bZGnC2XTPdUsGlCP6PuX_YEttO884KmljwCKgQzQ7HbK04Axx6ALfLMOvsc5fdrAirHGYxTVNdJEiEG2bXWOuikrvjBu0B4ff6p5hl88_XZKp_47yCzIjRtV0D14ZfVKK6Kf8UgXinm57DXMJ_ZkGVpEco0gwAzJKECEktiH9plvebLIenqVKt2BNwJYANy9xa0SocEnKZIbNDaqyE8Ojj5Ta8ojaHxxEVIpGXxAS8IQl43e3cGq_RRTIgsBjIxdPFg_YWwHpvzoNy1rkY9uxhJacXYD59ABJBUilKLLGBWJnsYHBYM-r4rIF8tCb9CGpxpAugqWmXnwnfhpJNDdWKnvIa9aXmhTdvgoAw_Alus2tZkXaPwgQ5GJqWQAUN9NtwsdfN0KMW5SSvKl8BKjY193EgL_9XLZBACssZym1LIrq5PdUyrUhabdwR9PhFAgk6wfD7aJLsH4T_QoYPr8a6CiYqjMNmRhRjGlA8wnsWcJO92f10e5jZ5ThN7mnhz8j0E0
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3513

{
  "data" : [ {
    "id" : "obs_35wE6MkCiqz5Yh8d2YNtkY",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_4squE1Ibk6wSeUsoDUpJDD",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:27:37.833661Z",
    "study" : {
      "id" : "sdy_1qkvhEGmyTcWfGm79hkRRr",
      "project_id" : "pjt_6HSoRJ6fagDtVBbQaO63UU",
      "name" : "zh1Mk4upHx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2SgKK1PeaH4ihCrTaQ0M8H",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "UFx8EsTKbe",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5IbMmwcEqw83ZihFYwqpXk",
        "name" : "sMImPwrZGG",
        "email" : "s7I0KEut@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_666O5ZiQNlm0Z6jwZOpCaK",
        "name" : "SyS73gnV71",
        "email" : "6bdTgcfp@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:37.171330Z",
      "updated_at" : "2026-09-10T07:27:37.171330Z"
    },
    "animal" : {
      "id" : "aml_7ZPEnkTiVYRAIZJL7Mf6AO",
      "study_id" : "sdy_1qkvhEGmyTcWfGm79hkRRr",
      "study_group_id" : "grp_1msPWBsDKC361Pec5lwwTk",
      "cage_id" : "cge_2EfYkn7SxkZlHE82kLAuLV",
      "catalog" : "A0000001",
      "name" : "bJVqDPQ14H",
      "number" : 1,
      "strain" : "PFYuYCKCql",
      "species" : "O2K80YTKWe",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "mC7Hmf6Svp",
      "ear" : "08CfHDyJAu",
      "tag" : "gCs2IWRrBw",
      "donor" : "X774FT79uY",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_uXU0VYct14ZZY0eY935fa",
        "name" : "yu26NOGBQe",
        "email" : "NKBSe66h@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2CIn7L6Uess9guRCeh3Jyr",
        "title" : "Found dead",
        "comment" : "tFAZjjmWQd"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:37.620416Z",
      "updated_at" : "2026-09-10T07:27:37.620416Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_hLbWyei7b6efXER3QO56y",
      "name" : "NVWUJ Overwatch",
      "email" : "5bqgMMbP@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:27:37.148689Z",
      "updated_at" : "2026-09-10T07:27:37.148689Z"
    },
    "created_at" : "2026-09-10T07:27:37.833769Z",
    "updated_at" : "2026-09-10T07:27:37.833769Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_1qkvhEGmyTcWfGm79hkRRr/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_1qkvhEGmyTcWfGm79hkRRr/observations?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_1qkvhEGmyTcWfGm79hkRRr/observations",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete study observations [BETA]

Deletes one or more observations from a study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/observations

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

observations

Array

List of observation IDs to be deleted.

Request

DELETE /api/public/v1-beta/studies/sdy_4I0545dFdL0GQkTfgTwz60/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MzkzMzk2MC1kYjczLTRlYmUtYWJmZi0zZmZkOTFmMmZkNmQiLCJqdGkiOiI2NGQzMTliMS0xMTcwLTRlYjQtODg2NC1iNDM2MWFiMDE5MGUiLCJpYXQiOjE3ODkwMjUyNDcsIm5iZiI6MTc4OTAyNTI0NywiZXhwIjoxNzg5MTExNjQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNqeWYyZVkxaXJLWXhNaTdMUkt4S1ciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.m5cDy2kfObQSSFH848fB10aPzwq3Rk2_CyQSg1esv0ZbJaXWYfXycNyCAlP3HXV_38UCUXFcu7Z-yVCjo-_ql1YiRJIQBCFwXa04ZHJBKz8lUm7Am3YEA7XTHyumRz_s7scHd9J-AALgCkSj3vJmSU_aJjtRMN4u41FXiQxLNQzIhd06H5x-5vR9Ry_BIPgnnIjicR_2iN-vIqZ-PqGEshCEuarDNHPeWDjMiIfTqCKAZcV4Ui0of3spDMELIZ6d6EHZbjYomCygN5y8FTAGvJk0qgEhTbeZFVxybMdAkTVJlA2xl0Wqa8F5o-L4GQ-zk_zf33LGiLFGM4VCW1DmgkvyTtBW_nfTbJ7u_nyLHwfSprx_NFC4OCihUoqYX7rihj0RqfcXjP3aznDvZTIZsDMZdl_zje83ZlTkm4_3qZZlDQYkMoZlqpln9C6_nO3MCJOsHh8bI5b5zbTV1prmIiNrE0V_MOsUk4MxH0Pw1OFb2WwEA2CZfWVX9y_qWJC11z668oEoZNSgUx6y_vgqmuRpWJv-G9YzXM5gthdrri3Zv8P5l8lSXziv0KEwJGPt5usvuOL5wsZH66r4WtPerz3-K1kkM4DgDzrSFhgMQRhpBav7xq4fLbjcbIF-XsKdA19pxGCLDh3weWkt6VxPaFJUv0WacQk8cKobIvAjmH4
Content-Length: 85
Host: localhost:8080

{
  "observations" : [ "obs_5jWQflyNqJFwSxAydlBGSS", "obs_2Ti0taFNTOUvAPvh7aYTLV" ]
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 3
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Study Planned Animal [BETA]

This is an object representing a planned animal scoped to a specific study. You can retrieve it to see the planned identifier, sex, species and strain, the study group it is assigned to, the live animal it has been mapped to (if any), and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the planned animal.

planned_id

String

The planned (placeholder) identifier of the planned animal.

strain

String

The strain of the planned animal.

species

String

The species of the planned animal.

sex

String

The sex of the planned animal.

metadata

Object

The metadata associated to the planned animal, keyed by glossary slug.

animal_id

String

The identifier of the live animal that has been mapped to this planned animal.

created_at

String

The created timestamp of the planned animal.

updated_at

String

The last updated timestamp of the planned animal.

Retrieve a study planned animal

Retrieves the details of an existing planned animal within the given study.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/planned-animals/{animalId}

Parameter Description

studyId

The unique identifier of the study.

animalId

The unique identifier of the planned animal.

Request

GET /api/public/v1-beta/studies/sdy_577DGQHOKS63wHVcGUExS2/planned-animals/adf_UaqoxdIbpxQ2emgcdQpPl HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxZTVkMDVjOS1hOTA4LTQ4NmEtOTAyMS0xMGE4MzVjOWYwNGMiLCJqdGkiOiJlNmNhMjEzOC00ZGMzLTQ4NTItYmRkYi0xOGU4ODNiOWYyNWEiLCJpYXQiOjE3ODkwMjc2NzYsIm5iZiI6MTc4OTAyNzY3NiwiZXhwIjoxNzg5MTE0MDc2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzIxRlhlbllTVWFJMnF6WGNXTjlMUmoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WpQAtZlVP3HrpIA6dGzeAug3Mf7rygM0IPNcttlXanWRRfsRumSOnmi0vDYMe7J5beLyWSMCGQzS4S-01usZm89b-A6lLBfsN4FDsQKv8LOMKBMnUoxFW1mIbbC8g3gef5XkUdgedUswTl05oByLQBPmXDOaMtQzIaqnI09K6M9f4i5YdOeg9uekY_gN62NMCc3cSNuCuncCJUtBDiKpGo27geheO--_TaE-qlfsMvY1eoIi58hR64g-aGDsqqRdWa7OBn9w9D88Eocov-qD6IUUaKr35fZ9j2MDdT3PQe95Pab-4GBq72INlUxI7LoB-ZqxWXZiMNcjiAx61Pls2OzC2XOp3HswwYHekC1BntNQUhxDMN9AIACkNaihR4VjHFWP305uShHdQflHycJFTItu9oAGafjxPvLF-XMIUjHw3mmE5h7tI_t4Tm0qW2gioOtEuLq2gSRyID1MiNvEFywYts54giUrB9bxTHvLdYuBm_z7sqq6bDOZuCWXRaqsZhHN225BQ_M9XRfYocFhwlc_DQsp-QDsisQ2SUcOYmpT5zT9TLCCN-W9x5UHBFR4PGHLHIYI2m3WDxCtey8QScgwb-CbDgHL2DbqNHL5zOkh6thCYs-3S0nAQd3BIj5rcsw7ldaZO50bcwQpetfLxh_hTX_fi5PwKq6Fkv2j-Hs
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1682

{
  "id" : "adf_UaqoxdIbpxQ2emgcdQpPl",
  "planned_id" : "1_1",
  "strain" : "Qb2S4CPYNE",
  "species" : "8TwhtRKGyN",
  "sex" : "f",
  "metadata" : {
    "ZmphZAKhSS" : "ABC-123"
  },
  "animal_id" : "aml_34xVjs6E4TaUIVn2VJyOJZ",
  "study" : {
    "id" : "sdy_577DGQHOKS63wHVcGUExS2",
    "project_id" : "pjt_7L9um4nbYWilcBbyKqivVX",
    "name" : "bIIu2cxSjF",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6QUAGvsm8RxkvfVDAwUMhs",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "25uEZXovCq",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5T2lSkDwULQS8JgjpvjNxe",
      "name" : "3D9aSbtUeQ",
      "email" : "GC4s1bUn@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_54E4NVFu2eAknsxAEbpI41",
      "name" : "aLY2oLveWm",
      "email" : "yYcqaOb1@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:07:55.782698Z",
    "updated_at" : "2026-09-10T08:07:55.782698Z"
  },
  "study_group" : {
    "id" : "grp_59lcIthzBFvV84nucOOakC",
    "study_id" : "sdy_577DGQHOKS63wHVcGUExS2",
    "name" : "DUm4n8Tv4L",
    "no" : 201268494,
    "color" : "#48c8dc",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-external-id" : "GROUP-1234"
    },
    "created_at" : "2026-09-10T08:07:56.001815Z",
    "updated_at" : "2026-09-10T08:07:56.001815Z"
  },
  "created_at" : "2026-09-10T08:07:56.233544Z",
  "updated_at" : "2026-09-10T08:07:56.233544Z"
}

List all study planned animals

Returns a paginated list of planned animals belonging to the given study.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/planned-animals

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of planned animals to return per page.

page

The page of planned animals to return.

Request

GET /api/public/v1-beta/studies/sdy_6WCX049ibWTm3XPSUKWIG5/planned-animals?perPage=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyODkyYjcxYy1jN2RlLTQyYmUtODVlMy04ZTE4MTRjODk1MWEiLCJqdGkiOiJmZWI1MWJhZC02ZDgzLTQ2NTgtOGRiMi1mNjJiMTM4OTU3NDAiLCJpYXQiOjE3ODkwMjc2NzUsIm5iZiI6MTc4OTAyNzY3NSwiZXhwIjoxNzg5MTE0MDc1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZIZG1pMmhPY1RPYmdtTGwweE5WWXMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Qj9ZSrhdG7ZikeOUm12nNs875rp_oB9jHxaK1geEljgnJbdoiXiUq4p9iKdrZCMb8NWVvmQHqdiUTrFSdISEcCE84yK6unh4vf3OVZ_WIRHwVnCxIlGidzZcdtn8W3jHoJSvRB318hPFwrTVbz6ynE3ps7hAqrbJFfd0881oEAfhnfnZzxWdpkjcU14Tk0bwLOZJIbxKc9QF1yVer1eFtjRd-9pIGoK_GAdghSBnm1zK2qzZHKkb6-1PP_TO2guy1h_SbDprn1e9OvkaUQha7a9eCtDW7eiDD2jCE6QXB5tBJ_VULZ3jSnJ65h9s0dcqB8ORXr4LvXW9GtP3q480DIkHNjajNiPuAC3lO-DJHKnaKopzQ5OWdnHRh-pgSpO8xm7cROuYiW-Co8lFNdyizDqJJWIXFfm2P5cDZlq_kYQ2cRkvDUwxZVh5gbI5PQKCv1yk37mSskkMYsvPXBUW6UtDObnagKJqgNFkW_lZ61fWfYTkBBqaHU8kqhWnjX1BLPSt3XdhMf2NhbNzJcU5LWFBwNiGPBZG1qrFOQvbVZBronyRjXSkICLYkS37lcC5Y0szuDYV4DoMJ4XRk9co9aQKMSuSjxAdyPhnrsqNeUqm8uMVxPG7GmKFw4jh1ltZ5x9ys95HyHGPU2iV2LUYsw9Mvr6-bMzzRHsdMKvWVBI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 5
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2344

{
  "data" : [ {
    "id" : "adf_5IwgjUqkgqrSkMV132LB5c",
    "planned_id" : "1_1",
    "strain" : "V6Fu1n7GcQ",
    "species" : "cVk5BOeOmy",
    "sex" : "f",
    "metadata" : {
      "vMmOQ0hg7z" : "ABC-123"
    },
    "animal_id" : "aml_6uX6gBagLKFrCr11RXsbA7",
    "study" : {
      "id" : "sdy_6WCX049ibWTm3XPSUKWIG5",
      "project_id" : "pjt_65qjiqAxlw5qt3Xaz9ppiK",
      "name" : "bCPtUd819h",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2W4UqXc6xYWvni8hK9Lkat",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "tXAzo3C3NB",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4tZwIYqa6R30fRsTfK28G7",
        "name" : "02GpBTMDP9",
        "email" : "O1wpGNN8@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1tMeyqVLvMynAPOCvgg546",
        "name" : "OvU8kINvDI",
        "email" : "IGcGeX3a@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:07:55.199639Z",
      "updated_at" : "2026-09-10T08:07:55.199639Z"
    },
    "study_group" : {
      "id" : "grp_26oS6XM0Ewp2vBInc7QgGf",
      "study_id" : "sdy_6WCX049ibWTm3XPSUKWIG5",
      "name" : "5Mk2m0vwA2",
      "no" : 1966079476,
      "color" : "#4fc850",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T08:07:55.458046Z",
      "updated_at" : "2026-09-10T08:07:55.458046Z"
    },
    "created_at" : "2026-09-10T08:07:55.537085Z",
    "updated_at" : "2026-09-10T08:07:55.537085Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6WCX049ibWTm3XPSUKWIG5/planned-animals?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6WCX049ibWTm3XPSUKWIG5/planned-animals?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6WCX049ibWTm3XPSUKWIG5/planned-animals",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Preset

Study group preset blurb.

Attributes

Path Type Description

name

String

The name of the study preset.

calculations

Array

The calculations associated to the study.

study

Object

The study of the study preset.

Retrieve the study preset

Retrieves the details of the study preset.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/preset

Parameter Description

studyId

The unique identifier of the study.

Request

GET /api/public/v1/studies/sdy_2ahwRvVzZwDnPhlB7rKTyJ/preset HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmYTlkYzM3ZC1iYWY2LTQ3ZmYtYTE0ZS0yYWIwYTZiYzVjZTQiLCJqdGkiOiJhNzcxMDk5Ni01NTlhLTRhMjgtYjY4NS1jNmEwNGI5OGRhNjUiLCJpYXQiOjE3ODkwMjUyODgsIm5iZiI6MTc4OTAyNTI4OCwiZXhwIjoxNzg5MTExNjg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFYVm5kOXJaWlI0RWlwTTFyT05wbHQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.kjYRreizVP4K45m-xd6DQUA_nf9eTX3WcGNk2RLkBM9QpbrmUDEL8nkahojT_kZatbWXPimuM0Pta329c2VAqJGTcYOT_4qH2cJ2gPGbGuXRBsOZKwzxL6SAeiAA7fmCYbYpTgL9jJ5RLrk_y8bVCSWpalXpuhYQN_SN88c4jJNBxUa2FgDmYHO_gRTSHkNohzxZhy78ih_-06S-x_n9AYKeIRj_22qMKmToqCRuu4Yk1nhgUF6t8Hwc2exZzWPwdqBWYz1f4Z1eP2Q1KXsu2q2O59pXM2iDgeLwzaPAvCB8RRlOLUkdzNXlsbW1bwwRTeUzXJD_P_PaWCq9pBKjcQPegm0Yratf0Qin5V_p9BujK8szw0gy5w8tvkkEfsTBNq0fUmK8Mis15uuGrTuCJsdZ4H1S7culq1yJVQAz8vo3faZOA2KRG-bCYJHezqFyWmSbYafX2rPSu5JQ1JsTsLCcy4XL2AKnLjGWJ3Q9167CUWyrgY3WQePlSvYwIryUxL0eO71nma_5blUSzpDe87RqeZpKU5LxBd-v72UbfasWZJnE2rSAzQWqq1KgfF8KBdUQjHJGEP-zYYP11YNAScg1kRRSjfJGIQyLjvunhXEVwqk6ZpUcymjyNlD8QDVaPnpemoE4g2T-9AGzw8Sni4UqOkFklgozlXDvsw04gBk
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 22
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1529

{
  "name" : "Subcutaneous Tumor - Two variable",
  "calculations" : [ {
    "key" : "tumour_volume",
    "name" : "Tumour vol.",
    "unit" : "mm³",
    "formula" : "(width * width * length) / 2",
    "measurements" : [ {
      "key" : "width",
      "name" : "Width",
      "unit" : "mm"
    }, {
      "key" : "length",
      "name" : "Length",
      "unit" : "mm"
    } ]
  }, {
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "formula" : "weight",
    "measurements" : [ {
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_2ahwRvVzZwDnPhlB7rKTyJ",
    "project_id" : "pjt_RwDLehSlME4sAxnUGbqE5",
    "name" : "ieRu9o6gZd",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4vyfSCFSDchzv3yzhdKtwd",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "GZA1Abc6e5",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5sdoRNjnJlrNFptWR1MSXV",
      "name" : "DmMeRT4h5q",
      "email" : "FsrmPwlZ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5DCPr6OaFQfzgTjlpBa8Fq",
      "name" : "pViDsY2zZq",
      "email" : "YvydO68Y@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:08.189464Z",
    "updated_at" : "2026-09-10T07:28:08.189464Z"
  }
}

Study Request

This is an object representing a request on a study. You can retrieve it to see the request identifier, users, groups and the fields relating to those groups.

Retrieve a study request

Retrieves the details of an existing study request.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/requests/{requestId}

Parameter Description

studyId

The unique identifier of the study.

requestId

The unique identifier of the request.

Request

GET /api/public/v1/studies/sdy_3z7I3wOjKBuzq055JRGKSa/requests/req_55MqakWjhWToLCiJVvOqun HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YzFkYjQ3Ny0yZDdkLTRkZDEtYjQ5YS1mZjhmNjIyZmYyYzciLCJqdGkiOiI5NjQwZTI5ZS0wZWI4LTQxOGMtODc2OC01M2VjZjZkNTgyYzEiLCJpYXQiOjE3ODkwMjc2ODEsIm5iZiI6MTc4OTAyNzY4MSwiZXhwIjoxNzg5MTE0MDgxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3lrcGRwdkNpM2VuS0JTYWZlMzNRNSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.k5fFtPH8R4aYuZND3h_ZW8KsRopONqpWxZV2lXGrvP42x6R2PRwzZBATIkMy_WqS45HDhKFFUAdJsr-S9QZjNJ7bVRGlRK7vOOxUbEzO8bVRDwRMDTFthTWdn3xFy8nf45exUVsn0IgfSNuGayIiLxkdgM4UvnrXOVDDNS_mbcl5zMqjrV-G3c0XwgCGszVbudfI7JHu7IDsiYcHvNhwecmGwCd5iTKYk0IkBCPTz79u7O2-BDMFmdmsrSQvShx2ee9kpw_3xX5p1hLB4BGWZKCSgL4kLKRyTAt662LCVPfTTcGVGkEgZpALrBV7DTlq29DuTGK4j-wbscl0Er7zEt9XmgXYFK2JCYDlS6RLFT-5Q17Q9pig0xXT-DBA6RE4RZow9rqXR1aFENIj2k-MXkbccgv1-5BbsricLipInl8_53OAA3ozoq4nlt8onRn43b9g-DlVlix6bVpdEXisCZ3Ml-t7jbxMRlUFPOSIBB0yxvrxtajyPfrRls0pYaFaL9yR3lPKISvid7MRl9ll9lYwc5NmLrK4y4yuADz3jrsQVkh5BC6G1F3kNHojDBUD-cgs4vZerp8kfuSNl6clR39zLo9A2upSWr0NrAvN4m-_QQckoe6FlBSR1xVyeNLaWVAEYBHdk2KWlh_K-P1tfwYLuf2k0P5XrVyuKU_zT5Y
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 29
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1450

{
  "id" : "req_55MqakWjhWToLCiJVvOqun",
  "user_id" : "usr_7UH7ITnvonrFyRQvVqSaxX",
  "assigned_user_id" : "usr_7UH7ITnvonrFyRQvVqSaxX",
  "status" : "pending",
  "due_date" : "2026-09-10",
  "groups" : [ {
    "ref" : "y1fgJxMp6L",
    "label" : "FJi0dpZ8Y9"
  } ],
  "fields" : [ {
    "group_ref" : "y1fgJxMp6L",
    "label" : "IpBhzmLyQp",
    "value" : "QA1XXO5TqI",
    "options" : [ null ]
  } ],
  "study" : {
    "id" : "sdy_3z7I3wOjKBuzq055JRGKSa",
    "project_id" : "pjt_6KA1TtWVjcM3ond1uEM84w",
    "name" : "TjuXL8S97C",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5kxE9tTAY4vT2wiClkc8Jh",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "JjXrfQlJFU",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5XmZoFyABmZqNMIhpPWIF7",
      "name" : "m2eW0yWs3n",
      "email" : "QrGOPrk8@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1cpqiC5AXp2PASibKm97ox",
      "name" : "K91ISo15JI",
      "email" : "TkVvxsmX@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T08:08:01.417392Z",
    "updated_at" : "2026-09-10T08:08:01.417392Z"
  },
  "created_at" : "2026-09-10T08:08:01.688546Z",
  "updated_at" : "2026-09-10T08:08:01.688546Z"
}

List all study requests

Returns a list of your study requests.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/requests

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

Request

GET /api/public/v1/studies/sdy_3hTG0AcrAHdry0OwhqA13u/requests HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5NGZjZDhlYS1iNmRkLTRkNDEtOTI1YS1hODc2YTNmYzVlMzciLCJqdGkiOiJhOTQxNjIyNi1mMjRmLTQ0YTktYTAwYS1jNGY4MjFjZWM3NzYiLCJpYXQiOjE3ODkwMjc2ODEsIm5iZiI6MTc4OTAyNzY4MSwiZXhwIjoxNzg5MTE0MDgxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJKWEFRbHFjZndCcEFMaDk0dExjMTIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.cOKPYT13gOLJBEucR0SJ7OzxYLXxUTVuiLJD4dGMp59kpj1NmYSEgkWIxt41uAf9Gd-F7Zliz7OesPYyDAxP1X-zxSDl7vlv0a7iS42kuO7VSummHOFVTl_hcvsoGnEfVnbyVDJp2pvOfj-gsxqiFuVWv1jVwWTBCa_s8ovO0l-KtJVcxgUknk61gZQAJBOhnNJEsd9myuBB4IJbRxRqSG4aR4tVajPnYNbE0VB89lnIeHifEpw9BgOIrysbCbLU2KhvxhSplo3Yr-67TuGxcpf8u8EXbvn1s0BDwoJ-USF_UdScFrRxUTboWaQwxrz5SLgCtFYHrvhLe0m7IadlDNwHTUiGTFoYHb-_yZn_6b_HJPaPPj1U9ctwzPrVr2AgWTKzbw8k9O4BsJC9gmt1V05jMCXpgpfT_Q3IgMx4Wh5h93goHJki4pD0cDYXoDbT6eJcVjBVglH2NHguyUsQPniWWnHySJj1gXYYdj9BozIucgEuQRYSa0RBaiiYsuY-8JRjjBli4MpUryWeZA3ONK0-ONN_Au_ymtHipJYHvqoeKMt19pwIJvKtxCQRcuvkegmbv24bULeockQY7xZ4OTs7OPANgfVqwxcEKortlFZu2mVDmRgXPbwl3hzjFH60ZqqAQ8eLLNVCVG-KDraUzP3ehI19IMyxXgqLGG_EFsw
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 29
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2056

{
  "data" : [ {
    "id" : "req_5gX3H075JpTLndoTBMrtnu",
    "user_id" : "usr_4APMgfovg5l7Ilk9NKuNmR",
    "assigned_user_id" : "usr_4APMgfovg5l7Ilk9NKuNmR",
    "status" : "pending",
    "due_date" : "2026-09-10",
    "groups" : [ {
      "ref" : "WUu4sRD2Y2",
      "label" : "P61dnCBk2y"
    } ],
    "fields" : [ {
      "group_ref" : "WUu4sRD2Y2",
      "label" : "AiKHay4XVr",
      "value" : "coER3c5CqI",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_3hTG0AcrAHdry0OwhqA13u",
      "project_id" : "pjt_4sIrl7Apqy9UNRituGpdYy",
      "name" : "Lhh7TvOXXQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_28DKnhNfHr0ovQ3ICgJO82",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "ojWOxtJE1D",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_krty8tA2vaDbB2f3vQFDr",
        "name" : "t8sS6PVdwq",
        "email" : "Y9vRywD0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_o2egX1tCvQRpfXPpVNw4r",
        "name" : "kGBBrvCIEY",
        "email" : "msgLJkbi@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T08:08:00.856565Z",
      "updated_at" : "2026-09-10T08:08:00.856565Z"
    },
    "created_at" : "2026-09-10T08:08:01.140592Z",
    "updated_at" : "2026-09-10T08:08:01.140592Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_3hTG0AcrAHdry0OwhqA13u/requests?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_3hTG0AcrAHdry0OwhqA13u/requests?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_3hTG0AcrAHdry0OwhqA13u/requests",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Request Sample

This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, status (collected, planned, cancelled), timepoint, details like volume or mass and any metadata assigned.

Retrieve a study request sample

Retrieves the details of an existing study request sample.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/requests/{requestId}/samples/{sampleId}

Parameter Description

studyId

The unique identifier of the study.

requestId

The unique identifier of the request.

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/studies/sdy_2fw5X2AzZzshvRPK1xbHfK/requests/req_1oJQ9If5aXc49yRhGc7vMN/samples/spl_1XSkz6XrtwdbMRxDhgJiL9 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMGQ3NWU5ZS03YmIwLTQ5NjAtOTYzYi04MDdjMjdlYjY5ZjYiLCJqdGkiOiI1ZDQ4MWMwMy03MDY5LTRiNDctYjRlNy05ZTVjZjg2MGViNWMiLCJpYXQiOjE3ODkwMjUyNjMsIm5iZiI6MTc4OTAyNTI2MywiZXhwIjoxNzg5MTExNjYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzEzS0xBWHdkMG5zZWZ5aTNxMXFjdSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.dKXvBv1ulIMbtd6NoIJOHMV38cTL8LRVCDUgR5FZdkSZJ40nX-t9rJ8X8a1PGE9In_hyJfLURhXZmZgcLwYGm8DMCe5zOgvGBOCOpdfk444Xj4dgjQN2b_pp3o4pVuPy5cQzpCtbKihA_muCq1lunTF2jDcFvRWbK0pHPiXc4uneCqBPMRnmquqQ6gHnrA5k0Zm7f8dgyfDFH-1bVRDJ1k9zmratEanPGAjjU6mFCHVlsNJvQfw18POsiuYZfKasSMvF1oEh0dpvuR6T9hHCzhV9GQPDXdIShDcZ-C9d3aJjkTgA19sYdiaYCYRJRyLDoTVr7esASZE199Z1NLWqUz46zaY6FbZy2PQhgoN-kO8ALsE8VCajyP1BoGqaSSZoucpkjNDR5X_wDr9ZZlGNVZgFCts2d4Oiw4WUgATzAPriha1UTf7qWSHatmKNCZWRFp5s0XnyZSzkC8xyhCYYffuaXfBW6PxVZr8FEVD6_RhRSsAA3tqjHareBCT3I6DyFeW1D-qrCYxhq_tHerLA8tZwk1bKabOQ6vHNeSa2PhMdF1jOsf66et2QcSCo94aD_IKgcfrcIXDydfBVrRDwwTAg0e6A2k9O4RZtcxgWXEhnmVIDGtjql-fnQQCzbN5xvm65SmRWAdn6b7B9os28ZIgZnjejbe3y1jTe-VFYqAI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2961

{
  "id" : "spl_1XSkz6XrtwdbMRxDhgJiL9",
  "sample_id" : "S1704324235",
  "sample_definition_id" : "sdf_7hO1V7qiWZreYqAIFGuAgG",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-09-10T09:27:43.690534Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1228750048" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_2fw5X2AzZzshvRPK1xbHfK",
    "project_id" : "pjt_36mykBFzoimLirGN2uzU3t",
    "name" : "5aV7YIuUIA",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4coF31b7MlarrRIln7FdBN",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "oSd5xxbCyb",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_166dlGrjNdt7O2f1VET7ob",
      "name" : "Rhp3rmWB4e",
      "email" : "UVq2YH6v@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1RTuNKQ91ttDeNsIY3Z14E",
      "name" : "t7NzEy2BHL",
      "email" : "JhgFb5VV@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:42.542598Z",
    "updated_at" : "2026-09-10T07:27:42.542598Z"
  },
  "animal" : {
    "id" : "aml_4rIlsZgRfNreEIc8FEJSpK",
    "study_id" : "sdy_2fw5X2AzZzshvRPK1xbHfK",
    "study_group_id" : "grp_oxFN0F6FnKKWdgk3BUHXL",
    "cage_id" : "cge_5tYI4AylgDnJvr9cx6wK9L",
    "catalog" : "A0000001",
    "name" : "nFZaktlPlW",
    "number" : 1,
    "strain" : "PS1H1h2s5J",
    "species" : "WkTkQdaNxA",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "SXoDxkJMoC",
    "ear" : "Dc7LnfBpM0",
    "tag" : "xZUYs3Pnzy",
    "donor" : "KnA2QP7JUQ",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_7YtolQVRBCScR3wURQx1TZ",
      "name" : "7uttH6zYL0",
      "email" : "7xJmjXkw@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2aM7zB4EfasoZ7ODhKIXXy",
      "title" : "Found dead",
      "comment" : "KLBIFgIXui"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:43.030375Z",
    "updated_at" : "2026-09-10T07:27:43.030375Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_6sS2bduyzh143KhZE7qQFy",
    "name" : "zFaOy70q9F",
    "email" : "0p5T2qF0@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "unDtkHuAoE" : "a3NqJC3FAO"
    },
    "created_at" : "2026-09-10T07:27:43.672037Z",
    "updated_at" : "2026-09-10T07:27:43.672037Z"
  },
  "created_at" : "2026-09-10T07:27:43.690700Z",
  "updated_at" : "2026-09-10T07:27:43.690700Z"
}

List all study request samples

Returns a list of your study request samples.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/requests/{requestId}/samples

Parameter Description

studyId

The unique identifier of the study.

requestId

The unique identifier of the request.

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

Sort samples based on an attribute (animal, cage, date, group sample, study or type).

order

The order in which the samples will be sorted (asc or desc).

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/studies/sdy_74ArMGNhok8xVfqJPTzWu3/requests/req_6SsUcJqWp37Y78Vbhc8wi6/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjgxNzM5ZC1iNzZlLTRlM2YtOWUyMC0yYjJlMGM0YTZlZWQiLCJqdGkiOiI5ODFlMTM2Ny02YTFmLTQzOTEtYmYyOC1kMzAzNTlmOThmYzkiLCJpYXQiOjE3ODkwMjUyNjIsIm5iZiI6MTc4OTAyNTI2MiwiZXhwIjoxNzg5MTExNjYyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE4THZBakRxTDlXc0ROSVlJZzlzbUQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ablZYMmC9oEvDuZaME8c2qOnS2IyoYhk1cIplqpo1yEPyLYbOvHHgOLE18TItyBrMeJLb1qKCIuF5l7b6Fflq4mLW7HgUheoq7AEAneT8M7yT58wp9Ci4JuJOLcUd09mJQdPvxMnDSRKMishnjpgvAm9X-edtv_kqozsfqa7CHOnbT-IrCD7W1mA3bldcGyqWttmw_MojONoT9hS_BdHBsDvfa7vasTr6ekpHcMgYAvsQF1CKQMMDYs5mhFzkmYFsDLUlPwmLBAK9HJ5oYyK7DZzPj-KhwOyLPZHBFjuwFO0gsxUx9vsoD6GKdYTdMllPvrJYpEVlmq02iTNzAb_HJKenw3c9Vh59T9AV9saCvjx5CJvcnjd74XS902uWEH4ZPy_gw0gNt-DJxfetazrgnTHG2TkeaUNm7M64urrrwigyWChN6VMbUhJhGz4D0b0BNqz6mQL0Fwn60c-I8PhYU6k_cYoM7ID47mwo1_D_ZHJoeMxNdVmM4BPlsQYr5GnUcqhmjEhCY9SBhJ7zcap7J16Do3I_rA_BcBjtfuHVdXcth4JtpljqXIcD2j8aUJ6NagsF3aQZVk0WSGYwF5wRRpO-ZtGjAdBtq98ZPKAib9_jkruU4CCTV8I9R_PjD8sw4ile5C9WEjra2jSbIpBBTMfrgyMtIoGbI2Gu21G9c8
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3775

{
  "data" : [ {
    "id" : "spl_1aYrVMjEFAKXhScL4D5RMP",
    "sample_id" : "S1425964816",
    "sample_definition_id" : "sdf_KctC8FcImppP5B8jdDsFG",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:27:42.112967Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-494881410" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_74ArMGNhok8xVfqJPTzWu3",
      "project_id" : "pjt_7Gsshk3Wu6fVzp193KWaZv",
      "name" : "AnBEpqLcxH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_43V95Z7CBVWFPlWsjpdqh5",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "lu2mwCQRoo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4UpYM2BnPNyWE4zEZCd552",
        "name" : "OssLMLqxzr",
        "email" : "9v7EYyzF@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6QQ23T4PMjw8ze6xldf3hh",
        "name" : "O4ue1wHNmI",
        "email" : "qbeB77eT@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:40.974019Z",
      "updated_at" : "2026-09-10T07:27:40.974019Z"
    },
    "animal" : {
      "id" : "aml_44cPDJ0t63EV39x4A0kXw6",
      "study_id" : "sdy_74ArMGNhok8xVfqJPTzWu3",
      "study_group_id" : "grp_3sS8hyhYLQFJfsOEvXB6Nv",
      "cage_id" : "cge_4i4votJCthNO6AmEkx9m5Y",
      "catalog" : "A0000001",
      "name" : "d6Ki1SSWOL",
      "number" : 1,
      "strain" : "qpX39fbF62",
      "species" : "KWH7SjYIaj",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "u1B0oKTuW6",
      "ear" : "UeKDO1yNdT",
      "tag" : "a0a3JvDsGW",
      "donor" : "MAlvIv3oex",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_7Br1EYY4eGw9XiHvRBMYaw",
        "name" : "xOniChqKKt",
        "email" : "2LqGHVSU@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7jfuj1oQSAYS6w8KD9KCJM",
        "title" : "Found dead",
        "comment" : "UggoxTAFE5"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:41.762901Z",
      "updated_at" : "2026-09-10T07:27:41.762901Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_2FxNwH76dex8bYJTRtVW0S",
      "name" : "94tFWCfltU",
      "email" : "dNKjFwBG@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "IMqxtUsule" : "O916aKDOSu"
      },
      "created_at" : "2026-09-10T07:27:42.094225Z",
      "updated_at" : "2026-09-10T07:27:42.094225Z"
    },
    "created_at" : "2026-09-10T07:27:42.113136Z",
    "updated_at" : "2026-09-10T07:27:42.113136Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_74ArMGNhok8xVfqJPTzWu3/requests/req_6SsUcJqWp37Y78Vbhc8wi6/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_74ArMGNhok8xVfqJPTzWu3/requests/req_6SsUcJqWp37Y78Vbhc8wi6/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_74ArMGNhok8xVfqJPTzWu3/requests/req_6SsUcJqWp37Y78Vbhc8wi6/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Sample

This is an object representing a sample such as blood or tissue collected from an animal enrolled in a study. You can retrieve it to see the sample identifier, type, details like volume or mass and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the sample.

sample_id

String

The sample ID of the sample.

label

String

The label of the sample.

type

String

The type of the sample.

status

String

The status of the sample (collected, planned, cancelled).

timepoint

String

The timepoint identifier for the sample.

collected_at

String

The date and time the sample was collected, as an ISO 8601 UTC instant (e.g. "2026-03-25T10:00:00.000000Z"). Empty for planned samples.

details

Array

The details of the sample.

comments

String

Comments of the sample.

sample_definition_id

String

The sample definition ID if the sample was created from a plan.

metadata

Object

The metadata associated to the sample.

study

Object

The study of the sample.

animal

Object

The animal of the sample.

user

Object

The user who collected the sample.

created_at

String

The timestamp the sample was created, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

updated_at

String

The timestamp the sample was last updated, as an ISO 8601 instant in UTC with a 'Z' offset (e.g. "2026-03-25T10:00:00.000000Z").

Create study samples [BETA]

Creates one or more samples on a study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/samples

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

status

String

The sample status. Only "collected" or "planned" are accepted. When "collected" the collected_at field is required; a "planned" sample must omit collected_at.

collected_at

String

The date and time the sample was collected. Must be a full ISO 8601 UTC date/time: either an explicit UTC instant (offset 'Z' or '+00:00') or an offset-less date/time taken as UTC (e.g. "2026-03-25T10:00:00Z" or "2026-03-25T10:00:00"). A date-only value is not accepted and non-UTC offsets are not allowed.

team_glossary_id

String

The unique identifier of the sample type (a team glossary in the "samples" group). Provide it, together with any details and metadata, when creating a sample directly. It must be omitted when the sample is created from a plan via sample_definition_id.

sample_definition_id

String

The unique identifier of the sample plan definition to create this sample from. When provided, the definition owns the sample type, details and metadata, so team_glossary_id, details and metadata must be omitted. Required for planned samples.

Request

POST /api/public/v1-beta/studies/sdy_4qQFDRgfehvWaagnC1Z0om/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNGRhOWUyMS1jNWE2LTQ1NjgtODNmNS03MjFhZGIyZmQ1ODIiLCJqdGkiOiI4N2QyMmFhZC0zNTJkLTRhMjMtYmQwMC05N2M1ZWYxNzI3ZmIiLCJpYXQiOjE3ODkwMjUyNDYsIm5iZiI6MTc4OTAyNTI0NiwiZXhwIjoxNzg5MTExNjQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRuZ1F5VzJheUNJZUliaXlQcFJHbnEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.JEzUXi-GR-UY5FSJRq-n6c_y00XG8g0yly2IKNrZ9QecjCO4ZNaHrAOu8hGpTCYX_wj1VO0WoDqR9zHxfj5l8FD-kgcCUgnuaHAA-2wg6b19bxsl7WEql85sN-Hji0qkO3g_Q4luTYBMOMNH5etr547bchAgdAkCxYkZyXrdTzEXSTZ6Ld10NWPYepNrASJG0U3LlnEM963J4A6wEU-riM-HLwAgkKw7N3fHMZMdMYQszrQsOiyGuAL3xuhJz9Kugpt41TmF8_zz9-7CQIwpCInndwwr8g-_8jQQZ9aLM62QgX7YYEptpjzvjruNM6n7uHfzRjVYY54WCj-tiTdcl-v9gBTkDuxzGoFpzASHbUV-qLTJVcrrZoyXU2iqXPrYvmhc8jzXYXMveetYnpUx-aOu_FvEosTpsks76bL_T7EbINZkQySpaJxMDJs9Zur3yKXjxy3Mt1nK0nOK3_Ls2TFx8CdBv80Lp8-YWBv3p9KEl5AQS7q2Gr87iL9Fu3IMsA7CP0yRx1g597XLTldR7XrPFpwhiUYa4eUHeyDKhkAWaMkx1JzrpitPkN6iBZ6Jawz-yDLxeQqJSo5JqT3M4hAWW8B_YqlH7FZ5QeiLMt8Ns7_T8b-6b9he_bFBTd6Kj89W4ur0ZjZtJCap4pIw8it75zNs0Rw5WTUObYZHxMM
Content-Length: 386
Host: localhost:8080

[ {
  "animal_id" : "aml_3UlJyatUssZd3Jirjpu321",
  "team_glossary_id" : "tgy_3xXxgu1H29KFC0j0TCKqd7",
  "status" : "collected",
  "collected_at" : "2026-06-24T17:07:06",
  "timepoint" : "PT1H",
  "comments" : "Collected during morning rounds",
  "details" : [ {
    "key" : "volume",
    "value" : "1.5",
    "unit" : "ml"
  } ],
  "metadata" : {
    "concentration" : "5mg/ml"
  }
} ]

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 4
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2128

{
  "data" : [ {
    "id" : "spl_3X1sfEXMyOmpHCcwmTkco1",
    "sample_id" : "S00001",
    "sample_definition_id" : null,
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT1H",
    "collected_at" : "2026-06-24T17:07:06.000000Z",
    "details" : [ {
      "key" : "volume",
      "value" : "1.5",
      "unit" : "ml"
    } ],
    "comments" : "Collected during morning rounds",
    "metadata" : {
      "concentration" : "5mg/ml"
    },
    "study" : {
      "id" : "sdy_4qQFDRgfehvWaagnC1Z0om",
      "project_id" : "pjt_4ihA1hdn1wVBqDQ2doy7Ql",
      "name" : "uRuECp1m9L",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5GB0FtOfFRpE4NWjzFKm5H",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "3Kuzme5Aex",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:26.911962Z",
      "updated_at" : "2026-09-10T07:27:26.911962Z"
    },
    "animal" : {
      "id" : "aml_3UlJyatUssZd3Jirjpu321",
      "study_id" : "sdy_4qQFDRgfehvWaagnC1Z0om",
      "study_group_id" : null,
      "cage_id" : "cge_1e6xBU67fT1D6AvibNmguw",
      "catalog" : "A0000001",
      "name" : "ouCaN0KM2u",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "NB9n6otPom",
      "ear" : "SorqcVo4bW",
      "tag" : "J76Yly5WJ4",
      "donor" : "FJfJcBmfpL",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-09-10T07:27:26.937079Z",
      "updated_at" : "2026-09-10T07:27:26.945474Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-09-10T07:27:27.033218Z",
    "updated_at" : "2026-09-10T07:27:27.033218Z"
  } ]
}

Retrieve a study sample

Retrieves the details of an existing study sample.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/samples/{sampleId}

Parameter Description

studyId

The unique identifier of the study.

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/studies/sdy_70lN3IYkinKIImPjY01Wut/samples/spl_7OVfFBGMWMZCGHg4QT5By1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4Y2JkMWIyNS02NGU1LTQzZmUtOWQzMC1iYzE5YTFlMjIwN2QiLCJqdGkiOiIyNGJhZWVlNi1kMTI2LTQ2ODYtYTg0Mi0zMWJlMDM1NTdlNTUiLCJpYXQiOjE3ODkwMjUyNzIsIm5iZiI6MTc4OTAyNTI3MiwiZXhwIjoxNzg5MTExNjcyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNKWDdpbU1ldFNlR0ZCcXg0UEp3cm8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.B55jwz2T8seKZlqyiRtaXHGAkJKNpPflzCT-hNCSVctcK4iGjDBDUOr-_z-BvLVsEVrDmO-v2HhAIo15PE8hyybGwzymksTkUUtAI5ybJMvmun-UF61683HuDJ6HiwD7Iejt54fVu6VA9iU7sF4sskqT-HELpZpTuZOKBLHJcAdRsGkm6xnZEKc456eNBxIXrSA-U7J_r3NRmYG8tN2MyS3w9rbeGAoztnYCeuxvcLlOPyydLuvPxD6dVdniDaFCWsJaln2_ylphSxFAbwonHYQXA8-NKiwQfbdb_fPvNuQrj34BFKBMRWlTH_r7Zggj_FHBjnhgI80FulQqNVn8w0oKMQW_fu0XQUosWs9Kme2XXyYwGqUbs4Mu_e3e4X0HPgxJNfm71jyFqGQvmPhaF6OXktBm87pOBQnYy95Q7o0cJ_csrIB48dSGYpwzIZhuSjniUgV4pe46YrKLOwKCqriyQiJ6iTZo2I_GtPMjnwBJSe-AhoNJir-SRXbHJBceKQMCL94bm2dau_nq_lZNus3wBvE7oBP29tti9yqHQ69t5clkS2pz38dJD-HRDIuJ1GykoFDvYR704L-k-yMCoyERDiXwppyBlrnscL7C_jctIMUxiZM-ZPvLFlpiZuV2l2qqSggNGw0a2DHYOjFXa8W1snfSsDdk3S4ybdhcI2Y
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 8
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2957

{
  "id" : "spl_7OVfFBGMWMZCGHg4QT5By1",
  "sample_id" : "S813702155",
  "sample_definition_id" : "sdf_6km5JHPIq0pyXBJ6wGLnjM",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-09-10T09:27:52.189604Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1820393181" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_70lN3IYkinKIImPjY01Wut",
    "project_id" : "pjt_55DjJI58PUzVN9zhilfFsi",
    "name" : "wCQlJQZfin",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5YTLdyXf2vpvzRkqpIfMrL",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "H4arfXZFhC",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_eMnhlHvM2qrAIA0Mv967q",
      "name" : "vHfb3BMNpf",
      "email" : "DBsymXqq@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_uNaHoVGdX34l621A6Mmxp",
      "name" : "VGvKZ3zAZV",
      "email" : "6gLHlhnR@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:51.666512Z",
    "updated_at" : "2026-09-10T07:27:51.666512Z"
  },
  "animal" : {
    "id" : "aml_5FpgIbC5SzKHSFuBst6GN1",
    "study_id" : "sdy_70lN3IYkinKIImPjY01Wut",
    "study_group_id" : "grp_7dVtGIU4dPoZZJPVmwkzDR",
    "cage_id" : "cge_n5bQ3zcvDNt52l5bjYIQR",
    "catalog" : "A0000001",
    "name" : "BMXmyQMp0k",
    "number" : 1,
    "strain" : "hw7xQ7u4nc",
    "species" : "oEkPNfQAMR",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "g6JFhTK9be",
    "ear" : "zQPsJQos7t",
    "tag" : "HHR3dAWvwb",
    "donor" : "PG5CYWp0iP",
    "tracking_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_MgthJzojmJiggIro8bZmJ",
      "name" : "0uhxrRxeHx",
      "email" : "TPWSlQB3@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_75uY7XKik69BECb95GLtvs",
      "title" : "Found dead",
      "comment" : "9q9Ftr2lAt"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-09-10T07:27:51.935564Z",
    "updated_at" : "2026-09-10T07:27:51.935564Z",
    "disease_induction_date" : "2026-09-10"
  },
  "user" : {
    "id" : "usr_3Feue4ahJp04MgHTOfkBAF",
    "name" : "sRjHYqCJPm",
    "email" : "oA1sVwnd@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "h5KvwDn7Ej" : "vXzcgUn5vF"
    },
    "created_at" : "2026-09-10T07:27:52.171827Z",
    "updated_at" : "2026-09-10T07:27:52.171827Z"
  },
  "created_at" : "2026-09-10T07:27:52.189767Z",
  "updated_at" : "2026-09-10T07:27:52.189767Z"
}

Update study samples [BETA]

Updates one or more study samples in a single request. This is a partial update: only the fields you include are changed, and any field you omit is left untouched.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/samples

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

id

String

The unique identifier of the sample to update. The sample’s animal is derived from this identifier.

sample_id

String

A new human-readable sample identifier.

status

String

The sample status, either planned or collected. collected requires collected_at. A sample that has already been collected cannot be changed back to planned.

collected_at

String

The date and time the sample was collected. Once a sample has been collected this value cannot be cleared (set to null or blank).

timepoint

String

The collection timepoint as an ISO-8601 duration.

comments

String

Free-text comments for the sample.

details

Array

The sample details. Supplying this replaces the stored details.

metadata

Object

Sample metadata keyed by glossary slug, merged per key. A key set to null removes that value; mandatory metadata cannot be removed.

Request

PATCH /api/public/v1-beta/studies/sdy_2OnVEKcyCrPe1qcDEoYPeG/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YWIxMDEwZC01ZDI3LTQ0ODEtOThhMy1jZDlhMzZiMDhmMWIiLCJqdGkiOiIyNmMxNzZjMC1mZDhlLTQ5NjktOTQ2Yi0yNGU2NWFlNGMyNTgiLCJpYXQiOjE3ODkwMjUyNTAsIm5iZiI6MTc4OTAyNTI1MCwiZXhwIjoxNzg5MTExNjUwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0hERVdJVjFBWkxXUVAzaGZIeUJOMyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.Nosf0q9Guk_UZSPyy9U4_spFPIIr-ELlErJ2wvEsa4yfjqrS-4QMfe6uS82dtSBvBoUqQUyEBCeMU34LWiS3dSpMWOYtGcvpQwXqAXgai0M9f1oUcavPmWJn4PisVpPCU7AzV8zjV612oNPVkpNOXHt2B2yski8swVTd1C7GORgkCbWdDV0vr8fTXXAilhYkKHdjKDViP4gioLKUYyi8LM0DvavwGJ6ZMrX7RopHTMWG3zkPx3eP3LyNHdni5F6hGbXJpFCOwGPDcFlKbFToX38cRb1B4zpTESZp-6Oxi1JU8ssr9n5XOEQCFl1P2bjAVL9auFQoa-X_3dlNTMDg04DC3P4MzUJTCoJajWQN-d3fFHg7xeWjqffsSiW02x_pd_rp8s3moJJI80UGCCQLH_3KQdUyq_IfVR29Bjb3Za2v1qvJMQpcLVd-19O4tyql2JF71dW0G5zuDML2JCSJwqodP5Q2dUNqUMS90VbE3aIYkqFEQ4l_y1KOs-Uf7lVCoP1I31JdiezEUbp1RabveKw0nCrghwm8g6MdQj4Ye-mD2avAUpRCnD1bUn1DeRQdh58zbqUETv4mSelu5ZnE-Qa8e4MDIOOhD6r7zfjmV4WOq3T2LYo7ESDrNecATPktgniUs-MEWBhs-EHPFgisrMwjY6Ij8c32WHp2wqUt8Po
Content-Length: 336
Host: localhost:8080

[ {
  "id" : "spl_23Nl3wsyYidZGYv5g2ta9O",
  "sample_id" : "SMPL-9001",
  "status" : "collected",
  "collected_at" : "2024-01-15T10:00:00",
  "comments" : "Re-collected after thaw.",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "metadata" : {
    "sample-meta-1699540433" : "QA-approved"
  }
} ]

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 30
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3236

{
  "data" : [ {
    "id" : "spl_23Nl3wsyYidZGYv5g2ta9O",
    "sample_id" : "SMPL-9001",
    "sample_definition_id" : "sdf_2hg5UblKGAOeegTGj6SEzX",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2024-01-15T10:00:00.000000Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "Re-collected after thaw.",
    "metadata" : {
      "sample-internal-id-1016425156" : "SMPL-1234",
      "sample-meta-1699540433" : "QA-approved"
    },
    "study" : {
      "id" : "sdy_2OnVEKcyCrPe1qcDEoYPeG",
      "project_id" : "pjt_6RRDNbkK3r1mRYtCkiTBzu",
      "name" : "00T59SOe37",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5iexETARng4KhDjanA4Dy6",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "xPi2pQPN0D",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1fs5eAY3i2BFkATOElv9BN",
        "name" : "pSwLsOBYk1",
        "email" : "IeQFiYnE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5wpTEfGRN9yHb7vGBporpS",
        "name" : "wgKotCX2A8",
        "email" : "o2iJehm8@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:30.135479Z",
      "updated_at" : "2026-09-10T07:27:30.135479Z"
    },
    "animal" : {
      "id" : "aml_5io30zd0mJ60OFdWyiL5n8",
      "study_id" : "sdy_2OnVEKcyCrPe1qcDEoYPeG",
      "study_group_id" : "grp_FTruR1Rdkt7HvLXs3NAaf",
      "cage_id" : "cge_hIOD5NV1ILzBicLH5oEVD",
      "catalog" : "A0000001",
      "name" : "nn7jAgOiPQ",
      "number" : 1,
      "strain" : "HlDSz7tx6Z",
      "species" : "CQvb8bwnkP",
      "sex" : "m",
      "dob" : "2020-01-01",
      "tail" : "ImllUw7jSp",
      "ear" : "Yjwio3g6bQ",
      "tag" : "pyiHlRpKyl",
      "donor" : "TPMPmYneOd",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_2LmegvPbWE98ri89aRVO1i",
        "name" : "ObLWFZNQr8",
        "email" : "xx7i1NZw@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_370r5gTKrKPPB0p5VnVDoX",
        "title" : "Found dead",
        "comment" : "S1y9dCQ30Y"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:27:30.482225Z",
      "updated_at" : "2026-09-10T07:27:30.824464Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_7IwSKGSGx5k6IUXFv0kGH",
      "name" : "rfwInpTZcR",
      "email" : "JNqiUp9J@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "uTauekp7vu" : "m3wn731wVZ"
      },
      "created_at" : "2026-09-10T07:27:30.795015Z",
      "updated_at" : "2026-09-10T07:27:30.795015Z"
    },
    "created_at" : "2026-09-10T07:27:30.808661Z",
    "updated_at" : "2026-09-10T07:27:30.906797Z"
  } ]
}

List all study samples

Returns a list of your study samples.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/samples

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

Sort samples based on an attribute (animal, cage, date, group sample, study or type).

order

The order in which the samples will be sorted (asc or desc).

animal_id

Filter samples to return based on animal.

sample_definition_id

Filter samples by sample definition ID(s).

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/studies/sdy_7VzHgW6JfgkRF81SCLLG99/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MzhjNjFmNS05YWE5LTRkNTItOWEwMC01YTNiNzJkODk1ODciLCJqdGkiOiJjZDYxYjQyZi05ZDdjLTRiMDMtOTdkOS05NjhiN2YzZmFiMjYiLCJpYXQiOjE3ODkwMjUyODMsIm5iZiI6MTc4OTAyNTI4MywiZXhwIjoxNzg5MTExNjgzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNzdmRoTDZxREZHMHBWRzJwWlBkM0MiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.NYP2UIkleUsA_pPCw_vdGumi2APpfKdW-Hkl3KVO0Zx_FGNx4SQeBsBbVyJ3MoPQlwfMbi6p4pOyBbd6n8ZVciPpGIjarKFB304VHCgSPGyTRL86gflZiRl9JMuLVeE25ElIY2BrOKu1QuDyXZMkm5F0iGMU0nF-B35v1CzSfjR7DZ929WmoxskjUMir9a9GWu8rJL2CF0Xd8Jv8aK9SAmYq5BhriMDyzxSAGl92gdXAR56ufEihjGzpJEbrPQ6aX3n9fz5winYOSLI8MprMoQ3_vAR9XK7fAStQ9PEznrh4EYdOnfRqKFZacxXZ25sVvIvmlhulQDcwsxDH1C_jGCLDAmcwEVZH5O3AUyA790VZdrjhGhp6q_ZtP9INg_txvvuRoAcjoKXPDLco4qSmCjbV1reHCskK1hZ_L2A6M0-kaoLaJAtMDEp28BWbqsvIfd0E2icYe0yHT3yiMcOtzThXO0MvULTakM9HkpxcIFs9J9JquiNdmNfA1jY0KDSl1VuJ_bWBiBbpCB9t6QVjvzsRGbBAiCWLyEyvsczgdO1_jatiKSQ3ITGKzSLRpc3UUOiXsLq-jP9hF06sKbM-zwoOHoaKw_L8ff9oagTxKBGy56K-tvyfw4gqcs11GZ2GCC6DSiq3dE3k0pn0ZJPPENDo6WI8Cy_dPt3FPxfX_To
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 27
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3666

{
  "data" : [ {
    "id" : "spl_6acAuGCelQwdOFrVsiYchA",
    "sample_id" : "S1379053218",
    "sample_definition_id" : "sdf_6E3pmS7q2pwOyTISJTMwfy",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:28:03.847905Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-369547123" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_7VzHgW6JfgkRF81SCLLG99",
      "project_id" : "pjt_7RgOqiUn5O2N1RWGkJ0uq1",
      "name" : "Ymigt3EtxC",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1ehfI4iuBLjlG22V9KL58L",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "x2DYSrppkM",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5FgNxeWpkkQtOJujsGoBNT",
        "name" : "w6cdTtR2bs",
        "email" : "m7VH3Dit@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7mFQFq82iFqsRtODNspPH",
        "name" : "MgR90ISvYv",
        "email" : "xlebtE8H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:03.008309Z",
      "updated_at" : "2026-09-10T07:28:03.008309Z"
    },
    "animal" : {
      "id" : "aml_1hDTSo57rpADvtNW83WljB",
      "study_id" : "sdy_7VzHgW6JfgkRF81SCLLG99",
      "study_group_id" : "grp_2PQyx5kNIhbBWdAFrKMD1V",
      "cage_id" : "cge_1zuXhZNDr3Dlg5zsxsRDiP",
      "catalog" : "A0000001",
      "name" : "TuiLspJwXo",
      "number" : 1,
      "strain" : "s4AATnZCYt",
      "species" : "a0BpAEMp1e",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "48YZ02RYyE",
      "ear" : "FGhjwL4RIB",
      "tag" : "jaabXlDohb",
      "donor" : "TMVYQRrdAg",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_BlMUSAgiRjDVjzJoEqfyY",
        "name" : "iOkpVjjNnX",
        "email" : "vuBhuxp2@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2jqsHvNQv9lL3N9r0TkTtf",
        "title" : "Found dead",
        "comment" : "n2VVDgKCX8"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:03.466381Z",
      "updated_at" : "2026-09-10T07:28:03.466381Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_6Xy3uD0a5WMGtJgkBBI1JH",
      "name" : "dmBkMQtc4y",
      "email" : "Vb4AL5I0@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "ykWhA4qmjs" : "DudAyGIOUA"
      },
      "created_at" : "2026-09-10T07:28:03.834434Z",
      "updated_at" : "2026-09-10T07:28:03.834434Z"
    },
    "created_at" : "2026-09-10T07:28:03.848089Z",
    "updated_at" : "2026-09-10T07:28:03.848089Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_7VzHgW6JfgkRF81SCLLG99/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_7VzHgW6JfgkRF81SCLLG99/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_7VzHgW6JfgkRF81SCLLG99/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete study samples [BETA]

Deletes one or more samples from a study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/samples

Parameter Description

studyId

The unique identifier of the study.

Fields

Path Type Description

samples

Array

The list of sample IDs to delete.

Request

DELETE /api/public/v1-beta/studies/sdy_1kpFEjg2JTjMSgNy5SDFPP/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMDM3ZTBiMS04OWM4LTRiNWEtYWE2ZS00NzEwMDczOTc1MzkiLCJqdGkiOiI2ZjQwMjFkNy0xZjExLTQ5YmItYTg4Yy0wOGRkZTg4ZjdkNDYiLCJpYXQiOjE3ODkwMjUyNDUsIm5iZiI6MTc4OTAyNTI0NSwiZXhwIjoxNzg5MTExNjQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1RVbDdRc1JaNEk1c0lucFNQcHpnQSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.gLt8NRCudn3aPorjIGRec6XuzNvs6CESeAv3U9awOF2rH6fOuAN0vHYmjpHX41kVSBk-1bLTdEgvb8EOFajw0SnvZw0q-3ZRD6JuTMmFxS43Vr2PP_MBqsI38kSahgEHtq0x1yaRqWqD8maDv16LTQAg4OY1bJuJo61XjGAo4MwpwJItkladjQGNur6nModhbCFxwG0UP_j5YL36PTMFisXkvfPwVYpl7DnGQQeO7h6sWdBUprzLtsWVWegVPCVcZg714-RlnKHh2zYhESi_PHxJ3qBhUebp2OEqrOwrCa1Vw4aGmfu2RpR-eZLZgL3bGgKZFeGFusZ86sCQOqWVEdLKqDoopqNWY1fsZR0cDAvfqmLlOM016mah7vJCzraqEKxH0cRnTpEjRQkF_H1yhH3R_Re9vwSMudnfltjuw0I6DkJ9URwA-l2pmQ87NdZkOeNnCqO_dFKRShvHhikxHMWcQ7mC5J52SoTI8vDlL7s8igaRVvZnx63o0mHj4zhHPDhFTO3YpYGkPVcAnR-L7uiVZLwbe6dXR8AO8PkF7rOhNO0V0C-9LugeRTW6FGwgufIFAZpVkmkVLbc1RWXYLN5QXXSujJG-DSWyRcKoj9FgqOxtlJYAA2zZjEtQC_cHey1S_VplHhkzEAPd-6bXpmK-kz-q5E-PFgtdcROiHHk
Content-Length: 80
Host: localhost:8080

{
  "samples" : [ "spl_6zef3NopUM69vmanjCZtZY", "spl_3ctSmmu7IAecJUjBAUcWyj" ]
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 5
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Study Sample Plan [BETA]

This is an object representing a sample definition within a study’s sample collection plan. You can retrieve it to see the sample type, collection timepoints, and metadata.

Attributes

Attribute Type Description

id

String

Unique identifier for the sample definition

sample_type

Object

The sample type information

sample_type.team_glossary_id

String

The team glossary identifier for the sample type

sample_type.title

String

The sample type name (e.g., Blood Sample, Tissue Sample)

name

String

The name of the sample definition

timepoints

Array

Collection timepoints in format (e.g., "PT1H", "P1D")

details

Array

Sample definition details (volume, quantity, etc.). See Details attributes

metadata

Object

Key-value map of metadata fields, where keys are metadata slugs and values are their corresponding values

created_at

String

The creation timestamp in ISO 8601 format

updated_at

String

The last update timestamp in ISO 8601 format
Details attributes
Path Type Description

details[].key

String

The detail type (e.g., volume, weight)

details[].unit

String

The detail unit (e.g., mL, mg)

details[].value

String

The detail value

Retrieve a sample plan definition

Retrieves the details of an existing sample definition by its unique identifier.

Authorization: Your API token must include at least one of the following scopes: sample.read, sample.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/sample-plans/definitions/{definitionId}

Parameter Description

studyId

The unique identifier of the study.

definitionId

The unique identifier of the sample definition.

Request

GET /api/public/v1-beta/studies/sdy_5LCQXuZGVeNhDNwS5AqCCM/sample-plans/definitions/sdf_64HaryynrlqMllvU5Tm8Rl HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhN2U1NjI3OS0xYzQ3LTQ5YzAtOTkyMi05ZTkyZmFlYzdhMzQiLCJqdGkiOiI1OTllMWJiNy1iOWIyLTRmN2YtYjQ2Ny0zMDIwNzQ4YTRjZDkiLCJpYXQiOjE3ODkwMjUyMDksIm5iZiI6MTc4OTAyNTIwOSwiZXhwIjoxNzg5MTExNjA5LCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl81Sm1OZVc5dmxLZG5wMk5UTkhoY2RCIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.KwcvAiMhmkDVGl4e9nyKv__hxVeZgbiC1I-UcgL_kgbe7UuXnIG7HT7wsmdvdClNXoiODta1sC_fyE0NIjl-vEHf11uoHg1eVvsDHZVdWb-vlFRv4Wo0IBjuo7-Jp1sdczDtQAYC57uPuIYamQZReofUdEdattdrdKs6WqewnQvg3oA3uZKAVODToKtj_WnSEkB_V3qt3aurFIMRDoP5hAF33e4lLrf4YXutpeqve857GksnzxLCgyiuQtbcX4BIXC2nef5AYYoBiXVSrieFVlWGvlAvpoASv4UJoM1BfxoLL_pB536VfgKb30y2-nSEg9xJPKrGQvLQzO8ngIDaa5Nk5L2l1xWDK6fjSiscFsO-10TFh_vB_TtraZojwGzD_xw-lfBg0fPKeEVK6eszkGy8e-V_TdS_cDzRq94N-IwKp56oExIjO-4FfD-B_5VDZKxVAIb8mH_rmVzHiJGTU8Uc5P1qnNngKf1iz7rjAp3tlw3qMNn8uPreFoGhkcQCy27D0PsjGX4bQ0T95V80raXUS7sMB0DELXqGfm-m75OFRf5_kSORxTLwovzRndhEpPY0pnJ4xc8sOO0hHDnb5k6sqmIuKuUtAiq9buNHaLWHGKnVKmKXa2s1nKqPF5ZaTUcUyFnNbKUGtE1Bo52oKwj0k12Lqh7aDRp_DKX_qLw
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 11
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1505

{
  "id" : "sdf_64HaryynrlqMllvU5Tm8Rl",
  "sample_type" : {
    "team_glossary_id" : "tgy_3mkAHSevvv16nvFUmdytOM",
    "title" : "Blood Sample"
  },
  "name" : "Blood Collection Protocol",
  "timepoints" : [ "PT1H", "PT0S", "PT4H", "PT24H" ],
  "details" : [ {
    "key" : "volume",
    "value" : "3",
    "unit" : "ml"
  }, {
    "key" : "weight",
    "value" : "50",
    "unit" : "mg"
  } ],
  "metadata" : {
    "storage-temperature" : "-80°C Freezer"
  },
  "study" : {
    "id" : "sdy_5LCQXuZGVeNhDNwS5AqCCM",
    "project_id" : "pjt_vmvK1Kmu82f3vhPbY8YAb",
    "name" : "TRQwWvxTn9",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_75FNVXYV3MEUrUoAMKxyji",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "bAjKwoh9jQ",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1zRZ66NfYAnH1AnJv5D6xN",
      "name" : "L53Xe2Fi44",
      "email" : "tnuabRXM@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_Q2WXo30bpw6XvCeVIRg1O",
      "name" : "EL7COnWjom",
      "email" : "noPI3raA@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:26:48.397572Z",
    "updated_at" : "2026-09-10T07:26:48.397572Z"
  },
  "created_at" : "2026-09-10T07:26:49.252119Z",
  "updated_at" : "2026-09-10T07:26:49.252119Z"
}

List all sample plan definitions

Returns a paginated list of sample definitions for a study’s sample collection plan.

Authorization: Your API token must include at least one of the following scopes: sample.read, sample.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/sample-plans/definitions

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of sample definitions to return per page.

page

The page of sample definitions to return.

Request

GET /api/public/v1-beta/studies/sdy_74TSq2Vt54I3iAFknMzOMg/sample-plans/definitions?perPage=1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MjI5NzFmMi0yMDI5LTRlMjAtOTUyNy02NDVmOTFmNTQ0NTUiLCJqdGkiOiJiMmJlNTA2NC1kZDQxLTRjNTEtOWRlYy03MGM1ZDgyZWVhM2YiLCJpYXQiOjE3ODkwMjUyMjMsIm5iZiI6MTc4OTAyNTIyMywiZXhwIjoxNzg5MTExNjIzLCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl81Z2tKa0hzY3VOcE05QU92NVpNaDRFIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.U5AZFYYUZ4dRZhUYXdyuFO90pxnMbCWYushTGOVq5WLoTE4kAw1IpDxHbU2hGDpX8M5aLwrlCWmJVqT0ARSnMg_D975P_pGYThxDJmSUJPMu7xuId_z6hXLOA1_DLV-WO_Ri73EJ0h5YP4JbfrauU9PoXG_ctTtYrMLPVdi0BfnvFvmnaeoBpYaTJMdvPExwzfukaq3x80GRHJuZLwgxqCzVpAgDhs9aB8ll-Z0iYlQfP6Z3qbXApBjfOr3htZlKButFBhVctE3VaTvw6O3FnXryLcVEdBEIFCm-Pb64qs6eMGkpaUA6xRljBuIMYHKPJAC13MRXogm8YO3pDCFOahhNZxBb6v35F4MQM5bPRD05Ve_ZRjujKuOVDGf2tqahA6V3N04ffT0V4nDpIe2vwJwn0Jayh0BQuWRkhzlmKPsZPCVuzgLWQkMJUfg_cpYojENKzUYXbD4NC40qlYxzevSqXUj2AmOXggs2jHYDkSQbl3tItikMSSDM7LqGsb7oU3r-mji2Itm_4QaUS1Lef6fa8pC2FfCi9WWnVKaG-dHp312fLiZ6pGjsNq-PmQO0gntHrv5rn82Zoq8mSFLRDW09eLMOBAkcvj9_WwtTeiO7tiPHvO32yPy0xXUlazQ8UY8rSlsxryaOwPKHqENYnqY44gUUv4IAm0VY4-X0rn4
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 27
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2280

{
  "data" : [ {
    "id" : "sdf_4AzI0B7Tx0yVwGKMbWMbtc",
    "sample_type" : {
      "team_glossary_id" : "tgy_2RLwjhbKh83O3iHfVC7jVN",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT1H", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    }, {
      "key" : "weight",
      "value" : "50",
      "unit" : "mg"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_74TSq2Vt54I3iAFknMzOMg",
      "project_id" : "pjt_6zxpa0Va1RFLuQbc7H7K7g",
      "name" : "irOCn893eb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5E7hJG3490zdfenPOI3p8h",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "KYuHcnRxFR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5S4EUTLpugD81kCGosPdYi",
        "name" : "VmtYVqsZ1V",
        "email" : "vRHXIypy@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1BSH71dS72uda7yzagUv4h",
        "name" : "694IYn6Rvj",
        "email" : "pNLvtaGd@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:02.011035Z",
      "updated_at" : "2026-09-10T07:27:02.011035Z"
    },
    "created_at" : "2026-09-10T07:27:03.024472Z",
    "updated_at" : "2026-09-10T07:27:03.024472Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_74TSq2Vt54I3iAFknMzOMg/sample-plans/definitions?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_74TSq2Vt54I3iAFknMzOMg/sample-plans/definitions?page=24",
    "prev" : null,
    "next" : "http://localhost:8080/api/public/v1-beta/studies/sdy_74TSq2Vt54I3iAFknMzOMg/sample-plans/definitions?page=2"
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 24,
    "path" : "http://localhost:8080/api/public/v1-beta/studies/sdy_74TSq2Vt54I3iAFknMzOMg/sample-plans/definitions",
    "per_page" : 1,
    "to" : 1,
    "total" : 24
  }
}

List sample plan definition targets

Returns a paginated list of targets assigned to a specific sample definition within a study’s sample collection plan. Targets represent the entities (study groups, registered animals, or planned animals) from which samples will be collected according to this definition.

Authorization: Your API token must include at least one of the following scopes: sample.read, sample.*, *

Path parameters ./api/public/v1-beta/studies/{studyId}/sample-plans/definitions/{definitionId}/targets

Parameter Description

studyId

The unique identifier of the study.

definitionId

The unique identifier of the sample definition.

Query parameters

Parameter Description

perPage

The number of targets to return per page.

page

The page of targets to return.

Request

GET /api/public/v1-beta/studies/sdy_6zfUdMDpUF74aAFrntxiFD/sample-plans/definitions/sdf_24dUBLEJxCbg1BZZMDDrtW/targets?perPage=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxZjU2NTY1Mi05N2QxLTQ2NjEtOTFmYi04YTVmN2NkOWQ0OGUiLCJqdGkiOiJiYTZmNWRmYS0zOGYwLTQ5MjktYjc3My04YjhmYWZlNDc3Y2MiLCJpYXQiOjE3ODkwMjUyMTgsIm5iZiI6MTc4OTAyNTIxOCwiZXhwIjoxNzg5MTExNjE4LCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl80Z1dtTHhqYVlvTFdGV1U2cUtVbXJWIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.g2n4fMmp8ON1S7Qt698N5kstQClHBoPavpDK98jJgwbvvaV7qGatJUuzRPJtyIOT-2uTk8HA_nbY-6ZW-grgOIcPCDT-Qy6lpGVLSVFYn-2pGW53eVkngfIhjA2ws4Skwkg5d7KGrriwTpzggRU0-BC2fM_sqXpNudVcMWJY8BfQ-3HdbhWbBccbp4wbqKyuCAQrwwh-P0odykCKFSH7Z-zwA6VRqKrtHW6Mfu0ke1Ugv9uODxkkikqyJyosqsM0X2a1tlu4yVQYFEvMR-Bs2XGqGipfkv3aMYMpUY5EEt6LSzysFV_tOX2jlTwyhM5KAw0hwrPOtSOZZm5Kb5dO_PZ3NkEWNN8xnynT7kfdqPJWksqbRjeaRea_XgfrPX1yxx73R3IpV-5c0LdIUZaaLh88csTg8rxDlg2SROCB5IosEq7pKicVaz_Esoyvt0TPfPukX1-4HPsB__0gRATxndoXNWeKwwWjqFTnGkhC-FvfpZUOoHhw_KNdamZxN0pceylQk7cTT4WM35IyI_LzO4pvGvHnDqFsnnm3ND5a2KG3_RZMiRIlQrjxKVqRWjvQw__i1GAg__ahBOo_NUItIVzZna2tLso49rsm13dFiTS-PmPbVw64W7HE_U7L0vODeyz91Kqb64wuNvvGGq3Ky3nT7hIdvn7lhafiDIHjaAQ
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 2
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2743

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_21GFO5KN769N43VrYImnXR",
      "name" : "Control"
    },
    "sample_plan_definition" : {
      "id" : "sdf_24dUBLEJxCbg1BZZMDDrtW",
      "sample_type" : {
        "team_glossary_id" : "tgy_7dfDoIW3pyYqHughtz07E0",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT0S", "PT1H" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-09-10T07:26:58.293604Z",
      "updated_at" : "2026-09-10T07:26:58.293604Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_7NBCKNaIj2fHzWVi8WJ0WQ",
      "name" : "Treatment A"
    },
    "sample_plan_definition" : {
      "id" : "sdf_24dUBLEJxCbg1BZZMDDrtW",
      "sample_type" : {
        "team_glossary_id" : "tgy_7dfDoIW3pyYqHughtz07E0",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT0S", "PT1H" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-09-10T07:26:58.293604Z",
      "updated_at" : "2026-09-10T07:26:58.293604Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_4t3vkorOqsdY7RmlYKy7nT",
      "name" : "Treatment B"
    },
    "sample_plan_definition" : {
      "id" : "sdf_24dUBLEJxCbg1BZZMDDrtW",
      "sample_type" : {
        "team_glossary_id" : "tgy_7dfDoIW3pyYqHughtz07E0",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT0S", "PT1H" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-09-10T07:26:58.293604Z",
      "updated_at" : "2026-09-10T07:26:58.293604Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6zfUdMDpUF74aAFrntxiFD/sample-plans/definitions/sdf_24dUBLEJxCbg1BZZMDDrtW/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6zfUdMDpUF74aAFrntxiFD/sample-plans/definitions/sdf_24dUBLEJxCbg1BZZMDDrtW/targets?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1-beta/studies/sdy_6zfUdMDpUF74aAFrntxiFD/sample-plans/definitions/sdf_24dUBLEJxCbg1BZZMDDrtW/targets",
    "per_page" : 10,
    "to" : 3,
    "total" : 3
  }
}

Study Treatment

This is an object representing a treatment entity. You can retrieve it to see the treatment’s attributes.

Attributes

Path Type Description

id

String

The unique identifier of the treatment.

type

String

The name of the treatment type.

name

String

The name of the treatment.

label

String

The label of the treatment.

external_entity_id

String

The external identifier of the treatment.

dose

Object

The dose concentration associated with the treatment.

dose_volume

Object

The dose volume associated with the treatment.

stock

Object

The stock concentration associated with the treatment.

volume

Object

The volume of the treatment.

metadata

Object

The metadata associated to the treatment.

study

Object

The study associated with the treatment.

created_at

String

The created timestamp of the treatment.

updated_at

String

The last updated timestamp of the treatment.

Retrieve a study treatment

Retrieves the details of an existing study treatment.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/treatments/{treatmentId}

Parameter Description

studyId

The unique identifier of the study.

treatmentId

The unique identifier of the treatment.

Request

GET /api/public/v1/studies/sdy_2e78nboa69H8E63UE2lxD0/treatments/tmt_3DQ4DT2bqEX9LGcaj9H8sz HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNGVkOTI1NC0wZTdhLTQ2MGYtOWEwOC0zYTZjMzc0MGM1N2MiLCJqdGkiOiJhYTliZjI2YS05OGNlLTRhNjAtOTZkYi02ZmQ3NDBkYTY1N2UiLCJpYXQiOjE3ODkwMjUyNzUsIm5iZiI6MTc4OTAyNTI3NSwiZXhwIjoxNzg5MTExNjc1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE5Z2gybXE5UDJMWHlLZDQzb0Y2ZmwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XA2p374gIWP6II_zcLx6_nX84_qQso271h1Vuxi20KPvNcumjs6Okngpy6mdy5PUXzclB9eB_VmiRRUUteQyaRkbwtkRfHURO5_wZgS08Iw8OkazsphaSFcupJhMh-ZQVkscLYrE_GoOWSC3J-MyasKzd5ULgyX3pAOqYYbS2LyLT2LY7ST7eImnO0F-VD3cRv5gQLNGIDy9kGzvUGjc-Ke2LPF3k2Rb9AQ8_a_flLBQNPCJpVJd8GhSRzNXKykgp9vXj9B9YoA_huE6jwnQcmrpOjiqXgh4mIni_PXRf_Vns9LV-5unfniEtjDpeeOES4cHYT8eyNOy6ZzpIYZAdsIatMNS60lzKj1f3B8keiSD8XOMbUsZuu7Bcg_mPOnaoClgT0Qt7OCjVvnZYYgzNmk3LnPFugUmjsxqpAw7u5PTxxNpUBYbcsEIUrFfFAZ9dfZ38vdxhmvscc2vAjqkl_JwyrO9miOwjJ8DVKv6XK96qKLN7J4BW2ubTVDFaIlaOHc4DrCRnQiZrIZIloiEK2wot7A_0Gsv7Nl_Br6aBmsTrjs5_czEXDdGyKCgj0-y0lihVM77AxxwAjul6oVa-XHszMJFQJcG59yZy6VI4q-Gigo9dvLTvhH7VZDssrAarKruO_VcHEdOnbWsKcfs_zyRfIn5h-SuZ6cykDvD8ms
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 5
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1746

{
  "id" : "tmt_3DQ4DT2bqEX9LGcaj9H8sz",
  "type" : "volume",
  "name" : "gC4IUtDkDX",
  "label" : "Test Treatment Label",
  "external_entity_id" : "Rw6xRvpbYS",
  "dose" : {
    "unit" : "mg/kg",
    "value" : "5",
    "display_unit" : "mg/kg",
    "display_value" : "5"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "15",
    "display_unit" : "ml/kg",
    "display_value" : "15"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "10",
    "display_unit" : "mg/ml",
    "display_value" : "10"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "8",
    "display_unit" : "µL",
    "display_value" : "8"
  },
  "metadata" : {
    "treatment-internal-id" : "TREATMENT-1234"
  },
  "study" : {
    "id" : "sdy_2e78nboa69H8E63UE2lxD0",
    "project_id" : "pjt_2wRm1ssJZJ3wX8tVBQjAZE",
    "name" : "0AbX56C4N3",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4P7cV9CEDrVISRty1RMiea",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "7MvRUygdd3",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3OgwRN7hurZoWF7vDoTb3I",
      "name" : "ffcMSSG1WM",
      "email" : "a8kQuWwT@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3VQNCXFX4wVvh6SVDhzI6A",
      "name" : "fqW4bMikSv",
      "email" : "8t9PHKrC@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:54.954020Z",
    "updated_at" : "2026-09-10T07:27:54.954020Z"
  },
  "created_at" : "2026-09-10T07:27:55.521527Z",
  "updated_at" : "2026-09-10T07:27:55.521527Z"
}

List all study treatments

Returns a list of your study treatments.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Query parameters

Parameter Description

perPage

The number of measurements to return per page.

page

The page of measurements to return.

metadata

Filter studies to return by metadata value

Request

GET /api/public/v1/studies/sdy_kAcaafIOa8hPwaThB9qiJ/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkYjdmZDQ1ZC1jMDU1LTQ1NWMtOTBiNi1hZDQ5Y2I0MTM1OTIiLCJqdGkiOiJiYjYyZjE1MC0yNjVhLTQxOTYtODVlYy0zNDA4OGY3Y2Q0NjYiLCJpYXQiOjE3ODkwMjUyNzQsIm5iZiI6MTc4OTAyNTI3NCwiZXhwIjoxNzg5MTExNjc0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzYxWGNIVGtZV2I0ZlIxM3VsbE5EQXEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.kbmzej4JY-s2o67cT6bv7Wq87dz533DAf7UtocKekOuGBV3mHRIDGFLnC4fauym3I6MzwGeQiOJHH7GHM7Qxr0Kl0CUgGAf6PObweO5fbDYTk65vojcW-_QHyh4laikgQdzXutcm5tqSjWLci8hWQ1WYTVP1KscQl9fXytyElkX0DOwtVZ9iZB8492cfHsaGgCCrcBoz53FLS9QL0NZTYTK3Zw4SbjFSTssjNOtydMsT5Jo8sGFuY9__sGNt7l4AlrwV1eZa0Rd9_ODuUribjmA6001xc44XEKEgv9DpPFraThJDyKPV2VGkUP_ic8UNsgh45IpaGSVFnxleZa8vjfrHpP0-3kXHbucw4hpxDR2r5-3fwRj49ioR49OC3YSZIJAw4XSzBJfNAgKhchN3vklm2_Lm7Hq8xCij_-z0X3eXwKDLsBImHtTUaZ7S1qvVi6SxIPtwLRdc3TYkhI6Am74En6VGF4Y4xGLS44eqmigLPZmYHcIX8XaeAzRM1cIGZ-X4b9RT7CZh_kUAqweBCm8_phAdPFpW6Ll34hGayxwUQyo24Aqk86AKcVxCWjWtY2de7mEBHqrdseWedmX-wXr74bGLHEpioawVyeEKr9F9BpHiSTt2Shy3HRUqsOrSxRl5zi34pm-m90RYvI_JtnwjBOAaPdvxBrnulat7vVs
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 6
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2401

{
  "data" : [ {
    "id" : "tmt_boJS6VHQnwfbCQg36KvjC",
    "type" : "concentration_vgkg",
    "name" : "cJZosPB4Fb",
    "label" : "Test Treatment Label",
    "external_entity_id" : "xhjaLqd7CE",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "study" : {
      "id" : "sdy_kAcaafIOa8hPwaThB9qiJ",
      "project_id" : "pjt_6a9HUzqXtM92rVOV51xeqH",
      "name" : "6YZF3laB3z",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7I77yX5TC83NeVP4KFnmO9",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "N4HTLLHhFV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2L7jPG6I9ece5NHcXqx4sj",
        "name" : "0BdFrYKafa",
        "email" : "DfVgem1m@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1MO8ndfQNZQ4HZJ7yXO56i",
        "name" : "BKfMbqs4xU",
        "email" : "HYpPCjrf@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:54.228508Z",
      "updated_at" : "2026-09-10T07:27:54.228508Z"
    },
    "created_at" : "2026-09-10T07:27:54.735501Z",
    "updated_at" : "2026-09-10T07:27:54.735501Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_kAcaafIOa8hPwaThB9qiJ/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_kAcaafIOa8hPwaThB9qiJ/treatments?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_kAcaafIOa8hPwaThB9qiJ/treatments",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Task Spec

This is an object representing a task specification scheduled within a study. You can retrieve it to see the task identifier, type, schedule configuration, target assignment (animal or group), and any associated study metadata.

Attributes

Attribute Type Description

id

String

Unique identifier for the task spec

type

String

The type of the task spec (e.g. sample, dosing, measurement).

title

String

The title of the task spec

description

String

The description of the task spec

execution

Object or null

Execution configuration. Present for task spec types that have execution data (e.g. sample, dosing, measurement), null otherwise. See Execution attributes

schedule

Object

Schedule configuration. See Schedule attributes

target

Object

Target configuration (animal, group)

study

Object

The study associated with the task spec.

created_at

String

The created timestamp of the task spec

updated_at

String

The last updated timestamp of the task spec
Execution attributes

The execution structure uses a discriminator pattern. The type field determines which nested object is present. Only other type has a null execution.

Path Type Description

execution.type

String

Execution type

Sample Execution (when type is sample)

execution.sample_workflow

Object

Sample execution configuration

execution.sample_workflow.samples

Array

List of sample glossary identifiers

execution.sample_workflow.auto_generate_sample_id

Boolean

Whether to auto-generate sample IDs

Dosing Execution (when type is dosing)

execution.dosing_workflow

Object

Dosing execution configuration

execution.dosing_workflow.treatments

Array

List of treatment identifiers

execution.dosing_workflow.skip_dosing_for_un_required_animals

Boolean

Whether to skip dosing for unrequired animals

execution.dosing_workflow.use_new_body_weight

Boolean

Whether to use new body weight for dosing

Observation Execution (when type is observation)

execution.observation_workflow

Object

Observation execution configuration

execution.observation_workflow.observations

Array

List of observation glossary identifiers

Measurement Execution (when type is measurement)

execution.measurement_workflow

Object

Measurement execution configuration

execution.measurement_workflow.measurements

Array

List of measurement variable identifiers

execution.measurement_workflow.weight_percentage_change

String

Weight percentage change tracking mode

execution.measurement_workflow.assign_identifier

String

Identifier assignment strategy (donor, ear, tag or tail)

execution.measurement_workflow.cursor_position

String

Cursor position for measurement entry. Must be one of the values specified in the measurements array
Schedule attributes

The schedule structure depends on its type value. See the corresponding nested object below for details.

Path Type Description

Common Properties (always present)

schedule.time

Object

Time configuration

schedule.time.type

String

Time type (all_day, timed)

schedule.time.timed

Object

Present only when time.type is timed

schedule.time.timed.from

String

Start time

schedule.time.timed.to

String

End time

schedule.type

String

Type (one_off, recurring, conditional)

One-Off Schedule (schedule.one_off - when type is one_off)

schedule.one_off.duration

Object

Duration configuration

schedule.one_off.duration.start

String

Start date

schedule.one_off.duration.end

String

End date

Recurring Schedule (schedule.recurring - when type is recurring)

schedule.recurring.duration

Object

Duration configuration

schedule.recurring.duration.start

String

Start date

schedule.recurring.duration.end

String

End date

schedule.recurring.repeat

Object

Repeat configuration

schedule.recurring.repeat.interval

Number

Repeat interval value

schedule.recurring.repeat.unit

String

Repeat unit (days, weeks)

schedule.recurring.repeat.days

Array

Days of week (for weekly repeats)

Conditional Schedule (schedule.conditional - when type is conditional)

schedule.conditional.condition

Object

Condition configuration

schedule.conditional.condition.type

String

Condition type (age, study_day, tracking_day)

schedule.conditional.condition.value

Array

Condition values

schedule.conditional.condition.unit

String

Condition unit (days, weeks)

Create a study task spec

Creates a new task spec on a study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs

Parameter Description

studyId

The unique identifier of the study.

Request

POST /api/public/v1/studies/sdy_7LSbJqaqnX1UqCyEsz6JiF/task-specs HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhZTU3OTk3ZS0wMDhjLTQxODAtOWM4YS00NmM2Mzc1MjY2ZDIiLCJqdGkiOiJjYWExNjk4Yy02NWE1LTQ1OTEtYWU2ZS03MmY1MDNkZjc3YjciLCJpYXQiOjE3ODkwMjUyODQsIm5iZiI6MTc4OTAyNTI4NCwiZXhwIjoxNzg5MTExNjg0LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMXk1UlhZV0JWamNYVDVEUmpnQllpTCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.FyrHlgIY9VkHML8ktjMirQx6m3KQy--GDxOviG6ADEbXTlOU8cbPXNXFXa44lgEibOf5jHQjiOH55ufueVeuk6S102CIWA8kQNhwSmZDKNvGznlz71pH_RGJl6TE32rU_yN6BtKKLLu3z_-6iPi7JVCO4j8nt9xh46g4C1maMGc7ECqQGSqauEG_cIdH3dHoYhLoBhTFrMc_1U26Mxvkg7fw7nZUft3kfH5hBSNkj05oTF6Fyj8nXCKhZYNAgsFNtROTq14VRRlY6U7dtRoL0R2d5ZtndOYvNud2DCLYnaW6vEJBTzuTHowbEr62cJFK3kbu1bz_IDzaS2fYWQwDsBj0hT5XuD8d32rq-k0s8K27TaOxoTKhXB9YaQdC9vmTLzX-6MabO8lNzboCHE3HFBQHaHzQYf2gcKqQjNeWESzRztBrYe-yyQqNewP7fIA0vgMuyqY1PRAtQ0VsND-6CBlgseF1RuQFh-6-3oTIX6HT-P66pe9fsga6qR0TeX0QsdGAt6-3POTVVy1u97mVtEEZwhWdcFes4MfbKczz8rht8C45NZprIkqbMHohxeYFdaI9vU5O8IDJ4o1ZMAODK0zBj0rzNDKn91EsnbQuoHsMmTu3G-iWr02K4WSUnsnU1naOXU2M2VoqGRete85sFqzNx-eqB45R6t86ruDqUH4
Content-Length: 815
Host: localhost:8080

{
  "type" : "measurement",
  "title" : "Weekly Measurement Recording",
  "description" : "Record weight and body temperature weekly",
  "schedule" : {
    "type" : "recurring",
    "recurring" : {
      "duration" : {
        "start" : "2024-01-15",
        "end" : "2024-03-15"
      },
      "repeat" : {
        "value" : 1,
        "unit" : "weeks",
        "on_day" : [ "monday" ]
      }
    },
    "time" : {
      "type" : "timed",
      "timed" : {
        "from" : "09:00:00",
        "to" : "10:00:00"
      }
    }
  },
  "execution" : {
    "type" : "measurement_workflow",
    "measurement_workflow" : {
      "measurements" : [ "weight", "body_temperature" ],
      "weight_percentage_change" : "tracking_date",
      "cursor_position" : "weight"
    }
  },
  "target" : {
    "type" : "group"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1973

{
  "id" : "tsp_7TMzkA69JDy86KHqlqU3EJ",
  "title" : "Weekly Measurement Recording",
  "description" : "Record weight and body temperature weekly",
  "type" : "measurement",
  "execution" : {
    "type" : "measurement_workflow",
    "measurement_workflow" : {
      "measurements" : [ "weight", "body_temperature" ],
      "weight_percentage_change" : "tracking_date",
      "assign_identifier" : null,
      "cursor_position" : "weight"
    }
  },
  "schedule" : {
    "time" : {
      "type" : "timed",
      "timed" : {
        "from" : "09:00:00",
        "to" : "10:00:00"
      }
    },
    "timezone" : "America/Los_Angeles",
    "type" : "recurring",
    "recurring" : {
      "duration" : {
        "start" : "2024-01-15",
        "end" : "2024-03-15"
      },
      "repeat" : {
        "value" : 1,
        "unit" : "weeks",
        "on_day" : [ "monday" ]
      }
    }
  },
  "target" : {
    "type" : "group"
  },
  "study" : {
    "id" : "sdy_7LSbJqaqnX1UqCyEsz6JiF",
    "project_id" : "pjt_1VjT1NlaQJAtnlUoT0Nf20",
    "name" : "NKVmGhB9os",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5DZ69nPkxOpcurNSLbrc8m",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "0IlOvKwoXh",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_128EfS9emyuc1fR1zaPJWd",
      "name" : "Pkipw80ygx",
      "email" : "izPjhcAB@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_26mmPUH5DpU0BAkX97TZaX",
      "name" : "yt1SOd0pwZ",
      "email" : "NzPmYMUH@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:04.391589Z",
    "updated_at" : "2026-09-10T07:28:04.391589Z"
  },
  "created_at" : "2026-09-10T07:28:04.679274Z",
  "updated_at" : "2026-09-10T07:28:04.679274Z"
}

Retrieve a study task spec

Retrieves the details of an existing study task spec.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Request

GET /api/public/v1/studies/sdy_4I8gGdtX4HEviy4L2jjoEv/task-specs/tsp_2Z3wOcuU0l0s9H6up0umd6 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiNDZkODdjOS00ZDNhLTRlMWEtYWExNi0yMDU5MzI0Y2E3OGIiLCJqdGkiOiJiZjVhODM4NC01ZjgzLTRmM2ItODgxYi02ODM1OGMyNzYwNWUiLCJpYXQiOjE3ODkwMjUyNzIsIm5iZiI6MTc4OTAyNTI3MiwiZXhwIjoxNzg5MTExNjcyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN6OGMwT3hVT2J2c1B6RjVxcktWTGkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.CeUWC3gvzR6q0msuQ4ui1yWRPW3F7AFMQinmDeqiEoA_aGc3SRcJRc8k-aVmb3TqD_OAGUqo6ncFwycJr-f8zv6RPpkk_mMt9a11Uu6-HkBetxd284oBiTEr7MupivBGKUf5-K25j2kBvFIzJBJzkF36CLIpzI5rKU_adWrJst84ZAUjrNb8y0QXeVWLXt3dpmHCoiowyPcVqmriUMhuBv272VPdmpIlwzcggZ7bt6NckKSG9_aSrryA1DYv2Bx9sHZzhq1CBVHagKX2m0ZLSH1fi5au54_mn8gaP8abhZep0s7XU7fmz9uf5o_x8FxdGR02bP0ESsGvJDYN3K9dM1Mn_KhPJ355EV9WOo1OiOV7cPr6sy46JBusmGl1KHOluxIgexrW0IKq0RQSUbKFP0dq8tPfaqKcJ7gevbOjwarmHpslOMcaRFtCmY1-SCFff1mSnpgW5tmft5S7RR_uhcTbVY8JB4PHJH2D1VflSNFF8foIYlM9ZnICKhP_WfdXyfZzIbjw26PzoD36agshyMTaXGBItQBY6eLaTTNpQ3udeOTqWzXsQ1UbVKOhIjKrov0wt5Xee4glaPPVXjTqMp1v0QhaOAWot9Zizf-PiriFEy3kN4UfkzbezRdV_jVDcyD30yzn18h0iqPdJD7Pk7L0UuJp_OsTp5OyStR1C1I
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 8
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1700

{
  "id" : "tsp_2Z3wOcuU0l0s9H6up0umd6",
  "title" : "dEZsHOY3gd Task",
  "description" : "xTXiZrvIHW Description",
  "type" : "dosing",
  "execution" : {
    "type" : "dosing_workflow",
    "dosing_workflow" : {
      "treatments" : [ "tmt_HULccuSgZfDwMZTDjSdRF" ],
      "skip_dosing_for_un_required_animals" : true,
      "use_new_body_weight" : false
    }
  },
  "schedule" : {
    "time" : {
      "type" : "all_day"
    },
    "timezone" : "America/Los_Angeles",
    "type" : "one_off",
    "one_off" : {
      "duration" : {
        "start" : "2026-09-10",
        "end" : "2026-09-11"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_4I8gGdtX4HEviy4L2jjoEv",
    "project_id" : "pjt_2JpoqcC1gZVCmPrPZARV3q",
    "name" : "zxpdXzie9B",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2tAEDgfUY4HL9ssnPjRi00",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "Ao1w1Golh9",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3Btuu6JMsQxoJn43wusvYB",
      "name" : "WABy2U7XIL",
      "email" : "DYkM4VOi@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_7E2PTtBMDApK2dXCcJvjkQ",
      "name" : "EQFwAfUGNG",
      "email" : "eXBzqYOA@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:52.544778Z",
    "updated_at" : "2026-09-10T07:27:52.544778Z"
  },
  "created_at" : "2026-09-10T07:27:52.901258Z",
  "updated_at" : "2026-09-10T07:27:52.901258Z"
}

Update a study task spec

Updates the specified task spec by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Request

PATCH /api/public/v1/studies/sdy_44MSKdrzaWUt1Rp3T7cBmm/task-specs/tsp_3brnauCnyiSUeNy651eR7s HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4OTA0MmQ3Yi1mM2QxLTRhZTktYTEwYS0zOGYzZjJlODc3ZWEiLCJqdGkiOiJiMWQ1NmM1MS02ZTI4LTQwMWEtYmJiNi0yM2ZmMTI5NjljOTciLCJpYXQiOjE3ODkwMjUzMDAsIm5iZiI6MTc4OTAyNTMwMCwiZXhwIjoxNzg5MTExNzAwLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNEJwZGxwd1F2NWRIZ2FvQWhGRzZQQyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.md42eVrewXLIsNVuogiYb6sdB9VwuqvNtJ9ZpHDDhPE8CYNdC1rXwP1KhvTMFB3CT-AfhSOtz7ssEU7emQjksMZ_YzSxLffZcUHDBXGAD9eKQP7bM_vCmJWCWaR4cfyABQF22xZxRmrZlzU3Ab7JoSAoEgy0HHJqKZ900ppmDWGBABzv1zNGKfJxzl5T9-appHz8qxSF5d_FweqVFV9xBzp34dOE-u0d1_O3V0-tmIODnpxQ6tEWJ2gk_cTJ9KdregCeCcuNZFNkfMMpsZR07OqP6MiyOrj0RGLdetWKvSSlKgl1IlGqET_Fg_JSEH2AC5zKCn3-HDWLegwq5NOP9TavnhJHbihHmOU5iMKZn4RowOskLZMT3kRO_1-mWU3OTRk0dtUPMePaimuWPSZR2OlbVdVH2oAtfJHho1xPhpt_ofdJYRj4xA7Mi_VMitzZo-NlvTQRIytepxFA95yV_DDtOYsKE-epHJ5o8Y6inqLQAUAIuE9htAAGCQoP3OF7qNwZQsMrBmImle8lBBXrmOx1n6FB7ElCw6wbqam9KRv_xofod03M1GulU9dfW1sV9MDZsXNBCMJ0B4ye3EbKKZ3FQIxkk6-aUJwmtr324g4BH3NKGWaH3RncRpEapGEnNEW2ZFfDfnqGhDDESD5sfhoBBZrT3zIV6w4LzMutG28
Content-Length: 260
Host: localhost:8080

{
  "title" : "Updated Task Title",
  "description" : "Updated task description",
  "execution" : {
    "type" : "sample_workflow",
    "sample_workflow" : {
      "samples" : [ "tgy_1FxjgCoxtOM7reB5A9jCvM" ],
      "auto_generate_sample_id" : true
    }
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1653

{
  "id" : "tsp_3brnauCnyiSUeNy651eR7s",
  "title" : "Updated Task Title",
  "description" : "Updated task description",
  "type" : "sample",
  "execution" : {
    "type" : "sample_workflow",
    "sample_workflow" : {
      "samples" : [ "tgy_1FxjgCoxtOM7reB5A9jCvM" ],
      "auto_generate_sample_id" : true
    }
  },
  "schedule" : {
    "time" : {
      "type" : "all_day"
    },
    "timezone" : "America/Los_Angeles",
    "type" : "one_off",
    "one_off" : {
      "duration" : {
        "start" : "2026-09-10",
        "end" : "2026-09-11"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_44MSKdrzaWUt1Rp3T7cBmm",
    "project_id" : "pjt_3ILeIvqymeDOnAWJFSzDlv",
    "name" : "TDDHDZ4rZG",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1bQ2IsyA1MLBfEWglIjCBc",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "7DViIaLwPc",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1qtXUPdWZMGFXOsU0lLMFc",
      "name" : "JjV7ZsCGMs",
      "email" : "99llA9NE@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_KEqVEe8Vh9EH1OISooZMy",
      "name" : "aaJ5YJ2ZJ1",
      "email" : "EoW4oFCn@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:20.639121Z",
    "updated_at" : "2026-09-10T07:28:20.639121Z"
  },
  "created_at" : "2026-09-10T07:28:20.874926Z",
  "updated_at" : "2026-09-10T07:28:20.916691Z"
}

List all study task specs

Returns a list of your study task specs.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of task specs to return per page.

page

The page of task specs to return.

type

Array of task spec types to filter by. If not set, all types returned.

Request

GET /api/public/v1/studies/sdy_2ARw2E3ef2glBrZNAVxFUj/task-specs HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYmQ0ZmNjMi03ZWVkLTQ4ZTItYjZmYi04M2IyZjI4NGNhYzMiLCJqdGkiOiJmZjZhNjA3Mi1iM2E4LTRlOWMtYmFmZi01OTdlOWI4MDRjMGEiLCJpYXQiOjE3ODkwMjUyNjYsIm5iZiI6MTc4OTAyNTI2NiwiZXhwIjoxNzg5MTExNjY2LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNXY2E5aXpjZmNCSnBTNXFBS2RLZjgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.E6dvtTjqXmnMYj_X5RWNe7bfNcx9Ub1NSY4oeJPoyAtBnE4u-gbzwHwdmObi60-shyldaTUqT5aAn1v_JYFJ3hQNyNSqTqFkBThPjcbRuYPFaaF4NCaEEMAyRJK0pH7AkKOmylPmH4vw5lcmL2csOLh6IHWKEYMuP8OS5TLjQ_ELkrE4NAYcsJDAU0xA5FRlR7Im-xB3BBvaiwndiEgPHtcFOfSaTRlG8lTftN0_8YyzmGgRmN1pqP8z-dCxTFQ4rKZPRdRzKisVHGpn6-Vt9e6auRgq3VOH51EQv68YPe6DeZOIlQ3rPi242dELpVFCkAcvXsH-GYEtSRmvTFp0bgsKWxsddYFZ3J4oNEwc2swy4NaPjlILL64Ns-_yA5URjlqzQpvDEtxJZ3yfw8kQFTGL5_uXULB9HQvYnfpb1GG9Arx6ayTTz0TGwGgE6_qao2P39gdB4zu1ehPmiPtMzmvNChMgvjDPDFFK0SBOqEg85_G462PFnwzkcuierNi70Gqw9wW5fWsYbjEdJZPH7a80Q451uuYCfEcI_QGWpohMB3NfNZhZfGHtTqUnSf_qH_WmXcIrBcR8G-Ikp2zmZ7xbC-j3gQ7vHyG2369fc-0625JXA2fESglvq4hUtFZtk8Woc27d8aaDk-vC74UDSKx8Q2X1q0c2uCc0LBpt7eU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3946

{
  "data" : [ {
    "id" : "tsp_1epz3Q9u7jx36lY8TuFvr9",
    "title" : "Sample Task",
    "description" : "Sample Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "timed",
        "timed" : {
          "from" : "09:00:00",
          "to" : "17:00:00"
        }
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-09-10",
          "end" : "2026-09-17"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_2ARw2E3ef2glBrZNAVxFUj",
      "project_id" : "pjt_erJreyboyvC6POkpisa8G",
      "name" : "6mDPwKKMip",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_N9921TZrXE01SMMUpy3rj",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "QelXyba5vO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3OcBcvlP7Kxx0puxNTFDVI",
        "name" : "Hz7ZLDquVr",
        "email" : "4nsbMPq2@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1bDBcuA4omDQV6Iepmw37q",
        "name" : "73CF8S5TyZ",
        "email" : "8qBMBbHJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:45.836724Z",
      "updated_at" : "2026-09-10T07:27:45.836724Z"
    },
    "created_at" : "2026-09-10T07:27:46.226047Z",
    "updated_at" : "2026-09-10T07:27:46.226047Z"
  }, {
    "id" : "tsp_TEkS7Y4gxa0pfkv8nXY2v",
    "title" : "qcdtmmLFR0 Task",
    "description" : "3QpfmnZ9xL Description",
    "type" : "observation",
    "execution" : {
      "type" : "observation_workflow",
      "observation_workflow" : {
        "observations" : [ "tgy_6QB5cE04Eh8EIYnJjndaEU" ]
      }
    },
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-09-10",
          "end" : "2026-09-11"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_2ARw2E3ef2glBrZNAVxFUj",
      "project_id" : "pjt_erJreyboyvC6POkpisa8G",
      "name" : "6mDPwKKMip",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_N9921TZrXE01SMMUpy3rj",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "QelXyba5vO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3OcBcvlP7Kxx0puxNTFDVI",
        "name" : "Hz7ZLDquVr",
        "email" : "4nsbMPq2@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1bDBcuA4omDQV6Iepmw37q",
        "name" : "73CF8S5TyZ",
        "email" : "8qBMBbHJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:45.836724Z",
      "updated_at" : "2026-09-10T07:27:45.836724Z"
    },
    "created_at" : "2026-09-10T07:27:46.239763Z",
    "updated_at" : "2026-09-10T07:27:46.239763Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2ARw2E3ef2glBrZNAVxFUj/task-specs?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2ARw2E3ef2glBrZNAVxFUj/task-specs?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_2ARw2E3ef2glBrZNAVxFUj/task-specs",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Delete a study task spec

Delete a study task spec.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec to delete.

Request

DELETE /api/public/v1/studies/sdy_1HSunGAZ6gVFn7Jp3daPax/task-specs/tsp_1NQaAoDlHHsIxeMtuKEcYI HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjODZiZmVkNC1jZjlmLTQyYjQtYWU0Zi00MGI2ZWYxMjYwNDIiLCJqdGkiOiIxOGNmMWY4ZS04ZTk3LTQyNWMtYmNmOC00YTQ5Y2MwY2RmMjAiLCJpYXQiOjE3ODkwMjUyNzMsIm5iZiI6MTc4OTAyNTI3MywiZXhwIjoxNzg5MTExNjczLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMzk5dFlIRDN3aG5XNkJmRFdtZVBaOSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.Y-k0C9T9T2PC7UoIqgBzSG3GtfC7Qa-gv9EOcUACg_1TUHXlQB95W8F4GkhQD8rFHk76SnSqpwWxbRl3Ymk_aV-ObxhpbcE8l9nbbY0NfztfIFvtJmRnqpBnIj6Qp1DIrcWIC8myqi__gtil_g5AjE-DzBmiCDCH5_idZoAHRPPO-QZlol0HZiNpqzH1U1j5kiXh7KtSM_C6L4gFT_fYU3Z_3kTHDpyUfYJvja-hoLvRe6DZxD022LxqTX19QdNFK7lu-_8v4gSuaaeAL3Jx2CgsZUjGe-w_JOpbKKCsyNtE-FQojPZWKD8I85ziIgciVCsR8tE3RTkNJgIPXtpSZUqAEyz6WKh3kZE3_7kEIys1ROEz6CDp5NfwShwnKa07oitLiys62LAw_qZ3sCGD91-U0FxGbw--UvI8qVY1BVlxp_6PqHK3JI_UmJwTqVSTmexwu7SIICA8edt-mjM2K-4j8xo5iikEqcDQxnXLMSH3fWVFZRkunJSx0_mImQMwZi5l1jUiV4lnk-t2FOpA_mqzEhuo843--ZPtTihktPNr0nVARk5RU4g9Cwj6ruyKS8cVaDINC-BOmTkuAHLgURYDa6yOc4stRfnTVv6Byn9sQ-K5h4F-aS_aHb-KDxD3lfn8KjAG5DioBYna8pcffw51F8Ehw3ZfN0hI-kaHjzM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 7
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Add study task spec assignees

Adds assignees to your task spec and related incompleted tasks.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}/assignees/add

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Request

POST /api/public/v1/studies/sdy_6jFC4QiLb0Iat7xobHFWW9/task-specs/tsp_2rL4IwZJLKAaO1lvHrRji7/assignees/add HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNWJkNGJkYy1lZGE0LTQ2MGYtOTJjMC0yY2RkYTZiYTRlNTgiLCJqdGkiOiI0MzFkZjRjNC1hMmM3LTRjYjEtODMwYS04NDk1OGVkZGYzYWEiLCJpYXQiOjE3ODkwMjUzMjUsIm5iZiI6MTc4OTAyNTMyNSwiZXhwIjoxNzg5MTExNzI1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNlpxMjF0OG14SkNQVFh5dElJQnVzUiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.YuNRHm2IHPjRrTkbdNgPgWSka0SVmTa45NHJ-vZaSjdzKEevWuEzcI247kfxTV5QXFzyYqgFHYoQ9htvvi0yMXOwEsuNWctjMuHesQG2cQMFLP0wYSNm4ux8BxaPTS3RHqTcvFfZFgsOFRabJNferA93xsitam8F38xHgn9wdMbi2xuRaLozy1dCRsk6IwDjR_pSih3gSMZLzGjZwUEni7Q-vaCNnrlC5YEMpx-57O-Q84YCsVLQ025bCu-TvetF-xny6tFjhd1D6JLXOGxVj3jrQ9MQK6D6vOoS9nGGrasn2YytliQhpQrwDBbfH25Z72qhLxk1KHjAqolKqgOu-wBs1J4IqU7uHZkDLvI6427AIphWSLswYelpJTgFrjDgiFtvGJrzCED34YK1MhuklcaZSL7EgP-GT0TMeJJKE_zm8ncTfAkIaztIbvtxZT2l3_FFpWiRa63J1zBB2QuTBt46mfs5rBQUhBSMtxM8NVgAFVnL6uLsOZWoocMSDH5EAi1wQdpos0BjqYQmSywPZYCeOWumEyLUfCYWOHORC4Xdshjd9ekZCvuBIwZ5sf9Wqt_wknhqwje1Ys2fP2lfBL2bALwjBDsz8IV2KaFMz9kZXKyvoKpTu9kAXYJNRpJvWGYwAybVleIWO58GbF_x8tWAx8Yn4S5n2HrlbT_oiUE
Content-Length: 95
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_H2CPjXWCGEZfdwE724MAZ", "usr_1qvtNOndRaLLfvyxZZYjmI" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 15
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

List study task spec assignees

Returns a list of your task spec assignees.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}/assignees

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Query parameters

Parameter Description

perPage

The number of assignees to return per page.

page

The page of assignees to return.

Request

GET /api/public/v1/studies/sdy_287xoc9Aiymu5l5F4qFwMd/task-specs/tsp_rXTfRt1XxsbBpM1VFG6oQ/assignees HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MTllMDVkNS03MTA5LTQwMzgtOGJhNS02ZjUzNjkxNWIxOGEiLCJqdGkiOiJkOTFmMzExZi0wN2U4LTRhZWMtOGViYy0wNzIyNTExOWVlMDAiLCJpYXQiOjE3ODkwMjUyOTEsIm5iZiI6MTc4OTAyNTI5MSwiZXhwIjoxNzg5MTExNjkxLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJiQUhkekIwWFZ5cUtaQ2VaMXhIUFoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.myW7XF_7ZAb6mKbwZg1_0OX_kHWCZteuDecwIigbmozoyGej_5vEQQeK9Z53Pm71tBUIOzh5P7E1ALuhVAmBzmxhvqVakrEiEHBJXKdxrs5evFLSKmbxNdSor7p5q51v6WxjRKzNTB38eDZKHjK4RCZHUFnyy8xeDegtgf2wLMgSfPAEvqmoNDj0DlJ8YOOEQ0RzQ8Isp_wVWLunKnURA8Ksn0-PBe8SLqwU2NPXq6tBikuTkQJDglICU-FVNt-YLBbTeilYB-iUjfUgym9q0qM9Tivy237xwHLrDZrP-4_OZNk6F8EG4MfAdyFeXNzyFOnq3_249DiEDbPVe9BIQkYv2HRJv41bbJQEtwcmv7Chx7u3zgIAeFjqo6YVCqPs4g52Bop3MxDpfjzmFo1a_6YO-CgHgP03ZCuwBaINpV1Gg67gP2NiG1alZdbiwnHK7MJ33MWzBxUlloMbgcHa1bw03yQFgL_nSu15vuok_UPSFNf2RQedkji_NmyaEg2gCmkidLe8K_AlzzXQIM01PAG25a3cNMtMLi9pMdssr5RqJKCIPf_xDF34RPPlbzgKAZLGQqaTCwfO-flYZbBsFZYces9o-oIhKuccv4gY7jb0yBwIX6in3q5Iafn1cSJ7QSc3kYjD7B6kAIGEwchclWXiX41b4yc14slDkjIiViM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 19
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1303

{
  "data" : [ {
    "type" : "user",
    "user" : {
      "id" : "usr_N9qNV1Jj7EgWN7vN4MnJt",
      "name" : "SMA5AXi6jK",
      "email" : "LQVjCIps@benchling.com",
      "assigned_at" : "2026-09-10T07:28:11.567861Z"
    },
    "task_spec" : {
      "id" : "tsp_rXTfRt1XxsbBpM1VFG6oQ",
      "type" : "other",
      "title" : "0X4gugQUQe Task"
    }
  }, {
    "type" : "user",
    "user" : {
      "id" : "usr_3MS6U4L65Z3aaI31SniAnf",
      "name" : "eAlp5SovT7",
      "email" : "KqwusmG5@benchling.com",
      "assigned_at" : "2026-09-10T07:28:11.572809Z"
    },
    "task_spec" : {
      "id" : "tsp_rXTfRt1XxsbBpM1VFG6oQ",
      "type" : "other",
      "title" : "0X4gugQUQe Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_287xoc9Aiymu5l5F4qFwMd/task-specs/tsp_rXTfRt1XxsbBpM1VFG6oQ/assignees?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_287xoc9Aiymu5l5F4qFwMd/task-specs/tsp_rXTfRt1XxsbBpM1VFG6oQ/assignees?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_287xoc9Aiymu5l5F4qFwMd/task-specs/tsp_rXTfRt1XxsbBpM1VFG6oQ/assignees",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Remove study task spec assignees

Removes assignees from your task spec and related incompleted tasks.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}/assignees/remove

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Request

POST /api/public/v1/studies/sdy_1yC081VzP7Kijp6Jh4khgL/task-specs/tsp_38DOrB1RY8Uax3mEwjfehj/assignees/remove HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmMTE0NTQwNC03YWMzLTRjZjgtYTYwYi1lOWE5NTI4NzNmYjIiLCJqdGkiOiIyNGRlMWE5Ni1kYWE4LTRkNzUtOTQ3ZS1iNzUwY2MxZDk2ZTAiLCJpYXQiOjE3ODkwMjUyOTYsIm5iZiI6MTc4OTAyNTI5NiwiZXhwIjoxNzg5MTExNjk2LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMUdJRVdSZHNTS0JKVmJlNGFLaXozQyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.ER2B_wh6-79m-NkMSgT2Onmc_zxQpSQ5mK6SHBuR0_sC1-sbMCCSbXmntZKoI2WR2BF00bULsodSj_HJS3zqoK7l4LdvYBh-YXhFvTchtJbDuaUARRzB8RyEvGkRT4hgk4JXVduRPE0RQzpUCFKZ9ybqc3-KvHY7MARG5vXWb4GVOfJnyP0sjX4zVH4A1IW1giMWzRAhdtMbAAc4mvK7F82_klN9jYLGhdDboWlgzHNDYh3l3Jzq8nrSKmUYJwuDjCe_ZfDFwAOtSSk1sOmcTBOi4HT2JjtH4Wy3KE4V7jc9qOYim7g5d8RzGdrVAqeC4lYpzWfgDyzp4nKa92oBnKyr_KYijg3tn4WeUsgVEXNZBWlmHhj970UyMCCyZR3ynpdrPX1nHnLOvQENfIPeLWVLUGFRbiC5aPA1b11binA1HtiEAh_j6epNtWVvetS1aqP7yPCrd9Y6SUdLCwh9V_DLAA6AQm1dlrHKLxKyPIwaD87FbUu6aUo__kkZLnGa2Fz4SYOs12VbEmGDCikP_7Lx_DM1mGPeLsFjE-xRlmIRAIskdsEwdX3fqGG9Z5gGQCa4D1zYcIB0owW_7hlujnmFYD7UTTcG2jg7gcKzZuXTnb1MQn02EWiyc41x8ynoub_vKUNtRjwKnqTFswP4K_ATEEYxk1Z8TDN2dej93Yc
Content-Length: 95
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_6IIZiOaqRzFLEfgDOiDyt1", "usr_noAfr0ptlbDojlSTEF9vk" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

Add study task spec target groups

Adds study groups as study task spec targets.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}/targets/set

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Request

POST /api/public/v1/studies/sdy_1m7zJTKZ2t1WyjxKTzQwwH/task-specs/tsp_2QLSUOHQ13XQTMGWKe4SkZ/targets/set HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5NTZkNWI4Ni0yYmM5LTRlNzEtOTU1Mi00Mjg2NDMwMTJlYTQiLCJqdGkiOiI0Njc1YWUwMi0yMDhiLTQzYzctODNlNy0zMWRmYjY4MDBmMjMiLCJpYXQiOjE3ODkwMjUyNjIsIm5iZiI6MTc4OTAyNTI2MiwiZXhwIjoxNzg5MTExNjYyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNzFjYVFibmM5RTdmaEZzV0VrNFdIOSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.FQ1nt9ZNL3_snCi3Qsbh3etPIQ4ce-hwTW_nwku3jfuiyn259iHg8IJQ0i68Jxf73nU3GSbMVb-NhPlrcA6a4cnbdWmADPpFiOsbGf4bcwd0bUrQMdA-cPEPVkdq0ozrqhcDnxFpRdhZ9YC7hxoVbWuDWBltnkIujbaM-t-jHlJMmWVSJi01-9byuOe9R2yJ2wuOwAwp0I5X2SmwQZmix0rAk2xuJXBuD1owrnrJqFQTkoNcVqoDK2UPZ6AiLWnj-9y0blw8XaLIVnxJywAckNdgO07vWEkAiAUBMKTjX2GRfq1JNqjtolHQqto8QDRoFqMA0U-Z4UWaBUAX4UPhYaeWOsIPsbEqPZsU2odtpoIvDrdOdKjC1gUPbEL_qm5F6B1Vrp0wSn3vDefBcYChE4_Odjwv5l8iPNq5OceVNznwTc_uO2dpnnzccvXMPpP0_rCPkItGt2uznhrokrDs2mK9pdu-RQW2RaoV8UCGo0deBza7UYhM8lNQw_QftiVEcgK4a_zxYWv5dmMdn1IgcmZ30ub9iNM4cPHAVahOBbtYAT_hHhjkCt5nnhswrWodHt0WIsXrsPSyGdvVT7kb713KXxD-h6O8tVGDeB0x9HtdDAbyGs3piZFJk7OIdW7gZU3m_iI1AMqMqPmlD6VoObYm0aBdOC2xmb0Q82E75_w
Content-Length: 98
Host: localhost:8080

{
  "type" : "group",
  "group" : [ "grp_5dMbrBWlZzsqHbcMn3zJnV", "grp_3iq1LLvVroLFYUEbJP6xKH" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

List study task spec targets

Returns a list of your task spec targets. Only group targets are returned (animal targets return empty array).

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/task-specs/{taskSpecId}/targets

Parameter Description

studyId

The unique identifier of the study.

taskSpecId

The unique identifier of the task spec.

Query parameters

Parameter Description

perPage

The number of targets to return per page.

page

The page of targets to return.

Request

GET /api/public/v1/studies/sdy_3NDHgw2DgWn8gvMuSzJXEm/task-specs/tsp_28OpBUC8MP2j3fkJ8jq0Ht/targets HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZjk3NGVjMi1jYTNjLTQwM2YtYTZhYi1hOTc3NTQzNzMwMWQiLCJqdGkiOiI5YmRhMjg1NC0yN2YxLTQzMDktYjYzZC03NTY5M2E3ZjBlNDYiLCJpYXQiOjE3ODkwMjUyNTcsIm5iZiI6MTc4OTAyNTI1NywiZXhwIjoxNzg5MTExNjU3LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVUd2ZKd25ZZ0NiTDFrdlF4YzRMMGgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.VgOteVFLxNR-LTo8qarmc4BGnHxvIMlyMqV4c96bfkAnztJ_YMXadCboZoi5fFuFIRH9ddb5hB8FoC5ij9i4bDk5-zFkuPjE4OphqwILLGkMD-glYx_o-3haHfsV1mj_YfS9VNT0Fk7wNrW_wp3hncmmYTV91QZx26E-WeafrkZss6aS4hw2xY9kx2sV2il2q_QTnb3xkX_wLQQPg7rzgay2FKP5TmgY3AGh7XlKKSwnjBqJYFsBMwV3_uJHE325b2iUmVIyPdL8V91chnz2Lh0rO-FSKT5JAcC_h5QonF-6FmgCm_BHYw_D_hd0Ex2-P43ympmW_SOVnn94kbEfMooFh1kI5KrU4wxOFnBeLDDmLNwMxC_CwX3jzPfO2Ik2spI3_wQbeTzP65V8PeVxWfB7JZfjBZLqX1l-ZMBe9DfKi_9tvMm7K6Mwn_NwOiAEBeerm8jFQYGqX7sx_6IKu1kvJ3VBgyvWazEORxBxOaHhr8iLQIauOCr7FGUHwOdNdYKhI7gLa_jyiolJWs-1oXKqzGCjV0g03qXdMaH891VSHLzE7DtvO-_N6Xjxad4eZS0pMW6EPmvuibeOY96ZnRNpDyQBHcE-p4h1gfBN15Wm3QOw__V-E5nwaBvCOasbxyDSfbMOLnmx8PWwP0rCQtaTJmFP4i42uMqth22w5OI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 23
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1216

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_cKo2vInZgX91GM5cs5Qq0",
      "name" : "u4A9iY5fNm",
      "added_at" : "2026-09-10T07:27:37.600541Z"
    },
    "task_spec" : {
      "id" : "tsp_28OpBUC8MP2j3fkJ8jq0Ht",
      "type" : "other",
      "title" : "CfSWoylug1 Task"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_57MbHoHh6sddUABXzc7iuN",
      "name" : "x9QrZ85eNc",
      "added_at" : "2026-09-10T07:27:37.600541Z"
    },
    "task_spec" : {
      "id" : "tsp_28OpBUC8MP2j3fkJ8jq0Ht",
      "type" : "other",
      "title" : "CfSWoylug1 Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_3NDHgw2DgWn8gvMuSzJXEm/task-specs/tsp_28OpBUC8MP2j3fkJ8jq0Ht/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_3NDHgw2DgWn8gvMuSzJXEm/task-specs/tsp_28OpBUC8MP2j3fkJ8jq0Ht/targets?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_3NDHgw2DgWn8gvMuSzJXEm/task-specs/tsp_28OpBUC8MP2j3fkJ8jq0Ht/targets",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Study User

This is an object representing a user who has been invited to study. You can retrieve it to see the user’s name, email, access to the study and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the study user.

name

String

The name of the study user.

email

String

The email of the study user.

timezone

String

The timezone of the study user.

type

String

The type of user on the study.

access

String

The permission of the user on the study.

study

Object

The study associated to the study user.

Create a study user

Create a user on the study.

Authorization: Your API token must include at least one of the following scopes: study.create, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/users/{userId}

Parameter Description

studyId

The unique identifier of the study.

userId

The unique identifier of the user.

Fields

Path Type Description

access

String

The permission of the user on the study.

Request

POST /api/public/v1/studies/sdy_1JG221q8ADQo0jFi00ThaF/users/usr_6YEinfbbsN1eVyIKueuMDU HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZTBlYzczZC0wOGNiLTQxMmItOTAwYS1jNGVjYmQ0NDI4MmMiLCJqdGkiOiI3NWYzNWE3NC0zOTVjLTQ4MjEtODhlNy03N2IyYzJiOGE3YTkiLCJpYXQiOjE3ODkwMjUyNjYsIm5iZiI6MTc4OTAyNTI2NiwiZXhwIjoxNzg5MTExNjY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF1MHhQTVBacFJNZTAwYWNpUG8yZ3oiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.W_t8FYwLKqkaet5Dvx_DHKDwh4oXb0LD1tZQeRfpQ8_rXapsUBTlvbPx6O5W1Zi1tz09xrjp9PYXZwJlVvsruMGdhQf99CM9ZbxMiauf9mE_FLGB2rO7fN98rWNYg5KST55sk_qH7zuxFGZVNF3Vqiu4ScBjvSJ5bQShM5kwIN_Ku1A25mfz_2cQZRb89qRiNAJS_xhnMA46Cpf1_aNgfks1HcD97ywxKc5oanHsSGM8jNJuQQzbHslfsl71ntJrVDmw-47mI_C3qyKXTFU52FDdyisBTzxW12Wkj6-5fLrbVmpQUHmhhU9rlIHshIdUiPTSc5JZlFNCb4eW_9khgSdJRacb-E1AILgfR030vg6gnoakopRCtd9rLsGENWbO4b-YW859C19VvNcvnJ9lBjcW4xwyCF1yj3YlIryaqZm51ebcOem7AGofPWfpU8nfs7YmPLGV7aiYUm2If_JMlSqOT1DpMhz7VgH_6LfcjgXnHWQrXPCMPSCmXT-NSZj0Gm9Tj6OKDpM6v45kF-WsKDDzivrVBwr-1fZ7tG8PyN5XwJ26w6mNhG7HaHZpbXzrNgNfU_mZz6etwmn-ty6pF7dsa0kSkAOENgqyHrw2RrqxzAyxpcMGYV_F7G9sA91MFGnmXQlgXDRRiOVzSWJoMzM9ZwKUs34eSrYxWu4c-OA
Content-Length: 23
Host: localhost:8080

{
  "access" : "read"
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1114

{
  "id" : "usr_6YEinfbbsN1eVyIKueuMDU",
  "name" : "eAexTLpwcE",
  "email" : "hxarkiNk@benchling.com",
  "timezone" : "UTC",
  "type" : "team",
  "access" : "read",
  "study" : {
    "id" : "sdy_1JG221q8ADQo0jFi00ThaF",
    "project_id" : "pjt_jM0P6Hv48FQpw37iL3V72",
    "name" : "Lh6w3jpTUc",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4EO98XZyYarOI99iMhDNZP",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "vTyNKi58dH",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4QsfGKmXipzEZTZzDC3TdS",
      "name" : "FlnY7MJYnO",
      "email" : "DtE04ttT@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6kVfdIPHrx29HZfNkTXttY",
      "name" : "hlmL2GByZo",
      "email" : "qxKZQ5Mo@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:45.999059Z",
    "updated_at" : "2026-09-10T07:27:45.999059Z"
  }
}

Retrieve a study user

Retrieves the details of an existing study user. You need only supply the unique user identifier that was returned upon study user creation.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/users/{userId}

Parameter Description

studyId

The unique identifier of the study.

userId

The unique identifier of the study user.

Request

GET /api/public/v1/studies/sdy_4BvCinManqx1TXKBvYF97u/users/usr_7GC08eMZQ3jbt3T0RfuYNg HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjOTJhOTQyYi1iYjI0LTQ1NDktOGM5ZC04ZjRiZDQ4YzE2MTUiLCJqdGkiOiJiNmY0MDI5Ny1jNjE0LTQyMzAtOTA3NC00MjIyY2E2ZWY3ZDQiLCJpYXQiOjE3ODkwMjUyNjMsIm5iZiI6MTc4OTAyNTI2MywiZXhwIjoxNzg5MTExNjYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNWMWk1Q0NGek9nYlhOZ2RkQ1ZxUkwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.K1A5WHUURdgkDqdJKXhyxauYozshiglorJIje3CzsPpaRqH599vRC8uTVZvIntIZIuwG__XdCtJRlOfBI8lAd1BMzwwq-6oppo_Pj0R9H7wkBC8SjRxdL9Rx5x6hhGfAtQpMuSCA6nqcenm9N2MKXCrS8vAKRT-2XRjajZK2xJiP2uf63kXCoJcavX4mBTSTVmUmVvxbu2GnDcds9LjzobU3ctw7KkrO9dhmJhQKkJVFTXHaecPV1hnqMGGqBf3M5T-VxBAPCrB2jh1GHbq9M-rLPRM73UDoy4cs-p5iN_ovXGpQsBj0hGxDv1WW--e9XNg7QduOcTcgieSxIpzcWQjr-56Gv5u9DbX-r1_3qJrnntl6Wj6rgpQN62bSC6tXRLBVH_5wObG9y5RN4gyPvXIy4C5bhPbWbPWKxUX00hk-oILrZJCxCqfsVJjtDilmGCikIs3yQ3xFjxMNx1QwfFoTpjFfMlJ31jJSS1hZDABEt09UJJLDMCL0y7WalDj03ynoI398X5g-zNDPHglYeIW06UWJh8b_mqpcSEzUVCaH21FjFlX2Ec3w4LwoAQRgIIIkAojUI-ajGXcDRy7IabH5RbXlKl6aa25wKNuOSsX64yjVTC_OQPQRJ4kHLKBzefe-_np72ZTV1vSS8EtmLUFCkoCPn_2nKrnA0VRAj-E
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 17
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1118

{
  "id" : "usr_7GC08eMZQ3jbt3T0RfuYNg",
  "name" : "SZxFoCX3nZ",
  "email" : "knorAxJU@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "write",
  "study" : {
    "id" : "sdy_4BvCinManqx1TXKBvYF97u",
    "project_id" : "pjt_71pAkKQjxmIrUeNHMZWrBS",
    "name" : "X7sjRCqbIm",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4TpsYjotOZ45QQTQSPOPIh",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "U4Us38iYuo",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_7GC08eMZQ3jbt3T0RfuYNg",
      "name" : "SZxFoCX3nZ",
      "email" : "knorAxJU@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_45rgYtFiZj4gHDMx3pCJ38",
      "name" : "tfLowUsyQp",
      "email" : "zNIfVhfi@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:43.031539Z",
    "updated_at" : "2026-09-10T07:27:43.031539Z"
  }
}

Update a study user

Update a user on the study.

Authorization: Your API token must include at least one of the following scopes: study.update, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/users/{userId}

Parameter Description

studyId

The unique identifier of the study.

userId

The unique identifier of the user.

Fields

Path Type Description

access

String

The permission of the user on the study.

Request

PATCH /api/public/v1/studies/sdy_3qt3A7ytU89uHqSEs316mV/users/usr_6RV5sMFFEL0UdsMkt1fmG3 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZDQwMmM2OC0xMTU3LTRkOWItODQyMS0xN2U5OTg3NWJiZmMiLCJqdGkiOiJiMjYwMGYyNC1hMTA3LTQzYWYtYWJlMi05ODA5N2JlNDYxMmEiLCJpYXQiOjE3ODkwMjUyNjgsIm5iZiI6MTc4OTAyNTI2OCwiZXhwIjoxNzg5MTExNjY4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQ5MmhkbXNobE4wVlJmRjVYR3FIdEQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.APMA8qGLYYLOth3emY3kw1rPlhp23a9S7GV_q6DVfvzBTuTDqGqCyL770MIx3jtdoI-ejzm6v4Ba4s9pMHOxtWuIO_p0vyh8v1IQ5Xmvep0pdmU6Pt-lRw84E-eYgPyyw7AcjdmL1QWWOgtCM4_h5cXy2djKnxuNfGMFXWDMjsQNnnXoB0qD5BbppTda3Gt9xoxJknhqzAp-mSc8nngj5MPCbORdkuqOde3wi5PmQ7gqG1PWwBED0firsfnP8uryeKu4wOq2JdKfttK5JXDmJZIpP_VvTnYbTDRBslSN2DBdRFgS-5qiTRMXk99nol2EZbYTZ3Sba1GyEAbMF4deMksrapslhUrVpaF54borxRJDxcd45gpirB77Btf2gQYO7x01g7NsNnkGKpRerNIS53TQlzaK7W2btRY_1Eu0-V6YDzjoRPk2wuyIOGzFysHR7toKnwhKLZDlYEwcT8fsqwnlY3_FvqEOoVS2MevYZrcUg3G8H2Zm7F0DV5I3Iett2q7v-HZ1f9Ahw3yMsFuOcTHysbFxOIUcfwpeu0ALONJUkT9D6EOh__8HAaoa_3LjYlFUQ8cgwoGzE83P00j9gHozEz8GXSmOzg_wW2lZrNKI4rhK1lhZ0UvtlNod89vUEEcENFoFnaF2_eZmrO-hqVU-UZ6c3zSEnSnRfIW5NYE
Content-Length: 23
Host: localhost:8080

{
  "access" : "read"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 12
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1116

{
  "id" : "usr_6RV5sMFFEL0UdsMkt1fmG3",
  "name" : "WYTNrJVEnV",
  "email" : "oE8fCG3M@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "read",
  "study" : {
    "id" : "sdy_3qt3A7ytU89uHqSEs316mV",
    "project_id" : "pjt_6Z8efLnIoMkkghow2elnsL",
    "name" : "ynp9O0StYa",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3k3NwPQ2GUmX3yFaKe14Ye",
    "type" : "internal",
    "started_on" : "2026-09-10",
    "status" : "in_progress",
    "description" : "voc9HBOHOG",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_74ED5tWosnnmHIFtGw5MW",
      "name" : "UHvjZUkMne",
      "email" : "mvxhSSTQ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2bjrAKy5feQKwQEOhRwpSZ",
      "name" : "iEk7aOgrxg",
      "email" : "IsGSbMdy@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:27:47.666889Z",
    "updated_at" : "2026-09-10T07:27:47.666889Z"
  }
}

List all study users

Returns a list of your study users.

Authorization: Your API token must include at least one of the following scopes: study.read, study.*, *

Path parameters ./api/public/v1/studies/{studyId}/users

Parameter Description

studyId

The unique identifier of the study.

Query parameters

Parameter Description

perPage

The number of study users to return per page.

page

The page of study users to return.

Request

GET /api/public/v1/studies/sdy_6ErdH25dM0W5GJ8kZ4pIH6/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYjY5ZGMyNy1iOTFkLTRhZDQtYjkzMy1lODRjNTYwNWNhMGIiLCJqdGkiOiJhNmRhMTQ5Yi01Yzk4LTQ3MzUtYmUyNC0wNjFjZGJhYWQyZDciLCJpYXQiOjE3ODkwMjUyNjIsIm5iZiI6MTc4OTAyNTI2MiwiZXhwIjoxNzg5MTExNjYyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVzN3ZvRGE3MENCcXhYWkUwQnB6blkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.RdP1HN-TwWQb_VRjycvumh71Czj_hbCd6bKGeddxiWt5JFeKe0yh5Jjd16doxEv2NxwY7NunjOJbFaHNyhLQHJBl04Qnff1XO5ScX2oqP7sKm15lwdRDbewIcoRCNE78h5J1IG0PMONjIvkc8c9nNGJ4A1DVMSraZ1dB5_76nbe0_mycAsYGkd4V_3FDvk9vEJmVAIZjgLdAA188fq_NJm9_BmGWknijpk2xG-V4zKsY3s6__AofzX8A-e2oELcRZaxMZi0xhZQgzQYg5FetbNGGQBspz4-kOcpEmmg9N_DOTakHM47V6L6cGnrYLFBWpsUHtXIR1Hnl3pSVsYHXFvy3k2vSlm4iMudAV0gr4OH3MSwaWZNpHFdIaGhdb2N0c43Mn4Kbw9a8oEcn-W9x6vuZ7A0TZgBVdUxAS8ZjoitgC985CIfvjy1cCzB9kGslqgZ57ybGjbmxFlcssBc5ZQrQ4Bw-fyyuNxKfdzH52tUoZosZ_tkOR1uetpijYETJV1y94fMAN1wG-mFyX-8m7fYLS1o2ovMjiGLF8zxGQfFvXtkUu6c8zAds3zPvyIKgNiywq22bfVC0_ZSR0AvSC-QXdNIu5GunAppIoQ_N1mjV60VIsiGabX1ya5LmDQ-Y2DXd7M2xqZ7___r466IEO1cCOAwucEUmzuh7JY5oMpU
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 18
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5278

{
  "data" : [ {
    "id" : "usr_2KbbhL8vt3ASmpbO9YTHTX",
    "name" : "Pa877rlOSv",
    "email" : "mE1iM8Ru@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_6ErdH25dM0W5GJ8kZ4pIH6",
      "project_id" : "pjt_3M5d1FNrAghLg0LBQ7YWbG",
      "name" : "qDeGGnetnT",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6W022wfXL7TbwZ9o7FG0kb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "XocnUYJLlV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2KbbhL8vt3ASmpbO9YTHTX",
        "name" : "Pa877rlOSv",
        "email" : "mE1iM8Ru@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1NSbEo7nMplQMGum6M1sW",
        "name" : "fkOERSuhIa",
        "email" : "o0VUj0kd@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:42.145820Z",
      "updated_at" : "2026-09-10T07:27:42.145820Z"
    }
  }, {
    "id" : "usr_1NSbEo7nMplQMGum6M1sW",
    "name" : "fkOERSuhIa",
    "email" : "o0VUj0kd@benchling.com",
    "timezone" : "UTC",
    "type" : "owner",
    "access" : "write",
    "study" : {
      "id" : "sdy_6ErdH25dM0W5GJ8kZ4pIH6",
      "project_id" : "pjt_3M5d1FNrAghLg0LBQ7YWbG",
      "name" : "qDeGGnetnT",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6W022wfXL7TbwZ9o7FG0kb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "XocnUYJLlV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2KbbhL8vt3ASmpbO9YTHTX",
        "name" : "Pa877rlOSv",
        "email" : "mE1iM8Ru@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1NSbEo7nMplQMGum6M1sW",
        "name" : "fkOERSuhIa",
        "email" : "o0VUj0kd@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:42.145820Z",
      "updated_at" : "2026-09-10T07:27:42.145820Z"
    }
  }, {
    "id" : "usr_6ap9rHSQq68MUtRWuuOdGt",
    "name" : "7lP8CDDkv5",
    "email" : "P9blDH6l@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read",
    "study" : {
      "id" : "sdy_6ErdH25dM0W5GJ8kZ4pIH6",
      "project_id" : "pjt_3M5d1FNrAghLg0LBQ7YWbG",
      "name" : "qDeGGnetnT",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6W022wfXL7TbwZ9o7FG0kb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "XocnUYJLlV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2KbbhL8vt3ASmpbO9YTHTX",
        "name" : "Pa877rlOSv",
        "email" : "mE1iM8Ru@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1NSbEo7nMplQMGum6M1sW",
        "name" : "fkOERSuhIa",
        "email" : "o0VUj0kd@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:42.145820Z",
      "updated_at" : "2026-09-10T07:27:42.145820Z"
    }
  }, {
    "id" : "usr_2iQBp7nvTHdZrnLjjbSe8J",
    "name" : "nw6n92HkS0",
    "email" : "QTf3MAdj@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "write",
    "study" : {
      "id" : "sdy_6ErdH25dM0W5GJ8kZ4pIH6",
      "project_id" : "pjt_3M5d1FNrAghLg0LBQ7YWbG",
      "name" : "qDeGGnetnT",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6W022wfXL7TbwZ9o7FG0kb",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "XocnUYJLlV",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2KbbhL8vt3ASmpbO9YTHTX",
        "name" : "Pa877rlOSv",
        "email" : "mE1iM8Ru@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1NSbEo7nMplQMGum6M1sW",
        "name" : "fkOERSuhIa",
        "email" : "o0VUj0kd@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:27:42.145820Z",
      "updated_at" : "2026-09-10T07:27:42.145820Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6ErdH25dM0W5GJ8kZ4pIH6/users?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6ErdH25dM0W5GJ8kZ4pIH6/users?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/studies/sdy_6ErdH25dM0W5GJ8kZ4pIH6/users",
    "per_page" : 10,
    "to" : 4,
    "total" : 4
  }
}

Delete a study user

Removes a user from the study.

Authorization: Your API token must include at least one of the following scopes: study.*, *

Path parameters ./api/public/v1/studies/{studyId}/users/{userId}

Parameter Description

studyId

The unique identifier of the study.

userId

The unique identifier of the study user.

Request

DELETE /api/public/v1/studies/sdy_6hUAfWxLCT9jf1OV6ohxdR/users/usr_6T6jLre5J0wUdzKL0VfGNx HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4OGE2Y2VhZS1hZDIwLTRiNGYtOWU0MC1hZTY4MTBkOWJiNGEiLCJqdGkiOiIyZGQxODkyZC01MTcwLTRiZjItYmU0MC1hODg1YjNkZjVhN2IiLCJpYXQiOjE3ODkwMjUyNjcsIm5iZiI6MTc4OTAyNTI2NywiZXhwIjoxNzg5MTExNjY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJYdEI1bld1bTI2NTZxaUxYQzZMbkUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.H9_tjaiF4uAaFHSSzWkKUqI0wU0UrHqbchz84DFXKKch2Ip0pRwVvGDBs_kXi5OLnaeSNJwuBe57rjYYIcEnkKgRophrD32xXaUtmrQUHVBW8vJqZRgHVMbzn9eR395VKfIcqCBKIhenYcKUON2d46HT2vOHcbZdkg6HvHl3k9-r7e1i8ZjxmyQfUuZUS4_z5x0o32T2b8rDddYWnNGlmbnahH6fb0aVaRa8MLR0Xqvnx1P0WSzZUsHzvIuZAaPOntsaAlpvukkzO-CK8Rr9BGMndIZ_2TOfNG50o1aOWq7mXrnLJ6B_M03idqu6I7GKEjOxADdACo3cj9088RlZUgUcZUG159317S5qdKagF0boh-osJiRkD3ZKiBUnDTbv_TQ5Zf3cttNj9wcymAqHoCxjAr--Zeup4XZgRL7jXuZacnNMV-MIcZLPQui9bF3xQVMc8evT6LRcStyLS_W95x9R4CNoFlTVbpSctxALoLMrd27pkn3RKYoYc3Ug7c-rTUcWddE2BLTZhIZ26niCf4QqNWpTfGB0ycdavNcRj103G_f12TBhk-QfitacS-sypfC5vbKx0wZc1Hfx5rXwofEM501VaEWzOinP-MDKr6ng4LzR5AYcrBo3o-yPjwQeeQKC-BgkHGnO1BmFejsp_B5Avvz82XhtQcX4ybYiVao
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 13
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

Team Glossary Resources

When managing sample types or observation types, use the dedicated glossary resources instead of Team Glossary:

Team Glossary

The team glossary includes the configuration for each glossary item including—sample type, observation and euthanize reason. This includes the details that are collected from a sample or the scoring method of an observation.

Attributes

Path Type Description

id

String

The unique identifier of the team glossary.

title

String

The title the team glossary.

label

String

The label of the team glossary.

group

String

The group associated to the team glossary.

description

String

The description of the team glossary.

type

String

The type of the team glossary.

status

String

The status of the team glossary. Possible values: active, archived.

options

Object

The options of the team glossary.

Retrieve a team glossary item

Retrieves the details of an existing team glossary.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Path parameters ./api/public/v1/team-glossary/{teamGlossaryId}

Parameter Description

teamGlossaryId

The unique identifier of the team glossary.

Request

GET /api/public/v1/team-glossary/tgy_4oE62DXFZvbELCiQsjEbgJ HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5YjExZTM2OC1lYTdmLTQ4OTctOWUwMi01MmUzM2MyOWFjN2IiLCJqdGkiOiI2NGFhNDU2My1hMzU2LTQ5YmEtOTBlZC1mZTdkZTQzYzcyZmIiLCJpYXQiOjE3ODkwMjUyMTEsIm5iZiI6MTc4OTAyNTIxMSwiZXhwIjoxNzg5MTExNjExLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFwTDVudmdXMkxNV2RpR0JnbTJCVXIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.cVoJqNZEVD7RphDghziRTIhHoQNiWTq3JzpHoSAPvH9ccaPU3fk-R_7UkSzXqxFhrJaqyupEdT0pjvg-14Fk0NLOlxsQL1RAg3c9uj-MwWrSYke0yTud1AzjO3GmwxK9u34jlTuoFrrDFs0KSD-t0QE___albPC-5rwsGRN-usuhQzh6s8gjFtAjmLSh8_2j770RQw4mWddas7mwHgipFPr_UF6mVwcWU8_s_feC-LjoS8GSpirVtYlUjZGUc8oBV745BzGyQJQd3UZeF9I_7d6FleY6J-KVFKfImd8rwuou1CDHZMmUFUsjJeyhoEEQX49FIePKCyKYLrEC5_hHEtz83eUfmId3BZkMJnIUY0iWl-s5NZSklZ0HveOHysgz8TYa-P0LVRF0NFlXrItov33n765Rcf-WTduLeDQuE6Jv3dvK3ePclGFnyqb078GFWs38r2VbmExqoQVa7hCCvY0juxGIs52DjeCjhynXIH37s0bBFzy-0sd8itYBNSQMSaOZ7-4yk_PIqS_rB77FkzEAsEDU3_A1GptJ06XVJ5tdcusUeAt29-mgCw_dQHBQl6E_BdZgMGLguWe28iEDErEfJW4w4MKASUeP2z75ALO-bFtc4M7RNq2ORgEOFnO04hxBQZUak4Ka82zNNUQUxrv4eiFkZ2d1xSG2INzKapM
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 9
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 253

{
  "id" : "tgy_4oE62DXFZvbELCiQsjEbgJ",
  "title" : "Numeric Glossary",
  "label" : "NUM",
  "group" : "observations",
  "description" : "0 = it is ok",
  "type" : "numeric",
  "status" : "active",
  "options" : {
    "min" : "0",
    "max" : "6"
  }
}

Update a team glossary item

Updates the specified team glossary by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: team_glossary.update, team_glossary.*, *

Path parameters ./api/public/v1/team-glossary/{teamGlossaryId}

Parameter Description

teamGlossaryId

The unique identifier of the team glossary.

Fields

Path Type Description

type

String

The type of the team glossary.

description

String

The description of the team glossary.

options

Object

The options of the team glossary.

Request

PATCH /api/public/v1/team-glossary/tgy_59NhkIT1wA0qcT423HxHpj HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlODhmNGMxZS05ZDQzLTQxOTMtOWY2Yy1mNTllMTVjOGYzYjkiLCJqdGkiOiI3OTViOTY4Yy0zNGIxLTRiOWQtYTZmYi0wMDIxN2MwMGM5N2IiLCJpYXQiOjE3ODkwMjUyMTMsIm5iZiI6MTc4OTAyNTIxMywiZXhwIjoxNzg5MTExNjEzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVWVWc2dUZXM3FaYmR6VmFENDRrOXUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Q2xG7UfEmc8bwkwp_BwUyKvS5N3AJZ5VZCMXdmLBvA-WTZtC5qq2pCU3l5T31hqc2wG6dHKiTSKWZN7zioFxWpeiQUgwc7j6k7RJY2b0cBOaft0Jcp_4nG1quZbOZYDX7gndki6SxDbW-GGZmPcFRq7ONzj8UnlO8DAgkjBepN-tX4FN2DKQpOhw_ZWjImu_AU6XBb0XiaTI4Updt40spFY0OtDnlwYOvRobzN8fQtoEG-VDibEIqAjvNNA-pk5Yk5LGDfiunLTL_npBHFryz2Q5q_StlXDeJjjeHeK79OG5dXGE22y7iUeAbQ5a83APPUymY_ROkipswL1LvfwfjcT3AsLbrLEuAvR4E4pmH5KYvQJmVG0IEtQ6AdAEMaOv8t5d_i-u0OcB5ezw01DF6DgmeesxhJKsluOORui91TvjBdShB8nPkQHzZkUn2fL8-wYYi-AVKxBffeFems3J0LmWbPDzNU3j1PZCI1Xh9vnHje69dYGhzCqMyHt5vtRnqdVvBKmt1bBilpTUHM9AumBPzvX9hL7078D-nyrfltQK7LOjWFkEUzq6rJp0Rf1nN1wRWkETsf1jC-v8YfoooBX8iE9rN805MNMlXdHX5nlQelBstCTklUUgvqikT1c_qF-CHj5GzKPV4Nsw47RVreIJTRwsrpc6DVjBTq98eRQ
Content-Length: 112
Host: localhost:8080

{
  "description" : "1 = it is ok",
  "type" : "numeric",
  "options" : {
    "min" : "1",
    "max" : "6"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 7
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 253

{
  "id" : "tgy_59NhkIT1wA0qcT423HxHpj",
  "title" : "Numeric Glossary",
  "label" : "NUM",
  "group" : "observations",
  "description" : "1 = it is ok",
  "type" : "numeric",
  "status" : "active",
  "options" : {
    "min" : "1",
    "max" : "6"
  }
}

List all team glossary items

Returns a list of your team glossary.

Authorization: Your API token must include at least one of the following scopes: team_glossary.read, team_glossary.*, *

Query parameters

Parameter Description

perPage

The number of team glossaries to return per page.

page

The page of team glossaries to return.

type

Filter team glossaries by type

status

Filter team glossaries by status. Allowed values: active, archived.

Request

GET /api/public/v1/team-glossary HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1OGY3MGU5My1hZTJiLTQ2NTEtYWVhYi04MzYzZTRjNzk0MDAiLCJqdGkiOiI0MTZkOTJiNi1kZDA3LTQ4MjgtOGVhMC05ZTRlNDRhMmYwNjkiLCJpYXQiOjE3ODkwMjUyMTMsIm5iZiI6MTc4OTAyNTIxMywiZXhwIjoxNzg5MTExNjEzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNqakNnalhUaFNXTjFtTU1tcWh6Tk0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.e6E8MX41jMy5QNohlve-4bMXumQmpEEJfyC6LDQVbJoqPso-VAmesU2_de1wIGHwvwpMLkcKeKAjfsdARwHnOJvIasahX7_rX0XZA8xiYAxO-LEqx2xmDGlCNDnR7txdNIyojmLQ_R51Y45dAeKAM8m1Tusa0cJDO9QAW0O-4xMmA4EeD5lhOKVfvs4EbnJRgS5JjStjAXl93ZeFrTZ1LwEx29DyPqgn0t0jv3Yrxkc42jDubNHOiVnljy_ugSqsfS2iVLpT6k1z4Rhv0IIXDlGwAzjsST5oXZ5TB5Bl9GwC_ylUTBAuS8g5G_9hIbHq_iuFZVv8wGuy6JUm8VOZ5sHp9bdleSUq9c8Fx0WNOLhhF9gzJB7jSyZuTv9JpXdjdDsZJTsytwUuMxVZZ0nlZr63OG-fzdsPz_bagc8GHtn-wg0Pdm3ob-6dFJaJACppoDW7zqye-h_iyKbicMG5CcsODlYw6Y-nL_zCBRuH-q7y8yF2YlXaoJWfE5kB589zOHscFbctW6nQeMbw0IkJdDDxV6BCyBZYh2lOvcY7JrZ3wG0zUnC10qw9oppRT-Aa0jvXVs-kxe_KibuakIkuJPQA1BxdM6y-VF9RXKa82Ye6OBhLMFIIKsNdZPiZhM2v3QDqwNS9WdKA7GXr7uN2W-wICso5Ky_15gpiYEpz9lE
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 6
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 693

{
  "data" : [ {
    "id" : "tgy_3l0KZlTP9lYFKKZ778Qaat",
    "title" : "Coat condition",
    "label" : "NUM",
    "group" : "observations",
    "description" : "0 = it is ok",
    "type" : "numeric",
    "status" : "active",
    "options" : {
      "min" : "0",
      "max" : "6"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/team-glossary?page=1",
    "last" : "http://localhost:8080/api/public/v1/team-glossary?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/team-glossary",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Delete a team glossary item

Delete a team glossary item.

Authorization: Your API token must include at least one of the following scopes: team_glossary.delete, team_glossary.*, *

Path parameters ./api/public/v1/team-glossary/{teamGlossaryId}

Parameter Description

teamGlossaryId

The unique identifier of the team glossary.

Request

DELETE /api/public/v1/team-glossary/tgy_TvOWW5ubdNFspq02Rld99 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3YjZkMDlhNS0wMTg5LTQ4ODYtODM0Ny1mZjMxMThhYjY1Y2QiLCJqdGkiOiI5ZWJhOWIxNC1kNmIyLTQ3MmQtODgwNS0wMzI5MzIwNjdmNmYiLCJpYXQiOjE3ODkwMjUyMTIsIm5iZiI6MTc4OTAyNTIxMiwiZXhwIjoxNzg5MTExNjEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZhTGtuak9MN3NOOFJpTFZKUGliSXQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.TmeFxxy-8S5UEwTeK6mbxCFNxBnosemR2kL4Y9iZxYvhNi25E_VF6TGHTqNpfLEqdqknMbye-0YOUjxwvwf-jpMmH_OAK_-Z8OR8T21gb0EPgdGbQ8soddEoMi2Chc24LWthiEeJiIGluA6W5-W0tyT6ao8cZKjDdblgcLJbkQZ_inmz5gVLArLvBWIHTH_0cb2iFLaQIor9TGIlDMdE6PIQ9t3IvvZKkTi51-VOQA5A9yFCp_tNTBQ98x4saI9hqRYbImntR7zh94DZCiRbHY09WQ_2hD3hlQKru-V3XAlZpBHUhyi1ntLnjJ9DUXgp7NAOXdyo1qMW7E5U5x07nkWHxWIytJsinLMKuF5FWQv9BZz6YsOO5pPgUjSCPqiuXgborokNeBX7cD66PJ1-Razw-DqN4DaB0D3gE594K53KcWzLCzA0wRxQ4BLaAnapsbt5mmmFLdyMSdybIHk6p8T1NNBL4iU7x_sNXAF_LYZu6V4TVvAhdEOf3DM9odCQjyX-CCRWNpbXn2Ho9drnxeFvIEvKxUjwQDpaK7W6IE-i4HRxPbvinKvzYMN29Cp31G9EhmVBRw3Zhhkg9ndJfWY1Xr_R-_ccZGw81LQzCeLFwdNITa1ktc1kWY5nBDkZw0vOWO3v1urGSGKi_-sf-B3OrVaqoUKvkQH4iPvSQyc
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 8
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "deleted" : true
}

User Resources

User

This is an object representing a user who has been invited to your team. You can retrieve it to see the user’s name, email, account status and any metadata assigned.

Attributes

Path Type Description

id

String

The unique identifier of the user.

name

String

The name of the user.

email

String

The email of the user.

timezone

String

The timezone of the user.

status

String

The team status of the user.

metadata

Object

The metadata associated to the user.

created_at

String

The created timestamp of the user.

updated_at

String

The last updated timestamp of the user.

Create a user

Authorization: Your API token must include at least one of the following scopes: user.create, user.*, *

Fields

Path Type Description

name

String

The name of the user.

email

String

The email of the user.

timezone

String

The timezone of the user.

metadata

Object

The metadata to be associated the user.

Request

POST /api/public/v1/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MTg3NmVjZi1hMzZmLTRiMDEtYmU3NC1hNDU3MGM3NTNiYjkiLCJqdGkiOiI2YTFjMmViMS1kY2I5LTQ5ZDUtOWQ4Ni05ZmM2NWJlYjk4YWIiLCJpYXQiOjE3ODkwMjUyNzEsIm5iZiI6MTc4OTAyNTI3MSwiZXhwIjoxNzg5MTExNjcxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNqWkxNUDR0MVpJdklvOUNIN1BBSTEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.SUNJ3s7Uj208JKvY0DV5roecgwqsL1qjN5jla8P3KHb-2HCpb6lC3eXKe-4nGlSvV0ya3GrrUwQxtzWwVp61bJL8MkiTHnIRjo6Jo5LSGqs3UvqloOoAiTNyCdsSZDj_yQqtgD-_0QreaUzyEZIb-dCYPBwC0HTXzCe9721WcOajSrmH10qZxtuQwFQHNoGM_gzKtMJWM9jk99vcVSsVUiNPr3C4PBBt5NlEUPhhvWmawBHm_qBwJdpr3uGaVFR6BUcu6XbnV9BQctJH6JJ92m5TH448dgVrsD8SnnS939PZn8HH83HqeT-YRXwZoQ4Locq3gKIDTpENKeNSweKFbCuyA_NSU715Z5shGACTAhqsr9rojU_nodptdBScpG65Ez4To9Vw_Rfrl_mU4Z_XN0Z_jNSPLUexh5t7_AjV_Z8ufi87J9ODyVdt62JXzcGKf6n750nuBOHv24FQfTQRR1b7M1_ZEpsjh0GxktOW2k2X-xj-mDbU05V5qyIYqO-PE2_rzPpWautgnlNrShq4Z-bEA35QqdAuzp4pxKOeRouEkLEV-HH8EAQLQ01TpK6SxTFWsVA54dxA3ooi3bAh_zjc7weuU-oCUy4_3W_YaTUKalaUiBMUeXhtBgemZVrxkPEvUt5xmkTLfNMJLsLBQPfQNm2n9BUqip2G7uF8rGQ
Content-Length: 146
Host: localhost:8080

{
  "name" : "sPECwTHxFv",
  "email" : "zGVQcymf@benchling.com",
  "timezone" : "UTC",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  }
}

Response

HTTP/1.1 201 Created
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 9
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 305

{
  "id" : "usr_1gWJXWyVZsOiOc5EmA9WPm",
  "name" : "sPECwTHxFv",
  "email" : "zGVQcymf@benchling.com",
  "timezone" : "UTC",
  "status" : "pending",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-09-10T07:27:51.587158Z",
  "updated_at" : "2026-09-10T07:27:51.587158Z"
}

Retrieve a user

Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation.

Authorization: Your API token must include at least one of the following scopes: user.read, user.*, *

Path parameters ./api/public/v1/users/{userId}

Parameter Description

userId

The unique identifier of the user.

Request

GET /api/public/v1/users/usr_2B6lPmGt21qk2VE8lysy3o HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZWNkYWI5Yy1kYmY5LTRkOGYtOGViOS00MDBmMzYzMDliNjciLCJqdGkiOiI2NzMyNzc0Mi00YWIxLTQyN2ItOGJjNy02ZTAxNDhmYTJmNzYiLCJpYXQiOjE3ODkwMjUyNzMsIm5iZiI6MTc4OTAyNTI3MywiZXhwIjoxNzg5MTExNjczLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI4ajdPMFd1bElrN05UeUJ5YjNyN2QiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WIE2pVq8NnrFhI3Glbgx3UywfQAXNnk4fpks47OJ-fxh7_P3BZiFi6Q4vx1mkA7XXh25YBJvF9NuJjFYI4h8on8lA4TwCr-IPRKX7R6cIwbGThja2sC6Heat_agSuWsX2HmieAy6A3rcqp9e-ZobD27lGU0zGEvQKMdt7dx_y5aWWrzcWwiYvno9INXVZCyKGhspIqPDLzjcBzK4Xkkxiw2-Dsd69yRyqCWZkYWP6faucyOKplsvJM6AetvYim8nwdWPgBTgEkxsJFxc879dXpJVgvDTLvMILZrjBALS-1q08OlnBA2Xa573zXyNeNE0Unf66e1Y3VCQSVoT8ROLRFhmWq6fbOlLrlo3yVAVZnZugIZsX7n1Yl_PY-iRvm6t4aK2xWaR1nss_rQ-zNG31PG7oHDjYnnOesV6o0SYog1Hj19yGGHSck3El7pPrmjf2uT1UAa_gDlz_C905nK3gT6ubvypBamRq0QnnBRfeXpiu-6mUlXV1SaeC0y-ckQ3qT_cIQ5NGhXK851wyniKMjNKb0Nipk2jsmsGxNgZOP_bpvMItI6kVj2Cx4tEOID83N_P_l90HLChSTBSCs-hvn0uz6fJPddHwz08rfQzVf2qnE2WQsgUt6bT_LpfK7oXykjPnOEqJWENkkR3xdZkMIGMHO_HopebOySAoJy7Ye0
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 7
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 309

{
  "id" : "usr_2B6lPmGt21qk2VE8lysy3o",
  "name" : "hZVTm Overwatch",
  "email" : "61zibJnt@benchling.com",
  "timezone" : "UTC",
  "status" : "active",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-09-10T07:27:53.446624Z",
  "updated_at" : "2026-09-10T07:27:53.446624Z"
}

Update a user

Updates the specified user by setting the values of the parameters passed.

Authorization: Your API token must include at least one of the following scopes: user.update, user.*, *

Path parameters ./api/public/v1/users/{userId}

Parameter Description

userId

The unique identifier of the user.

Fields

Path Type Description

name

String

The name of the user.

timezone

String

The timezone of the user.

status

String

The team status of the user.

metadata

Object

The metadata to be associated the user.

Request

PATCH /api/public/v1/users/usr_2SHimC2Ry7wadFEKSii2RW HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5OTY2ZWZhNi0yMjk4LTQxNTQtYmQyYi00YmQxODI3MWEzYTYiLCJqdGkiOiI5ZmQzMjNkNi1kMGZlLTRjN2UtOTJiMy1hZGZjMTFkMTRhOTEiLCJpYXQiOjE3ODkwMjUyNzIsIm5iZiI6MTc4OTAyNTI3MiwiZXhwIjoxNzg5MTExNjcyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQ1bEtzcFp5M1FXMHQ3a01kUU1YdWMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mrM3ze1Dxgdi2X0euxyE3tsD54sy3UUL-7YvgND24CoM2CmQkABggsp4NvA6r-s26ebV76VlrHXS1-Fj-E40Tmgg7PLF8bh5P1Q_sMb3h9e54KCtjMEQ0HnUVT20uBSoWI0VNbBCGm4z5hfQw_2wPyeezV70ZZNDijDe1XMjq2uM0GpaUZllaL_t4tv4WbqGZfCHz9mPGfDvbErT5bt6kml3wyRrrCHmPDs5uImjwrhWSzJP4VYnfX13V1dBlSMcc5bdyJnpcErVbfrvX8v9VxVRk-mZQmPv5ICMEaKcydkNp_fOmq3-TGUE3NfNcZoORxtrgJXs7Ec-tTFwTONfxAd-IlQqMtuQIjL_E3-woI7FiX4OAmTHVU5kOPXaXkaOZSMZe4egh46M0WzhoBih8DIAqrhbXz3nE7M5rgnbvRbBgwjoP-FD053M_4xe08-2lrrTBktiTNaX8Ra16JxDFdzSa3MWynZN-URCPPh6MYPGffoqC5TXFkdUoYetGjAmHx65jc_wEgODbaKO7YQCsVZsuvvn6qPwnTslA8mZ3XGs5OWqTnBiesvnOUMzf7NVk_CTuAVemZTc7VaER6Z2nPO-x0v_Y4AZcPsXn4BUhCWvLJ_gU-h1pPzUlrwSpqjNAWIUPa5F2upSZfe0Ex4J0ZCL761YiQ7lqpBrFrQTqjA
Content-Length: 150
Host: localhost:8080

{
  "name" : "Benchling In Vivo",
  "timezone" : "Europe/London",
  "status" : "inactive",
  "metadata" : {
    "user-internal-id" : "USER-4321"
  }
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 8
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 323

{
  "id" : "usr_2SHimC2Ry7wadFEKSii2RW",
  "name" : "Benchling In Vivo",
  "email" : "ATFKMpMz@benchling.com",
  "timezone" : "Europe/London",
  "status" : "inactive",
  "metadata" : {
    "user-internal-id" : "USER-4321"
  },
  "created_at" : "2026-09-10T07:27:49.804842Z",
  "updated_at" : "2026-09-10T07:27:52.841687Z"
}

List all users

Returns a list of your users.

Authorization: Your API token must include at least one of the following scopes: user.read, user.*, *

Query parameters

Parameter Description

perPage

The number of users to return per page.

page

The page of users to return.

name

Filter users to return by name

email

Filter users to return by email

metadata

Filter users to return by metadata value

Request

GET /api/public/v1/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MTVjYzM0Yi01MWFlLTQ5MTMtODQwNy02MjUyNDg3MzZiYzAiLCJqdGkiOiIwZjA1NTZkYy02ZGUwLTQxYTUtYTE5Yi00OTVjM2M2NzVmYzgiLCJpYXQiOjE3ODkwMjUyNzEsIm5iZiI6MTc4OTAyNTI3MSwiZXhwIjoxNzg5MTExNjcxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFKWUhOd1A4TkRZRTF0SjQ0aEpacHMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.llf0rmbjmaOstWrq9bCkTa8UiH3MqRaQwXr4Pqln2h8gcVC_K-UTJdcX3IVi4CCt8gG2ERwnBPeVBGmm_IT0u6osLbMmzwyinhAZfzpT7bz0K8cjsLv3knXiTTBnI1OsXiDI8cJlf-rnj8ZYFtzLr61ZzYOacJ-UQE290qsAEFEMWexa6f1VhHQ3bvZKn7RvgEHmWQIzRm-rKHDBf2Dj7JQk22F-iU4nrI8fALTcOs7yVvnkFHvIAyn8tUOvxC8ybZJ0wZ4FnR5AjPEUpcvuh566t3rTk4uDUxrRhC5J0l2QQZJxbkgoN-S90fHANNx7EeR5uWrREcBDTWoG0aXZSXXvIUAFrKW4ekuo_6CZVKbEbjm67alqQCWAsZzLBQobF87v_YoQGBvpo7oFd00ne4783itgs6WTh9vkLTKXJCU204NpvafqPPNe1x5YWa9DSjDHltnzLkv2XmvrOwIUMr0q8MxV5sqPgtNEDHmfL92Vz92Qxxg4BQoi835EWbNPPxu4SvHJXK7RGgPbhF42BE074epjjmJTlUz8Q3f_ES6SELXkNFRWmIeKnpKHeKNi5Vout--wx_C_MVKr4BjkdCX29_-rhBv3Nlp6C_wh-Q0Y38Mad6yFx9oLAeOExX8YFrIXyuL1Ryte-YdSpGu55xn3fpCSjL0mFDI7g20ltlI
Host: localhost:8080

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 9
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 725

{
  "data" : [ {
    "id" : "usr_1rxMpvSYHfCeNegrvfPp0F",
    "name" : "t4mQ2 Overwatch",
    "email" : "GtzcfNjd@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:27:51.762517Z",
    "updated_at" : "2026-09-10T07:27:51.762517Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/users?page=1",
    "last" : "http://localhost:8080/api/public/v1/users?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/users",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Webhooks

Listen for events on your team so your integration can automatically trigger reactions.

Attributes

Path Type Description

id

String

The unique identifier of the webhook event.

client_id

String

The client ID of the API key that triggered the webhook event.

event

String

The name of the webhook event.

version

String

The version of the webhook event.

created_at

String

The created timestamp of the webhook event.

payload

Object

The payload data associated to the webhook event.

Animal

animal.created

Triggered when an animal is created.

{
  "id" : "whe_4uWj4lFc9OmuyWGQQf0G8G",
  "client_id" : "75a07b04-37e3-4b79-9998-1756bdb069e0",
  "event" : "animal.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.927714Z",
  "payload" : {
    "id" : "aml_xQbXW9koXxUaNnuh7mW8h",
    "catalog" : "A0000001",
    "name" : "gXtIvF8DfB",
    "number" : 1,
    "strain" : "rBlTSz5Wcd",
    "species" : "jh0KaOdn1s",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "wZi7FKpEiy",
    "ear" : "XJhfSeEKXX",
    "tag" : "jv5qHAK03q",
    "donor" : "lZEnOuZjxB",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_IfK4gJM84mBPL7CIgNQJc",
      "project_id" : "pjt_6qMoCVUmAvlqIruLPuXrqh",
      "name" : "zV8wVLcw6w",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4M1qOBPIhGE2EUsSvszwJo",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "Gx8NVrfr8S",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2NLrtMNZq4lRUjxQyk8tKw",
        "name" : "GrAYjpPwtn",
        "email" : "HOkfknKf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_23HPHNFz9Hrjzx1w8SAQkJ",
        "name" : "hGxWsxJ4XV",
        "email" : "QhEFmkhs@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:55.587421Z",
      "updated_at" : "2026-09-10T07:28:55.587421Z"
    },
    "study_group" : {
      "id" : "grp_qNCPpIkuibt8CxELSgJ8L",
      "study_id" : "sdy_IfK4gJM84mBPL7CIgNQJc",
      "name" : "fnNxSNTPCP",
      "no" : 626781753,
      "color" : "iP0V8pophS",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:28:55.868122Z",
      "updated_at" : "2026-09-10T07:28:55.868122Z"
    },
    "cage" : {
      "id" : "cge_5pAZO7MQxIa2foFkNfJiF4",
      "study_id" : "sdy_IfK4gJM84mBPL7CIgNQJc",
      "name" : "clPjgYHYSw",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:28:55.858964Z",
      "updated_at" : "2026-09-10T07:28:55.858964Z"
    },
    "created_at" : "2026-09-10T07:28:55.872850Z",
    "updated_at" : "2026-09-10T07:28:55.872850Z"
  }
}

animal.updated

Triggered when an animal is updated.

{
  "id" : "whe_6wbzfCUGqERnGAK9yYBeSK",
  "client_id" : "16432c9f-7533-43ec-9798-d154a0b2579c",
  "event" : "animal.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.530384Z",
  "payload" : {
    "id" : "aml_6qTApeqEzvqBnKwarfIpuJ",
    "catalog" : "A0000001",
    "name" : "MUU3FtwHpd",
    "number" : 1,
    "strain" : "oyc16WSyOo",
    "species" : "D2QA6Hq8DW",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "p0R8qMezaM",
    "ear" : "FotEExCAso",
    "tag" : "AQSapLzvHY",
    "donor" : "T8jz1e2E9R",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_2cMAKIMVegnpys4lF0er1n",
      "name" : "r9NpChj44j",
      "email" : "K6ftNxnp@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2EXct553kMDHO5UZ3839gW",
      "title" : "Found dead",
      "comment" : "ZYX9x2HfxQ"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "project_id" : "pjt_6p9OfPid37q6eGUK7r6LSs",
      "name" : "CU6eZR4ZHR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6E11evzaOWQaNjckvTtgoe",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "liVwjIzmKg",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7O4PPai5ApxgEnejchwUBy",
        "name" : "VAIQy0Igj9",
        "email" : "0cbd8ElI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4vARgyBqHpckX2GXDcWykY",
        "name" : "1QFY1KtU2I",
        "email" : "M59cWkQL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.149026Z",
      "updated_at" : "2026-09-10T07:28:50.149026Z"
    },
    "study_group" : {
      "id" : "grp_SZEtubea5e7pA48daNBTr",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "39pTsOr2e2",
      "no" : 998174399,
      "color" : "Wo81GmTpxw",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:28:50.386916Z",
      "updated_at" : "2026-09-10T07:28:50.386916Z"
    },
    "cage" : {
      "id" : "cge_31iwkvpxI7p3lVz6eowws0",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "XULXbelLQu",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:28:50.376176Z",
      "updated_at" : "2026-09-10T07:28:50.376176Z"
    },
    "created_at" : "2026-09-10T07:28:50.391416Z",
    "updated_at" : "2026-09-10T07:28:50.391416Z"
  }
}

animal.deleted

Triggered when an animal is deleted.

{
  "id" : "whe_UQDarxLQwIajWGpfHm5m9",
  "client_id" : "7d6d1347-f909-4f96-9e48-f751977b5c9d",
  "event" : "animal.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.533775Z",
  "payload" : {
    "id" : "aml_6qTApeqEzvqBnKwarfIpuJ",
    "catalog" : "A0000001",
    "name" : "MUU3FtwHpd",
    "number" : 1,
    "strain" : "oyc16WSyOo",
    "species" : "D2QA6Hq8DW",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "p0R8qMezaM",
    "ear" : "FotEExCAso",
    "tag" : "AQSapLzvHY",
    "donor" : "T8jz1e2E9R",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_2cMAKIMVegnpys4lF0er1n",
      "name" : "r9NpChj44j",
      "email" : "K6ftNxnp@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2EXct553kMDHO5UZ3839gW",
      "title" : "Found dead",
      "comment" : "ZYX9x2HfxQ"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "project_id" : "pjt_6p9OfPid37q6eGUK7r6LSs",
      "name" : "CU6eZR4ZHR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6E11evzaOWQaNjckvTtgoe",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "liVwjIzmKg",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7O4PPai5ApxgEnejchwUBy",
        "name" : "VAIQy0Igj9",
        "email" : "0cbd8ElI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4vARgyBqHpckX2GXDcWykY",
        "name" : "1QFY1KtU2I",
        "email" : "M59cWkQL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.149026Z",
      "updated_at" : "2026-09-10T07:28:50.149026Z"
    },
    "study_group" : {
      "id" : "grp_SZEtubea5e7pA48daNBTr",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "39pTsOr2e2",
      "no" : 998174399,
      "color" : "Wo81GmTpxw",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:28:50.386916Z",
      "updated_at" : "2026-09-10T07:28:50.386916Z"
    },
    "cage" : {
      "id" : "cge_31iwkvpxI7p3lVz6eowws0",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "XULXbelLQu",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:28:50.376176Z",
      "updated_at" : "2026-09-10T07:28:50.376176Z"
    },
    "created_at" : "2026-09-10T07:28:50.391416Z",
    "updated_at" : "2026-09-10T07:28:50.391416Z"
  }
}

animal.metadata.updated

Triggered when an animal metadata is updated.

{
  "id" : "whe_7BG4JOpommXiyIUFomqACV",
  "client_id" : "515c1a84-45c5-4330-8434-8b72e85f8ee6",
  "event" : "animal.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.535140Z",
  "payload" : {
    "id" : "aml_6qTApeqEzvqBnKwarfIpuJ",
    "catalog" : "A0000001",
    "name" : "MUU3FtwHpd",
    "number" : 1,
    "strain" : "oyc16WSyOo",
    "species" : "D2QA6Hq8DW",
    "sex" : "m",
    "dob" : "2026-09-09",
    "tail" : "p0R8qMezaM",
    "ear" : "FotEExCAso",
    "tag" : "AQSapLzvHY",
    "donor" : "T8jz1e2E9R",
    "tracking_date" : "2026-09-10",
    "disease_induction_date" : "2026-09-10",
    "terminated_at" : "2026-09-10",
    "terminated_by" : {
      "id" : "usr_2cMAKIMVegnpys4lF0er1n",
      "name" : "r9NpChj44j",
      "email" : "K6ftNxnp@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2EXct553kMDHO5UZ3839gW",
      "title" : "Found dead",
      "comment" : "ZYX9x2HfxQ"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "project_id" : "pjt_6p9OfPid37q6eGUK7r6LSs",
      "name" : "CU6eZR4ZHR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6E11evzaOWQaNjckvTtgoe",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "liVwjIzmKg",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7O4PPai5ApxgEnejchwUBy",
        "name" : "VAIQy0Igj9",
        "email" : "0cbd8ElI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4vARgyBqHpckX2GXDcWykY",
        "name" : "1QFY1KtU2I",
        "email" : "M59cWkQL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.149026Z",
      "updated_at" : "2026-09-10T07:28:50.149026Z"
    },
    "study_group" : {
      "id" : "grp_SZEtubea5e7pA48daNBTr",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "39pTsOr2e2",
      "no" : 998174399,
      "color" : "Wo81GmTpxw",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-09-10T07:28:50.386916Z",
      "updated_at" : "2026-09-10T07:28:50.386916Z"
    },
    "cage" : {
      "id" : "cge_31iwkvpxI7p3lVz6eowws0",
      "study_id" : "sdy_11xAj5P4m6vF7eGMI4sFbH",
      "name" : "XULXbelLQu",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-09-10T07:28:50.376176Z",
      "updated_at" : "2026-09-10T07:28:50.376176Z"
    },
    "created_at" : "2026-09-10T07:28:50.391416Z",
    "updated_at" : "2026-09-10T07:28:50.391416Z"
  }
}

Animal Dosage

animal.dosage.created

Triggered when an animal dosage is created.

{
  "id" : "whe_3R0LdwhWu2z454qJWVq17N",
  "client_id" : "9a299a47-bcc7-44d2-a5b6-84acc82c95be",
  "event" : "animal.dosage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.722304Z",
  "payload" : {
    "id" : "dsg_cvikG5GqlBOVWPt6nOhoh",
    "name" : "Example dosage",
    "dosed_at" : "2026-09-10T07:28:49.388366Z",
    "comments" : "i2PFz0b2QG",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5.29",
      "display_unit" : "mg/kg",
      "display_value" : "5.29"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15.63",
      "display_unit" : "ml/kg",
      "display_value" : "15.63"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "22.95",
      "display_unit" : "mg/ml",
      "display_value" : "22.95"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "35.40",
      "display_unit" : "µL",
      "display_value" : "35.40"
    },
    "study" : {
      "id" : "sdy_HySwCz05C7bFHeSMshq25",
      "project_id" : "pjt_5MCE1annYHYmXnsIztiClp",
      "name" : "Bjc3FqfQde",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5l1dmdfDW0w0Ve5S37LApm",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "rKASeUVlif",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Nr4SVtzoT0EvkTYwyDUqU",
        "name" : "H9pUUIrI3J",
        "email" : "v7ayehQx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1btJzwe3ms2tMfJglxKqpl",
        "name" : "L5a0bNPyix",
        "email" : "LGXzr5rZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:49.159497Z",
      "updated_at" : "2026-09-10T07:28:49.159497Z"
    },
    "animal" : {
      "id" : "aml_6QmAfwrL95J1VO5JkWWVFJ",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "study_group_id" : "grp_2FBrf2w2Kr8MNdhzViEBTg",
      "cage_id" : "cge_66yGSXKdjHcwm9hPzh8hBz",
      "catalog" : "A0000001",
      "name" : "gtbMVLnyJB",
      "number" : 1,
      "strain" : "2xPStlcObU",
      "species" : "0LPGGdHpXo",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "OV6H1bBfye",
      "ear" : "CvWQCeZPTQ",
      "tag" : "nCxpuVg9NQ",
      "donor" : "ij4beu2ger",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:49.362087Z",
      "updated_at" : "2026-09-10T07:28:49.362087Z",
      "disease_induction_date" : "2026-09-10"
    },
    "measurement" : {
      "id" : "mst_14v43Qs7yyuY4LPQPDnhnE",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "animal_id" : "aml_6QmAfwrL95J1VO5JkWWVFJ",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_7BUZp936JFos8O6CujFNZe",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_2shddOCqBkCd85XHyAbTlW",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_49fJ4X0lA4tmCCy44c6GHN",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_65ahrzZ08yQ8NMlgbRrUK1",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_65ahrzZ08yQ8NMlgbRrUK1",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:28:49.371914Z",
      "updated_at" : "2026-09-10T07:28:49.371914Z"
    },
    "user" : {
      "id" : "usr_6oPeXJWEe5iA8Z1dw1haCI",
      "name" : "WaY8K Overwatch",
      "email" : "x1tWZ68D@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:28:49.140830Z",
      "updated_at" : "2026-09-10T07:28:49.140830Z"
    },
    "treatment" : {
      "id" : "tmt_34cdYEA7Wx65EslF9c2Hhw",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "type" : "concentration_mlkg",
      "name" : "HKIJxombjv",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "created_at" : "2026-09-10T07:28:49.381572Z",
      "updated_at" : "2026-09-10T07:28:49.381572Z",
      "external_entity_id" : "P3Rv6qGyr9"
    },
    "created_at" : "2026-09-10T07:28:49.388676Z",
    "updated_at" : "2026-09-10T07:28:49.388676Z"
  }
}

animal.dosage.deleted

Triggered when an animal dosage is deleted.

{
  "id" : "whe_3bxsJutpBrhqykNzaC5TDe",
  "client_id" : "e1514d59-da1a-4217-af1d-4ae060437c82",
  "event" : "animal.dosage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.728450Z",
  "payload" : {
    "id" : "dsg_cvikG5GqlBOVWPt6nOhoh",
    "name" : "Example dosage",
    "dosed_at" : "2026-09-10T07:28:49.388366Z",
    "comments" : "i2PFz0b2QG",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5.29",
      "display_unit" : "mg/kg",
      "display_value" : "5.29"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15.63",
      "display_unit" : "ml/kg",
      "display_value" : "15.63"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "22.95",
      "display_unit" : "mg/ml",
      "display_value" : "22.95"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "35.40",
      "display_unit" : "µL",
      "display_value" : "35.40"
    },
    "study" : {
      "id" : "sdy_HySwCz05C7bFHeSMshq25",
      "project_id" : "pjt_5MCE1annYHYmXnsIztiClp",
      "name" : "Bjc3FqfQde",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5l1dmdfDW0w0Ve5S37LApm",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "rKASeUVlif",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Nr4SVtzoT0EvkTYwyDUqU",
        "name" : "H9pUUIrI3J",
        "email" : "v7ayehQx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1btJzwe3ms2tMfJglxKqpl",
        "name" : "L5a0bNPyix",
        "email" : "LGXzr5rZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:49.159497Z",
      "updated_at" : "2026-09-10T07:28:49.159497Z"
    },
    "animal" : {
      "id" : "aml_6QmAfwrL95J1VO5JkWWVFJ",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "study_group_id" : "grp_2FBrf2w2Kr8MNdhzViEBTg",
      "cage_id" : "cge_66yGSXKdjHcwm9hPzh8hBz",
      "catalog" : "A0000001",
      "name" : "gtbMVLnyJB",
      "number" : 1,
      "strain" : "2xPStlcObU",
      "species" : "0LPGGdHpXo",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "OV6H1bBfye",
      "ear" : "CvWQCeZPTQ",
      "tag" : "nCxpuVg9NQ",
      "donor" : "ij4beu2ger",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:49.362087Z",
      "updated_at" : "2026-09-10T07:28:49.362087Z",
      "disease_induction_date" : "2026-09-10"
    },
    "measurement" : {
      "id" : "mst_14v43Qs7yyuY4LPQPDnhnE",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "animal_id" : "aml_6QmAfwrL95J1VO5JkWWVFJ",
      "measured_at" : "2026-09-10",
      "calculations" : [ {
        "id" : "vbl_7BUZp936JFos8O6CujFNZe",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_2shddOCqBkCd85XHyAbTlW",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_49fJ4X0lA4tmCCy44c6GHN",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_65ahrzZ08yQ8NMlgbRrUK1",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_65ahrzZ08yQ8NMlgbRrUK1",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-09-10T07:28:49.371914Z",
      "updated_at" : "2026-09-10T07:28:49.371914Z"
    },
    "user" : {
      "id" : "usr_6oPeXJWEe5iA8Z1dw1haCI",
      "name" : "WaY8K Overwatch",
      "email" : "x1tWZ68D@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:28:49.140830Z",
      "updated_at" : "2026-09-10T07:28:49.140830Z"
    },
    "treatment" : {
      "id" : "tmt_34cdYEA7Wx65EslF9c2Hhw",
      "study_id" : "sdy_HySwCz05C7bFHeSMshq25",
      "type" : "concentration_mlkg",
      "name" : "HKIJxombjv",
      "label" : "Test Treatment Label",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "created_at" : "2026-09-10T07:28:49.381572Z",
      "updated_at" : "2026-09-10T07:28:49.381572Z",
      "external_entity_id" : "P3Rv6qGyr9"
    },
    "created_at" : "2026-09-10T07:28:49.388676Z",
    "updated_at" : "2026-09-10T07:28:49.388676Z"
  }
}

Animal Measurement

animal.measurement.created

Triggered when an animal measurement is created.

{
  "id" : "whe_7Pp5mpVOhgBprwAOws9S0u",
  "client_id" : "a2d5b710-8a47-4d5b-a471-490c00d7c52d",
  "event" : "animal.measurement.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:56.238826Z",
  "payload" : {
    "id" : "mst_1IlpmmMSdBtr8gwNr2VM1g",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_6khrtkmhhEh3FXqBUXZJDG",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5czkZp5CLIic1PNrgborhH",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_3kTGI1tGTkyrgN4u7Ler28",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "project_id" : "pjt_wkYhFf2TvIy9pHVg2dYAz",
      "name" : "HlIPj8vF3Q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_24oeZs6MRSd6Q6qgkfRcj1",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OCgA7mUUCG",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4DPewJoKUvNLDojKJBUxlC",
        "name" : "lBgWk33NdO",
        "email" : "Ghi0Nwem@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6MNV9oH9fz5xBDTrOdR3xo",
        "name" : "zdPCxBFIAL",
        "email" : "HeyvYIpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:55.957788Z",
      "updated_at" : "2026-09-10T07:28:55.957788Z"
    },
    "animal" : {
      "id" : "aml_3hRAudUWMcbVa8vodCPoVt",
      "study_id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "study_group_id" : "grp_2mXQw5mQ3KlHe9AdxXeuqS",
      "cage_id" : "cge_2Ytk42Twnr1nLGUkDI4qbY",
      "catalog" : "A0000001",
      "name" : "nXcMaVuFHb",
      "number" : 1,
      "strain" : "IWM2hJKARl",
      "species" : "mWpEjEbi9q",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "QCMz7jkz2E",
      "ear" : "WXzVMihRjk",
      "tag" : "BrAuukjuMM",
      "donor" : "4d45kiXIbI",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:56.171069Z",
      "updated_at" : "2026-09-10T07:28:56.171069Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_5qEFPd96hEtHKCpUX5REae",
      "name" : "lWc8BlUzQm",
      "email" : "QkfOY8NU@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-09-10T07:28:55.940990Z",
      "updated_at" : "2026-09-10T07:28:55.940990Z"
    },
    "created_at" : "2026-09-10T07:28:56.178475Z",
    "updated_at" : "2026-09-10T07:28:56.178475Z"
  }
}

animal.measurement.updated

Triggered when an animal measurement is updated.

{
  "id" : "whe_5NeGGv0fFQCahpaWeCD21w",
  "client_id" : "c97ff499-ecf5-4029-976d-9a8216c59819",
  "event" : "animal.measurement.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:56.241374Z",
  "payload" : {
    "id" : "mst_1IlpmmMSdBtr8gwNr2VM1g",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_6khrtkmhhEh3FXqBUXZJDG",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5czkZp5CLIic1PNrgborhH",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_3kTGI1tGTkyrgN4u7Ler28",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "project_id" : "pjt_wkYhFf2TvIy9pHVg2dYAz",
      "name" : "HlIPj8vF3Q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_24oeZs6MRSd6Q6qgkfRcj1",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OCgA7mUUCG",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4DPewJoKUvNLDojKJBUxlC",
        "name" : "lBgWk33NdO",
        "email" : "Ghi0Nwem@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6MNV9oH9fz5xBDTrOdR3xo",
        "name" : "zdPCxBFIAL",
        "email" : "HeyvYIpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:55.957788Z",
      "updated_at" : "2026-09-10T07:28:55.957788Z"
    },
    "animal" : {
      "id" : "aml_3hRAudUWMcbVa8vodCPoVt",
      "study_id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "study_group_id" : "grp_2mXQw5mQ3KlHe9AdxXeuqS",
      "cage_id" : "cge_2Ytk42Twnr1nLGUkDI4qbY",
      "catalog" : "A0000001",
      "name" : "nXcMaVuFHb",
      "number" : 1,
      "strain" : "IWM2hJKARl",
      "species" : "mWpEjEbi9q",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "QCMz7jkz2E",
      "ear" : "WXzVMihRjk",
      "tag" : "BrAuukjuMM",
      "donor" : "4d45kiXIbI",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:56.171069Z",
      "updated_at" : "2026-09-10T07:28:56.171069Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_5qEFPd96hEtHKCpUX5REae",
      "name" : "lWc8BlUzQm",
      "email" : "QkfOY8NU@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-09-10T07:28:55.940990Z",
      "updated_at" : "2026-09-10T07:28:55.940990Z"
    },
    "created_at" : "2026-09-10T07:28:56.178475Z",
    "updated_at" : "2026-09-10T07:28:56.178475Z"
  }
}

animal.measurement.deleted

Triggered when an animal measurement is delete.

{
  "id" : "whe_3CpLbILFlHKU8VOGUmvHkk",
  "client_id" : "6e9657e5-9b40-4613-adef-5baab61a9114",
  "event" : "animal.measurement.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:56.243442Z",
  "payload" : {
    "id" : "mst_1IlpmmMSdBtr8gwNr2VM1g",
    "measured_at" : "2026-09-10",
    "calculations" : [ {
      "id" : "vbl_6khrtkmhhEh3FXqBUXZJDG",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5czkZp5CLIic1PNrgborhH",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_3kTGI1tGTkyrgN4u7Ler28",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_6lJG9neoanj5iTv0w13UGP",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "project_id" : "pjt_wkYhFf2TvIy9pHVg2dYAz",
      "name" : "HlIPj8vF3Q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_24oeZs6MRSd6Q6qgkfRcj1",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OCgA7mUUCG",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4DPewJoKUvNLDojKJBUxlC",
        "name" : "lBgWk33NdO",
        "email" : "Ghi0Nwem@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6MNV9oH9fz5xBDTrOdR3xo",
        "name" : "zdPCxBFIAL",
        "email" : "HeyvYIpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:55.957788Z",
      "updated_at" : "2026-09-10T07:28:55.957788Z"
    },
    "animal" : {
      "id" : "aml_3hRAudUWMcbVa8vodCPoVt",
      "study_id" : "sdy_47e1QM5HS14mZRz4bJoKAH",
      "study_group_id" : "grp_2mXQw5mQ3KlHe9AdxXeuqS",
      "cage_id" : "cge_2Ytk42Twnr1nLGUkDI4qbY",
      "catalog" : "A0000001",
      "name" : "nXcMaVuFHb",
      "number" : 1,
      "strain" : "IWM2hJKARl",
      "species" : "mWpEjEbi9q",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "QCMz7jkz2E",
      "ear" : "WXzVMihRjk",
      "tag" : "BrAuukjuMM",
      "donor" : "4d45kiXIbI",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:56.171069Z",
      "updated_at" : "2026-09-10T07:28:56.171069Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_5qEFPd96hEtHKCpUX5REae",
      "name" : "lWc8BlUzQm",
      "email" : "QkfOY8NU@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-09-10T07:28:55.940990Z",
      "updated_at" : "2026-09-10T07:28:55.940990Z"
    },
    "created_at" : "2026-09-10T07:28:56.178475Z",
    "updated_at" : "2026-09-10T07:28:56.178475Z"
  }
}

Animal Observation

animal.observation.created

Triggered when an animal observation is created.

{
  "id" : "whe_1W8Sd4BAwDnytaEjaM5wQS",
  "client_id" : "7d658f2a-e053-463f-8472-ce55f16b4b02",
  "event" : "animal.observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.988774Z",
  "payload" : {
    "id" : "obs_aA36JHTilbOPBYVRdkb1b",
    "glossary_id" : "gly_55tXBCpU89NRXtz8gtkdHq",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:28:51.934389Z",
    "study" : {
      "id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "project_id" : "pjt_4yVYNCa33qX11U3SZV6gAI",
      "name" : "KVA2grrMvd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_pCz9dlQylDrz3FiNamKvH",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OECCxadgC5",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3WaH58CLbzROeFpBRMSUiu",
        "name" : "po5upbCxT9",
        "email" : "nriQ2f0A@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2IzG9z7QmPiOV9d7oOdCyn",
        "name" : "NCuiQ2XwnK",
        "email" : "LOzvPs8p@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:51.516928Z",
      "updated_at" : "2026-09-10T07:28:51.516928Z"
    },
    "animal" : {
      "id" : "aml_7XK4OBr2BKz79yImWRfcqz",
      "study_id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "study_group_id" : "grp_6YiPyuhOfamtuirZGAh6Pc",
      "cage_id" : "cge_2gB34edaS3YkrLyaRv2dkP",
      "catalog" : "A0000001",
      "name" : "cry2Hl42Go",
      "number" : 1,
      "strain" : "e9DmUfgfed",
      "species" : "qGr1cwPnNC",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "L6uoPW8F2t",
      "ear" : "XgjnK7RKEO",
      "tag" : "Ed2OQW1olD",
      "donor" : "eDyaUmwTLg",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6LjEhGGTQfGR3Fw3FKoFVH",
        "name" : "exftaIx3GT",
        "email" : "j8bEoXBA@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_uQU6tRLRIf1GySmqH6P9P",
        "title" : "Found dead",
        "comment" : "art0g3ykLj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:51.839535Z",
      "updated_at" : "2026-09-10T07:28:51.839535Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_1l2I2o3jE4NTsCNad5zrRm",
      "name" : "oBlfx Overwatch",
      "email" : "i7Od6wHL@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:28:51.496491Z",
      "updated_at" : "2026-09-10T07:28:51.496491Z"
    },
    "created_at" : "2026-09-10T07:28:51.934650Z",
    "updated_at" : "2026-09-10T07:28:51.934650Z"
  }
}

animal.observation.updated

Triggered when an animal observation is updated.

{
  "id" : "whe_5cxfiXioxznRkapHvxZL7p",
  "client_id" : "e972413f-a9ac-4f1c-b096-33d10482cc6e",
  "event" : "animal.observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.990359Z",
  "payload" : {
    "id" : "obs_aA36JHTilbOPBYVRdkb1b",
    "glossary_id" : "gly_55tXBCpU89NRXtz8gtkdHq",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:28:51.934389Z",
    "study" : {
      "id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "project_id" : "pjt_4yVYNCa33qX11U3SZV6gAI",
      "name" : "KVA2grrMvd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_pCz9dlQylDrz3FiNamKvH",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OECCxadgC5",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3WaH58CLbzROeFpBRMSUiu",
        "name" : "po5upbCxT9",
        "email" : "nriQ2f0A@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2IzG9z7QmPiOV9d7oOdCyn",
        "name" : "NCuiQ2XwnK",
        "email" : "LOzvPs8p@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:51.516928Z",
      "updated_at" : "2026-09-10T07:28:51.516928Z"
    },
    "animal" : {
      "id" : "aml_7XK4OBr2BKz79yImWRfcqz",
      "study_id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "study_group_id" : "grp_6YiPyuhOfamtuirZGAh6Pc",
      "cage_id" : "cge_2gB34edaS3YkrLyaRv2dkP",
      "catalog" : "A0000001",
      "name" : "cry2Hl42Go",
      "number" : 1,
      "strain" : "e9DmUfgfed",
      "species" : "qGr1cwPnNC",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "L6uoPW8F2t",
      "ear" : "XgjnK7RKEO",
      "tag" : "Ed2OQW1olD",
      "donor" : "eDyaUmwTLg",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6LjEhGGTQfGR3Fw3FKoFVH",
        "name" : "exftaIx3GT",
        "email" : "j8bEoXBA@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_uQU6tRLRIf1GySmqH6P9P",
        "title" : "Found dead",
        "comment" : "art0g3ykLj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:51.839535Z",
      "updated_at" : "2026-09-10T07:28:51.839535Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_1l2I2o3jE4NTsCNad5zrRm",
      "name" : "oBlfx Overwatch",
      "email" : "i7Od6wHL@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:28:51.496491Z",
      "updated_at" : "2026-09-10T07:28:51.496491Z"
    },
    "created_at" : "2026-09-10T07:28:51.934650Z",
    "updated_at" : "2026-09-10T07:28:51.934650Z"
  }
}

animal.observation.deleted

Triggered when an animal observation is deleted.

{
  "id" : "whe_1dPMgqwGYGmfScqU6GYuqU",
  "client_id" : "070ad2a9-a1cb-4fe9-84f6-f5bf4712b448",
  "event" : "animal.observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.995410Z",
  "payload" : {
    "id" : "obs_aA36JHTilbOPBYVRdkb1b",
    "glossary_id" : "gly_55tXBCpU89NRXtz8gtkdHq",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-09-10T07:28:51.934389Z",
    "study" : {
      "id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "project_id" : "pjt_4yVYNCa33qX11U3SZV6gAI",
      "name" : "KVA2grrMvd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_pCz9dlQylDrz3FiNamKvH",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "OECCxadgC5",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3WaH58CLbzROeFpBRMSUiu",
        "name" : "po5upbCxT9",
        "email" : "nriQ2f0A@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2IzG9z7QmPiOV9d7oOdCyn",
        "name" : "NCuiQ2XwnK",
        "email" : "LOzvPs8p@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:51.516928Z",
      "updated_at" : "2026-09-10T07:28:51.516928Z"
    },
    "animal" : {
      "id" : "aml_7XK4OBr2BKz79yImWRfcqz",
      "study_id" : "sdy_1iN3PHP6Ofu2TsDmPPn5BN",
      "study_group_id" : "grp_6YiPyuhOfamtuirZGAh6Pc",
      "cage_id" : "cge_2gB34edaS3YkrLyaRv2dkP",
      "catalog" : "A0000001",
      "name" : "cry2Hl42Go",
      "number" : 1,
      "strain" : "e9DmUfgfed",
      "species" : "qGr1cwPnNC",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "L6uoPW8F2t",
      "ear" : "XgjnK7RKEO",
      "tag" : "Ed2OQW1olD",
      "donor" : "eDyaUmwTLg",
      "tracking_date" : "2026-09-10",
      "terminated_at" : "2026-09-10",
      "terminated_by" : {
        "id" : "usr_6LjEhGGTQfGR3Fw3FKoFVH",
        "name" : "exftaIx3GT",
        "email" : "j8bEoXBA@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_uQU6tRLRIf1GySmqH6P9P",
        "title" : "Found dead",
        "comment" : "art0g3ykLj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:51.839535Z",
      "updated_at" : "2026-09-10T07:28:51.839535Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_1l2I2o3jE4NTsCNad5zrRm",
      "name" : "oBlfx Overwatch",
      "email" : "i7Od6wHL@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-09-10T07:28:51.496491Z",
      "updated_at" : "2026-09-10T07:28:51.496491Z"
    },
    "created_at" : "2026-09-10T07:28:51.934650Z",
    "updated_at" : "2026-09-10T07:28:51.934650Z"
  }
}

Animal Sample

animal.sample.created

Triggered when an animal sample is created.

{
  "id" : "whe_6vLBNIrcvyMjk2AuaJi4TB",
  "client_id" : "6a04e280-3d1b-4e09-af73-a9cb05acdf9f",
  "event" : "animal.sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:52.975061Z",
  "payload" : {
    "id" : "spl_2rId5ErmiZt6ZFjsijPERr",
    "sample_id" : "S1506594526",
    "sample_definition_id" : "sdf_An2CxBQKSUcZ4Um9dTG08",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:28:52.869164Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-357665330" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "project_id" : "pjt_4fn9HO76Y2WQ8jy1PRBext",
      "name" : "wXr8gSHieF",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MCqnOAzYH1KYCO7kvNqWG",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "onDAGTKxev",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1ZgpbtQcC1OUcodadIceoK",
        "name" : "hhEGJovjtN",
        "email" : "3SgwOjNh@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2705kFr1jWHiO1Er2QUQpv",
        "name" : "ol7RgykMKK",
        "email" : "umzGcyB3@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:52.447480Z",
      "updated_at" : "2026-09-10T07:28:52.447480Z"
    },
    "animal" : {
      "id" : "aml_4Sov9EKNPgEdxeUqUod46i",
      "study_id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "study_group_id" : "grp_1LoKderageNnF1BN2oE5Pu",
      "cage_id" : "cge_1vmCJPVGi6Wr2U73XbSmS4",
      "catalog" : "A0000001",
      "name" : "MskIwOw3qv",
      "number" : 1,
      "strain" : "HWUnJ1rDJi",
      "species" : "LkLtJFpqM7",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "53DX3JsNnR",
      "ear" : "X5gA8UG0Dd",
      "tag" : "PQbPkSZPSh",
      "donor" : "pbsxVAYk3D",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:52.735684Z",
      "updated_at" : "2026-09-10T07:28:52.735684Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_27xS1w7Kdg6C0mHT2WcUJb",
      "name" : "4ZpYosIGpL",
      "email" : "OIIZwrVY@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "wlKeP8XfPe" : "Wv6qMNgZom"
      },
      "created_at" : "2026-09-10T07:28:52.858354Z",
      "updated_at" : "2026-09-10T07:28:52.858354Z"
    },
    "created_at" : "2026-09-10T07:28:52.869428Z",
    "updated_at" : "2026-09-10T07:28:52.869428Z"
  }
}

animal.sample.updated

Triggered when an animal sample is updated.

{
  "id" : "whe_6UYJP5DwkgOvp0EP3ajGL9",
  "client_id" : "7095435d-93de-48c4-aad7-bf893a4432bb",
  "event" : "animal.sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:52.979038Z",
  "payload" : {
    "id" : "spl_2rId5ErmiZt6ZFjsijPERr",
    "sample_id" : "S1506594526",
    "sample_definition_id" : "sdf_An2CxBQKSUcZ4Um9dTG08",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:28:52.869164Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-357665330" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "project_id" : "pjt_4fn9HO76Y2WQ8jy1PRBext",
      "name" : "wXr8gSHieF",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MCqnOAzYH1KYCO7kvNqWG",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "onDAGTKxev",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1ZgpbtQcC1OUcodadIceoK",
        "name" : "hhEGJovjtN",
        "email" : "3SgwOjNh@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2705kFr1jWHiO1Er2QUQpv",
        "name" : "ol7RgykMKK",
        "email" : "umzGcyB3@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:52.447480Z",
      "updated_at" : "2026-09-10T07:28:52.447480Z"
    },
    "animal" : {
      "id" : "aml_4Sov9EKNPgEdxeUqUod46i",
      "study_id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "study_group_id" : "grp_1LoKderageNnF1BN2oE5Pu",
      "cage_id" : "cge_1vmCJPVGi6Wr2U73XbSmS4",
      "catalog" : "A0000001",
      "name" : "MskIwOw3qv",
      "number" : 1,
      "strain" : "HWUnJ1rDJi",
      "species" : "LkLtJFpqM7",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "53DX3JsNnR",
      "ear" : "X5gA8UG0Dd",
      "tag" : "PQbPkSZPSh",
      "donor" : "pbsxVAYk3D",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:52.735684Z",
      "updated_at" : "2026-09-10T07:28:52.735684Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_27xS1w7Kdg6C0mHT2WcUJb",
      "name" : "4ZpYosIGpL",
      "email" : "OIIZwrVY@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "wlKeP8XfPe" : "Wv6qMNgZom"
      },
      "created_at" : "2026-09-10T07:28:52.858354Z",
      "updated_at" : "2026-09-10T07:28:52.858354Z"
    },
    "created_at" : "2026-09-10T07:28:52.869428Z",
    "updated_at" : "2026-09-10T07:28:52.869428Z"
  }
}

animal.sample.deleted

Triggered when an animal sample is deleted.

{
  "id" : "whe_Bj2XeZ1Ye1Y04UyThZwZA",
  "client_id" : "0e09c546-a879-4000-b9bb-61fcbe2eebd7",
  "event" : "animal.sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:52.981951Z",
  "payload" : {
    "id" : "spl_2rId5ErmiZt6ZFjsijPERr",
    "sample_id" : "S1506594526",
    "sample_definition_id" : "sdf_An2CxBQKSUcZ4Um9dTG08",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-09-10T09:28:52.869164Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-357665330" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "project_id" : "pjt_4fn9HO76Y2WQ8jy1PRBext",
      "name" : "wXr8gSHieF",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MCqnOAzYH1KYCO7kvNqWG",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "onDAGTKxev",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1ZgpbtQcC1OUcodadIceoK",
        "name" : "hhEGJovjtN",
        "email" : "3SgwOjNh@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2705kFr1jWHiO1Er2QUQpv",
        "name" : "ol7RgykMKK",
        "email" : "umzGcyB3@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:52.447480Z",
      "updated_at" : "2026-09-10T07:28:52.447480Z"
    },
    "animal" : {
      "id" : "aml_4Sov9EKNPgEdxeUqUod46i",
      "study_id" : "sdy_2T8H466FxvbB2Fdulc1Neb",
      "study_group_id" : "grp_1LoKderageNnF1BN2oE5Pu",
      "cage_id" : "cge_1vmCJPVGi6Wr2U73XbSmS4",
      "catalog" : "A0000001",
      "name" : "MskIwOw3qv",
      "number" : 1,
      "strain" : "HWUnJ1rDJi",
      "species" : "LkLtJFpqM7",
      "sex" : "m",
      "dob" : "2026-09-09",
      "tail" : "53DX3JsNnR",
      "ear" : "X5gA8UG0Dd",
      "tag" : "PQbPkSZPSh",
      "donor" : "pbsxVAYk3D",
      "tracking_date" : "2026-09-10",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-09-10T07:28:52.735684Z",
      "updated_at" : "2026-09-10T07:28:52.735684Z",
      "disease_induction_date" : "2026-09-10"
    },
    "user" : {
      "id" : "usr_27xS1w7Kdg6C0mHT2WcUJb",
      "name" : "4ZpYosIGpL",
      "email" : "OIIZwrVY@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "wlKeP8XfPe" : "Wv6qMNgZom"
      },
      "created_at" : "2026-09-10T07:28:52.858354Z",
      "updated_at" : "2026-09-10T07:28:52.858354Z"
    },
    "created_at" : "2026-09-10T07:28:52.869428Z",
    "updated_at" : "2026-09-10T07:28:52.869428Z"
  }
}

Cage

cage.created

Triggered when an cage is created.

{
  "id" : "whe_46JJFhoRRq9G6Vkpi8KfX2",
  "client_id" : "c00de115-c942-480e-9d21-e51ad7c9e030",
  "event" : "cage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:48.284655Z",
  "payload" : {
    "id" : "cge_SmDI244dnMuYmAz43ZYCY",
    "name" : "6Qxx8UDIlB",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_5OOxWxCYTUwZk07G84KzYB",
      "project_id" : "pjt_3Mh0qqQC3ewFwkyCep0wvf",
      "name" : "XuI8f2r6tc",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ExHexFjJROSEQgaTBUSLq",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "aEexS7crgI",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4640JepWZyMbKlWNfnKIL5",
        "name" : "e8ALsoDzue",
        "email" : "eGQTpQSM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_Bx2ffwZ53t3eNXKigH9Cb",
        "name" : "EB0OyDVsbB",
        "email" : "NbHL73mU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.909304Z",
      "updated_at" : "2026-09-10T07:28:47.909304Z"
    },
    "created_at" : "2026-09-10T07:28:48.216184Z",
    "updated_at" : "2026-09-10T07:28:48.216184Z"
  }
}

cage.updated

Triggered when an cage is updated.

{
  "id" : "whe_JyDP9TtzDlDyoPg1QLQHE",
  "client_id" : "be7d4f38-909d-4f63-8360-f2d6626c0837",
  "event" : "cage.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:48.289169Z",
  "payload" : {
    "id" : "cge_SmDI244dnMuYmAz43ZYCY",
    "name" : "6Qxx8UDIlB",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_5OOxWxCYTUwZk07G84KzYB",
      "project_id" : "pjt_3Mh0qqQC3ewFwkyCep0wvf",
      "name" : "XuI8f2r6tc",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ExHexFjJROSEQgaTBUSLq",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "aEexS7crgI",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4640JepWZyMbKlWNfnKIL5",
        "name" : "e8ALsoDzue",
        "email" : "eGQTpQSM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_Bx2ffwZ53t3eNXKigH9Cb",
        "name" : "EB0OyDVsbB",
        "email" : "NbHL73mU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.909304Z",
      "updated_at" : "2026-09-10T07:28:47.909304Z"
    },
    "created_at" : "2026-09-10T07:28:48.216184Z",
    "updated_at" : "2026-09-10T07:28:48.216184Z"
  }
}

cage.deleted

Triggered when an cage is deleted.

{
  "id" : "whe_2JhFNdtzDeKNUl4Bj5njZd",
  "client_id" : "7505a394-9a9d-4a9c-a3b4-242bb15b6668",
  "event" : "cage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:48.291083Z",
  "payload" : {
    "id" : "cge_SmDI244dnMuYmAz43ZYCY",
    "name" : "6Qxx8UDIlB",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_5OOxWxCYTUwZk07G84KzYB",
      "project_id" : "pjt_3Mh0qqQC3ewFwkyCep0wvf",
      "name" : "XuI8f2r6tc",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ExHexFjJROSEQgaTBUSLq",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "aEexS7crgI",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4640JepWZyMbKlWNfnKIL5",
        "name" : "e8ALsoDzue",
        "email" : "eGQTpQSM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_Bx2ffwZ53t3eNXKigH9Cb",
        "name" : "EB0OyDVsbB",
        "email" : "NbHL73mU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.909304Z",
      "updated_at" : "2026-09-10T07:28:47.909304Z"
    },
    "created_at" : "2026-09-10T07:28:48.216184Z",
    "updated_at" : "2026-09-10T07:28:48.216184Z"
  }
}

Planned Animal [BETA]

planned_animal.created

Triggered when one or more planned animals are created — either directly, or implicitly when a study is created with planned animals attached.

{
  "id" : "whe_7E5H2v4X0hfhqLVmZg9HYZ",
  "client_id" : "fd6ca07c-7036-4b61-bae4-2f5696ef4d77",
  "event" : "planned_animal.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.745450Z",
  "payload" : {
    "id" : "adf_3x2zX4LqcegJ1Ft37ZGOOx",
    "planned_id" : "P-001",
    "strain" : "YD9yxckmwR",
    "species" : "Dr6wnhifyM",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_68rYdZHEJsLnwbOkX7YBci",
    "study" : {
      "id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "project_id" : "pjt_3B0eueeQhNTQi8c8aE969d",
      "name" : "lWtP3zKBFR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_nKwD4H8NGpYWYdPQpVNoI",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "eAcDj2brnr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.602342Z",
      "updated_at" : "2026-09-10T07:28:54.602342Z"
    },
    "study_group" : {
      "id" : "grp_4TRIq5rMkO7aZziTtPiU5W",
      "study_id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "name" : "N6XrK6Dc1z",
      "no" : 1515429843,
      "color" : "#052ea3",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-09-10T07:28:54.621759Z",
      "updated_at" : "2026-09-10T07:28:54.621759Z"
    },
    "created_at" : "2026-09-10T07:28:54.630924Z",
    "updated_at" : "2026-09-10T07:28:54.630924Z"
  }
}

planned_animal.updated

Triggered when one or more planned animals are updated — either directly, or implicitly when animals are mapped to planned animal definitions (manually, during randomization, or when animals are created from planned animal definitions).

{
  "id" : "whe_73PphdQR8JUXz8jUyewOLw",
  "client_id" : "005416ac-8784-409d-80e3-cacede1946ba",
  "event" : "planned_animal.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.747440Z",
  "payload" : {
    "id" : "adf_3x2zX4LqcegJ1Ft37ZGOOx",
    "planned_id" : "P-001",
    "strain" : "YD9yxckmwR",
    "species" : "Dr6wnhifyM",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_68rYdZHEJsLnwbOkX7YBci",
    "study" : {
      "id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "project_id" : "pjt_3B0eueeQhNTQi8c8aE969d",
      "name" : "lWtP3zKBFR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_nKwD4H8NGpYWYdPQpVNoI",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "eAcDj2brnr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.602342Z",
      "updated_at" : "2026-09-10T07:28:54.602342Z"
    },
    "study_group" : {
      "id" : "grp_4TRIq5rMkO7aZziTtPiU5W",
      "study_id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "name" : "N6XrK6Dc1z",
      "no" : 1515429843,
      "color" : "#052ea3",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-09-10T07:28:54.621759Z",
      "updated_at" : "2026-09-10T07:28:54.621759Z"
    },
    "created_at" : "2026-09-10T07:28:54.630924Z",
    "updated_at" : "2026-09-10T07:28:54.630924Z"
  }
}

planned_animal.deleted

Triggered when one or more planned animals are deleted.

{
  "id" : "whe_7I2GZD84aL9a0JUx6zDh0Q",
  "client_id" : "12d2760d-4145-4a17-a5a7-df9e37095a69",
  "event" : "planned_animal.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.748663Z",
  "payload" : {
    "id" : "adf_3x2zX4LqcegJ1Ft37ZGOOx",
    "planned_id" : "P-001",
    "strain" : "YD9yxckmwR",
    "species" : "Dr6wnhifyM",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_68rYdZHEJsLnwbOkX7YBci",
    "study" : {
      "id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "project_id" : "pjt_3B0eueeQhNTQi8c8aE969d",
      "name" : "lWtP3zKBFR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_nKwD4H8NGpYWYdPQpVNoI",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "eAcDj2brnr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : null,
      "owner" : null,
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.602342Z",
      "updated_at" : "2026-09-10T07:28:54.602342Z"
    },
    "study_group" : {
      "id" : "grp_4TRIq5rMkO7aZziTtPiU5W",
      "study_id" : "sdy_2uFswZrFsg1r81OqcDOPw0",
      "name" : "N6XrK6Dc1z",
      "no" : 1515429843,
      "color" : "#052ea3",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-09-10T07:28:54.621759Z",
      "updated_at" : "2026-09-10T07:28:54.621759Z"
    },
    "created_at" : "2026-09-10T07:28:54.630924Z",
    "updated_at" : "2026-09-10T07:28:54.630924Z"
  }
}

Species

species.created

Triggered when a species is created.

{
  "id" : "whe_BvBiJkXi9KCPe3OZ5vYDm",
  "client_id" : "29a1add2-4966-4140-a65d-f1dac19cebda",
  "event" : "species.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.559762Z",
  "payload" : {
    "id" : "spc_2smM98wb01kDrMiieoD8SO",
    "name" : "WtQR6zMEMf",
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.511665Z",
    "updated_at" : "2026-09-10T07:28:54.511665Z"
  }
}

species.updated

Triggered when a species is updated.

{
  "id" : "whe_4OACgidxlWYSL04jpla7F5",
  "client_id" : "5d50afa8-56ff-435a-b0e7-9a73474d7f6d",
  "event" : "species.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.564558Z",
  "payload" : {
    "id" : "spc_2smM98wb01kDrMiieoD8SO",
    "name" : "WtQR6zMEMf",
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.511665Z",
    "updated_at" : "2026-09-10T07:28:54.511665Z"
  }
}

species.deleted

Triggered when a species is deleted.

{
  "id" : "whe_12oPNWq4gEBT5QJmW9ytI5",
  "client_id" : "1741f1cd-fda3-4441-aee6-89972cb9573e",
  "event" : "species.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.565695Z",
  "payload" : {
    "id" : "spc_2smM98wb01kDrMiieoD8SO",
    "name" : "WtQR6zMEMf",
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.511665Z",
    "updated_at" : "2026-09-10T07:28:54.511665Z"
  }
}

Strain

strain.created

Triggered when a strain is created.

{
  "id" : "whe_1HpPIrTGe4w0G9L2lzWxtc",
  "client_id" : "b9df91e2-5ac8-4ba5-b627-30477238795d",
  "event" : "strain.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.111540Z",
  "payload" : {
    "id" : "stn_4enypBCewq79lbsGN6rK1C",
    "name" : "BGhAmS4EXa",
    "species" : {
      "id" : "spc_6Opt1C9loyY0ChsKOSDc7",
      "name" : "jOH19gld9A",
      "active" : true,
      "created_at" : "2026-09-10T07:28:54.061905Z",
      "updated_at" : "2026-09-10T07:28:54.061905Z"
    },
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.063426Z",
    "updated_at" : "2026-09-10T07:28:54.063426Z"
  }
}

strain.updated

Triggered when a strain is updated.

{
  "id" : "whe_39PQa6BArNkHUMSCD5nJJ0",
  "client_id" : "2d1060e5-08ca-4164-b30a-54afe07ca752",
  "event" : "strain.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.113448Z",
  "payload" : {
    "id" : "stn_4enypBCewq79lbsGN6rK1C",
    "name" : "BGhAmS4EXa",
    "species" : {
      "id" : "spc_6Opt1C9loyY0ChsKOSDc7",
      "name" : "jOH19gld9A",
      "active" : true,
      "created_at" : "2026-09-10T07:28:54.061905Z",
      "updated_at" : "2026-09-10T07:28:54.061905Z"
    },
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.063426Z",
    "updated_at" : "2026-09-10T07:28:54.063426Z"
  }
}

strain.deleted

Triggered when a strain is deleted.

{
  "id" : "whe_51PnZBTlQV9DuZVkaY03HB",
  "client_id" : "3d9a96e3-95e9-447f-84ec-46957779bc95",
  "event" : "strain.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:54.114554Z",
  "payload" : {
    "id" : "stn_4enypBCewq79lbsGN6rK1C",
    "name" : "BGhAmS4EXa",
    "species" : {
      "id" : "spc_6Opt1C9loyY0ChsKOSDc7",
      "name" : "jOH19gld9A",
      "active" : true,
      "created_at" : "2026-09-10T07:28:54.061905Z",
      "updated_at" : "2026-09-10T07:28:54.061905Z"
    },
    "active" : true,
    "created_at" : "2026-09-10T07:28:54.063426Z",
    "updated_at" : "2026-09-10T07:28:54.063426Z"
  }
}

Study

study.created

Triggered when a study is created.

{
  "id" : "whe_7MYL20xqHO97f5j4r3TpGZ",
  "client_id" : "7070e58d-6cda-4810-b8a7-b20d101479ef",
  "event" : "study.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.121173Z",
  "payload" : {
    "id" : "sdy_2UsV2LzQOl0Jo7GgRdZ0Dy",
    "name" : "H8jsOnK9FQ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1vZDbiwAur1XWbporzqX7D",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "h3DcpYK1JN",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_f57Wy9ih68kJUNoebvLyY",
      "name" : "lAeViYGpMO",
      "email" : "IAlnOAUp@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_7GERKfcaHN0TOhuKY6TwGW",
      "name" : "pSLaTPi89F",
      "email" : "KabHudc0@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_29sfBtkBIYReQ3PbMfCqFk",
      "name" : "UJhlotALTv",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:28:49.861891Z",
      "updated_at" : "2026-09-10T07:28:49.861891Z"
    },
    "started_on" : "2026-09-10",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:49.870675Z",
    "updated_at" : "2026-09-10T07:28:49.870675Z"
  }
}

study.updated

Triggered when a study is updated.

{
  "id" : "whe_3R6lorfkR0yQFpGdDKHzEP",
  "client_id" : "2a38114b-8d8d-4abd-aeb7-b0cb14b27bb7",
  "event" : "study.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.122699Z",
  "payload" : {
    "id" : "sdy_2UsV2LzQOl0Jo7GgRdZ0Dy",
    "name" : "H8jsOnK9FQ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1vZDbiwAur1XWbporzqX7D",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "h3DcpYK1JN",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_f57Wy9ih68kJUNoebvLyY",
      "name" : "lAeViYGpMO",
      "email" : "IAlnOAUp@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_7GERKfcaHN0TOhuKY6TwGW",
      "name" : "pSLaTPi89F",
      "email" : "KabHudc0@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_29sfBtkBIYReQ3PbMfCqFk",
      "name" : "UJhlotALTv",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:28:49.861891Z",
      "updated_at" : "2026-09-10T07:28:49.861891Z"
    },
    "started_on" : "2026-09-10",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:49.870675Z",
    "updated_at" : "2026-09-10T07:28:49.870675Z"
  }
}

study.deleted

Triggered when a study is deleted.

{
  "id" : "whe_3yZMm5Nnx41JyVtkgISr29",
  "client_id" : "365fde20-fd4d-4cef-8426-95f71146a49c",
  "event" : "study.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.123939Z",
  "payload" : {
    "id" : "sdy_2UsV2LzQOl0Jo7GgRdZ0Dy",
    "name" : "H8jsOnK9FQ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1vZDbiwAur1XWbporzqX7D",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "h3DcpYK1JN",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_f57Wy9ih68kJUNoebvLyY",
      "name" : "lAeViYGpMO",
      "email" : "IAlnOAUp@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_7GERKfcaHN0TOhuKY6TwGW",
      "name" : "pSLaTPi89F",
      "email" : "KabHudc0@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_29sfBtkBIYReQ3PbMfCqFk",
      "name" : "UJhlotALTv",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:28:49.861891Z",
      "updated_at" : "2026-09-10T07:28:49.861891Z"
    },
    "started_on" : "2026-09-10",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:49.870675Z",
    "updated_at" : "2026-09-10T07:28:49.870675Z"
  }
}

study.metadata.updated

Triggered when a study metadata is updated.

{
  "id" : "whe_550JNCFSrpVMjttthGeYxH",
  "client_id" : "a9374f1b-ec33-4a56-a34d-7249ae37af46",
  "event" : "study.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.124986Z",
  "payload" : {
    "id" : "sdy_2UsV2LzQOl0Jo7GgRdZ0Dy",
    "name" : "H8jsOnK9FQ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1vZDbiwAur1XWbporzqX7D",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "h3DcpYK1JN",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_f57Wy9ih68kJUNoebvLyY",
      "name" : "lAeViYGpMO",
      "email" : "IAlnOAUp@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_7GERKfcaHN0TOhuKY6TwGW",
      "name" : "pSLaTPi89F",
      "email" : "KabHudc0@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_29sfBtkBIYReQ3PbMfCqFk",
      "name" : "UJhlotALTv",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-09-10T07:28:49.861891Z",
      "updated_at" : "2026-09-10T07:28:49.861891Z"
    },
    "started_on" : "2026-09-10",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-09-10T07:28:49.870675Z",
    "updated_at" : "2026-09-10T07:28:49.870675Z"
  }
}

Study Group

study.group.created

Triggered when a study group is created.

{
  "id" : "whe_17am4bTljwOMS3258GnHQE",
  "client_id" : "98ece99a-1dcc-41b3-9d69-e7092337a3de",
  "event" : "study.group.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.846319Z",
  "payload" : {
    "id" : "grp_4QralyAmWwGkJkBVJrh9iR",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_7J97EWaCxKVaux8QooSqU",
      "project_id" : "pjt_2OIHpkleXbZfeDGskoJSfx",
      "name" : "n0Sb7e7fd1",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6auUPtQgu9a5ckIxmSoBHc",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yHZ0BGAOMZ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1dXhKbC2dnbtDLLNjg6pr6",
        "name" : "7XoyMlp3R5",
        "email" : "8wUvDDTe@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2ECWetbxSIOZnUz69nG6j",
        "name" : "XOe0LXPpz6",
        "email" : "HknNPc8H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.574476Z",
      "updated_at" : "2026-09-10T07:28:50.574476Z"
    },
    "created_at" : "2026-09-10T07:28:50.792245Z",
    "updated_at" : "2026-09-10T07:28:50.792245Z"
  }
}

study.group.updated

Triggered when a study group is updated.

{
  "id" : "whe_7A2hbyshGicU5EqRGM42nV",
  "client_id" : "b4304b5f-501c-4397-9479-3fe7c97cd91d",
  "event" : "study.group.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.849588Z",
  "payload" : {
    "id" : "grp_4QralyAmWwGkJkBVJrh9iR",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_7J97EWaCxKVaux8QooSqU",
      "project_id" : "pjt_2OIHpkleXbZfeDGskoJSfx",
      "name" : "n0Sb7e7fd1",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6auUPtQgu9a5ckIxmSoBHc",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yHZ0BGAOMZ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1dXhKbC2dnbtDLLNjg6pr6",
        "name" : "7XoyMlp3R5",
        "email" : "8wUvDDTe@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2ECWetbxSIOZnUz69nG6j",
        "name" : "XOe0LXPpz6",
        "email" : "HknNPc8H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.574476Z",
      "updated_at" : "2026-09-10T07:28:50.574476Z"
    },
    "created_at" : "2026-09-10T07:28:50.792245Z",
    "updated_at" : "2026-09-10T07:28:50.792245Z"
  }
}

study.group.deleted

Triggered when a study group is deleted.

{
  "id" : "whe_1g59B0xfsHKw0IxJobEIoI",
  "client_id" : "0421d40d-7c33-4928-9cf0-6d0cdc8c6850",
  "event" : "study.group.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:50.851825Z",
  "payload" : {
    "id" : "grp_4QralyAmWwGkJkBVJrh9iR",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_7J97EWaCxKVaux8QooSqU",
      "project_id" : "pjt_2OIHpkleXbZfeDGskoJSfx",
      "name" : "n0Sb7e7fd1",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6auUPtQgu9a5ckIxmSoBHc",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yHZ0BGAOMZ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1dXhKbC2dnbtDLLNjg6pr6",
        "name" : "7XoyMlp3R5",
        "email" : "8wUvDDTe@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2ECWetbxSIOZnUz69nG6j",
        "name" : "XOe0LXPpz6",
        "email" : "HknNPc8H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.574476Z",
      "updated_at" : "2026-09-10T07:28:50.574476Z"
    },
    "created_at" : "2026-09-10T07:28:50.792245Z",
    "updated_at" : "2026-09-10T07:28:50.792245Z"
  }
}

Study Request

study.request.created

Triggered when a request is created.

{
  "id" : "whe_4uJl8rg2ir0nUzJcHOpSSi",
  "client_id" : "8d9bdf06-7b08-4447-b892-aa61d1a12e44",
  "event" : "study.request.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:47.865097Z",
  "payload" : {
    "id" : "req_1yE7fysdro4EMjB7i4K2pt",
    "user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "assigned_user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "status" : "pending",
    "due_date" : "2026-09-10",
    "groups" : [ {
      "ref" : "mX5ji7OSBJ",
      "label" : "XYgBhfkPyi"
    } ],
    "fields" : [ {
      "group_ref" : "mX5ji7OSBJ",
      "label" : "kOdyYZSC2Y",
      "value" : "RVyatke7yJ",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_3SxBisRNuYWlN4rzCyzPJ0",
      "project_id" : "pjt_4eb8FxpuB63NL6o46nMKo6",
      "name" : "UOtQiRV33x",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_461TWH0yawtlTo2aPbRCgS",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "0Qb3PAdXRo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1rDVC5zHXaV9GF8A6k3fbS",
        "name" : "MYEgffCnqx",
        "email" : "rFfsxsdf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7a61ShiheqAmXHHMLYVuRq",
        "name" : "5zBGtJwgc8",
        "email" : "QI5ljKpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.268417Z",
      "updated_at" : "2026-09-10T07:28:47.268417Z"
    },
    "created_at" : "2026-09-10T07:28:47.778321Z",
    "updated_at" : "2026-09-10T07:28:47.778321Z"
  }
}

study.request.updated

Triggered when a request is updated.

{
  "id" : "whe_4XwijKfbRxdjF4a5mf4qaL",
  "client_id" : "658e3a37-892d-4ec1-bb54-66bea35c74b2",
  "event" : "study.request.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:47.867083Z",
  "payload" : {
    "id" : "req_1yE7fysdro4EMjB7i4K2pt",
    "user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "assigned_user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "status" : "pending",
    "due_date" : "2026-09-10",
    "groups" : [ {
      "ref" : "mX5ji7OSBJ",
      "label" : "XYgBhfkPyi"
    } ],
    "fields" : [ {
      "group_ref" : "mX5ji7OSBJ",
      "label" : "kOdyYZSC2Y",
      "value" : "RVyatke7yJ",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_3SxBisRNuYWlN4rzCyzPJ0",
      "project_id" : "pjt_4eb8FxpuB63NL6o46nMKo6",
      "name" : "UOtQiRV33x",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_461TWH0yawtlTo2aPbRCgS",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "0Qb3PAdXRo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1rDVC5zHXaV9GF8A6k3fbS",
        "name" : "MYEgffCnqx",
        "email" : "rFfsxsdf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7a61ShiheqAmXHHMLYVuRq",
        "name" : "5zBGtJwgc8",
        "email" : "QI5ljKpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.268417Z",
      "updated_at" : "2026-09-10T07:28:47.268417Z"
    },
    "created_at" : "2026-09-10T07:28:47.778321Z",
    "updated_at" : "2026-09-10T07:28:47.778321Z"
  }
}

study.request.deleted

Triggered when a request is deleted.

{
  "id" : "whe_1rw7Pr5w2OCFpG14tE1fb8",
  "client_id" : "475e8f23-e989-4d4f-bd73-3457d592a39e",
  "event" : "study.request.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:47.868559Z",
  "payload" : {
    "id" : "req_1yE7fysdro4EMjB7i4K2pt",
    "user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "assigned_user_id" : "usr_4WwanV2KjXPDPxoYxQrTYY",
    "status" : "pending",
    "due_date" : "2026-09-10",
    "groups" : [ {
      "ref" : "mX5ji7OSBJ",
      "label" : "XYgBhfkPyi"
    } ],
    "fields" : [ {
      "group_ref" : "mX5ji7OSBJ",
      "label" : "kOdyYZSC2Y",
      "value" : "RVyatke7yJ",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_3SxBisRNuYWlN4rzCyzPJ0",
      "project_id" : "pjt_4eb8FxpuB63NL6o46nMKo6",
      "name" : "UOtQiRV33x",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_461TWH0yawtlTo2aPbRCgS",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "0Qb3PAdXRo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1rDVC5zHXaV9GF8A6k3fbS",
        "name" : "MYEgffCnqx",
        "email" : "rFfsxsdf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7a61ShiheqAmXHHMLYVuRq",
        "name" : "5zBGtJwgc8",
        "email" : "QI5ljKpQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:47.268417Z",
      "updated_at" : "2026-09-10T07:28:47.268417Z"
    },
    "created_at" : "2026-09-10T07:28:47.778321Z",
    "updated_at" : "2026-09-10T07:28:47.778321Z"
  }
}

Study Sample Plan [BETA]

study.sample_definition.created

Triggered when a sample plan definition is created.

{
  "id" : "whe_1JtpFCtWtfH9DsXvKUcmEe",
  "client_id" : "95827785-04d4-42e7-baed-782e49af2813",
  "event" : "study.sample_definition.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.027585Z",
  "payload" : {
    "id" : "sdf_4TwNcGxBZ81ouOuc5YHJcg",
    "sample_type" : {
      "team_glossary_id" : "tgy_6swKJFq1jDMBAWu9V6oHEA",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1LmWQOmwrW0SogtNq5rNvF",
      "project_id" : "pjt_16j1WwRJzNYeGe9HcD9mr0",
      "name" : "VeNfogDNGe",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_66rixHMEAArFYrs3nw75Kr",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "a4mOp29YZP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6rQqh5Pid1upUiTZTvqAal",
        "name" : "dEswprflcJ",
        "email" : "lXs2Y2ax@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6FlsxphFa4t0wLZRw0o107",
        "name" : "dvkP3bpCue",
        "email" : "OX965A9D@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:48.719409Z",
      "updated_at" : "2026-09-10T07:28:48.719409Z"
    },
    "created_at" : "2026-09-10T07:28:48.952171Z",
    "updated_at" : "2026-09-10T07:28:48.952171Z"
  }
}

study.sample_definition.updated

Triggered when a sample plan definition is updated.

{
  "id" : "whe_310VjaOIvxpfHJNDItxTDE",
  "client_id" : "0e086f7a-13c0-45c5-871a-7595d8de1a6b",
  "event" : "study.sample_definition.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.029522Z",
  "payload" : {
    "id" : "sdf_4TwNcGxBZ81ouOuc5YHJcg",
    "sample_type" : {
      "team_glossary_id" : "tgy_6swKJFq1jDMBAWu9V6oHEA",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1LmWQOmwrW0SogtNq5rNvF",
      "project_id" : "pjt_16j1WwRJzNYeGe9HcD9mr0",
      "name" : "VeNfogDNGe",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_66rixHMEAArFYrs3nw75Kr",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "a4mOp29YZP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6rQqh5Pid1upUiTZTvqAal",
        "name" : "dEswprflcJ",
        "email" : "lXs2Y2ax@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6FlsxphFa4t0wLZRw0o107",
        "name" : "dvkP3bpCue",
        "email" : "OX965A9D@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:48.719409Z",
      "updated_at" : "2026-09-10T07:28:48.719409Z"
    },
    "created_at" : "2026-09-10T07:28:48.952171Z",
    "updated_at" : "2026-09-10T07:28:48.952171Z"
  }
}

study.sample_definition.deleted

Triggered when a sample plan definition is deleted.

{
  "id" : "whe_3jUCHU3lzVpfSgYE1PE2w8",
  "client_id" : "d59a7028-5858-45de-9d18-2bd894abd49e",
  "event" : "study.sample_definition.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.031299Z",
  "payload" : {
    "id" : "sdf_4TwNcGxBZ81ouOuc5YHJcg",
    "sample_type" : {
      "team_glossary_id" : "tgy_6swKJFq1jDMBAWu9V6oHEA",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1LmWQOmwrW0SogtNq5rNvF",
      "project_id" : "pjt_16j1WwRJzNYeGe9HcD9mr0",
      "name" : "VeNfogDNGe",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_66rixHMEAArFYrs3nw75Kr",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "a4mOp29YZP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6rQqh5Pid1upUiTZTvqAal",
        "name" : "dEswprflcJ",
        "email" : "lXs2Y2ax@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6FlsxphFa4t0wLZRw0o107",
        "name" : "dvkP3bpCue",
        "email" : "OX965A9D@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:48.719409Z",
      "updated_at" : "2026-09-10T07:28:48.719409Z"
    },
    "created_at" : "2026-09-10T07:28:48.952171Z",
    "updated_at" : "2026-09-10T07:28:48.952171Z"
  }
}

Study Task Spec

study.task_spec.created

Triggered when a study task spec is created.

{
  "id" : "whe_193kBW0Oqp8UapbDYxVuiv",
  "client_id" : "028585c3-cb30-45d1-a3fe-ac8a18ac80f9",
  "event" : "study.task_spec.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.320913Z",
  "payload" : {
    "id" : "tsp_6ZpRFeGexnyXRbdHpIQroz",
    "title" : "UKvcnpPh2P Task",
    "description" : "sLpugIh4HH Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-09-10",
          "end" : "2026-09-11"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_3v5nFur7pe0jYpJZNHOGwv",
      "project_id" : "pjt_2H2i2fm79aRW9L5uGiscW3",
      "name" : "wVg1hgVs0W",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3hQsGQnjesyiM6iNAag9hw",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yGtaeOIaUx",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7j9CAcXHZgvmAG3KXs2nGU",
        "name" : "odjQtPd5IZ",
        "email" : "wR7yfcmj@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3bIY9y7OwyKjOnur5ISU4E",
        "name" : "pa6cFn5KwS",
        "email" : "uWGzWspk@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.874467Z",
      "updated_at" : "2026-09-10T07:28:50.874467Z"
    },
    "created_at" : "2026-09-10T07:28:51.252353Z",
    "updated_at" : "2026-09-10T07:28:51.252353Z"
  }
}

study.task_spec.updated

Triggered when a study task spec is updated.

{
  "id" : "whe_2NThZaOEG5WnKLCBTIdB2r",
  "client_id" : "4ff9230c-976a-43fb-ad3f-bc75c0785994",
  "event" : "study.task_spec.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.324582Z",
  "payload" : {
    "id" : "tsp_6ZpRFeGexnyXRbdHpIQroz",
    "title" : "UKvcnpPh2P Task",
    "description" : "sLpugIh4HH Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-09-10",
          "end" : "2026-09-11"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_3v5nFur7pe0jYpJZNHOGwv",
      "project_id" : "pjt_2H2i2fm79aRW9L5uGiscW3",
      "name" : "wVg1hgVs0W",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3hQsGQnjesyiM6iNAag9hw",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yGtaeOIaUx",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7j9CAcXHZgvmAG3KXs2nGU",
        "name" : "odjQtPd5IZ",
        "email" : "wR7yfcmj@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3bIY9y7OwyKjOnur5ISU4E",
        "name" : "pa6cFn5KwS",
        "email" : "uWGzWspk@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.874467Z",
      "updated_at" : "2026-09-10T07:28:50.874467Z"
    },
    "created_at" : "2026-09-10T07:28:51.252353Z",
    "updated_at" : "2026-09-10T07:28:51.252353Z"
  }
}

study.task_spec.deleted

Triggered when a study task spec is deleted.

{
  "id" : "whe_6bwqLgmxHx7EgZnzR3bhgt",
  "client_id" : "22106524-1233-4a0c-ac4f-8fdd365012e2",
  "event" : "study.task_spec.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:51.327910Z",
  "payload" : {
    "id" : "tsp_6ZpRFeGexnyXRbdHpIQroz",
    "title" : "UKvcnpPh2P Task",
    "description" : "sLpugIh4HH Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-09-10",
          "end" : "2026-09-11"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_3v5nFur7pe0jYpJZNHOGwv",
      "project_id" : "pjt_2H2i2fm79aRW9L5uGiscW3",
      "name" : "wVg1hgVs0W",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3hQsGQnjesyiM6iNAag9hw",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "yGtaeOIaUx",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7j9CAcXHZgvmAG3KXs2nGU",
        "name" : "odjQtPd5IZ",
        "email" : "wR7yfcmj@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3bIY9y7OwyKjOnur5ISU4E",
        "name" : "pa6cFn5KwS",
        "email" : "uWGzWspk@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:50.874467Z",
      "updated_at" : "2026-09-10T07:28:50.874467Z"
    },
    "created_at" : "2026-09-10T07:28:51.252353Z",
    "updated_at" : "2026-09-10T07:28:51.252353Z"
  }
}

Study Treatment

study.treatment.created

Triggered when a treatment is created.

{
  "id" : "whe_3YFEqgrcT3CYfgVtj1vUSu",
  "client_id" : "6ad5d2cf-6dd0-45f2-bc37-2ab3dfb25580",
  "event" : "study.treatment.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.610912Z",
  "payload" : {
    "id" : "tmt_3K54IThp2HtAzRiIWDoNGP",
    "type" : "concentration_vgkg",
    "name" : "OGRtfJVobP",
    "label" : "Test Treatment Label",
    "external_entity_id" : "tLaxq7ijfd",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "study" : {
      "id" : "sdy_HuaAf4HuHWekF0XJKyOxU",
      "project_id" : "pjt_3qTmhxURdt4jjR6BQHVBLS",
      "name" : "9KENfxAZJR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1I2bnQHLopteCAjpbpIJ14",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "4nrIbz9w9h",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_T6ZUNP53KmoydN9PVe1iG",
        "name" : "Euz539UshR",
        "email" : "eqo53YPp@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7hT0wnb6nGhd6O0dQC5inv",
        "name" : "0ECe7Z5Ns5",
        "email" : "B4kq5eFO@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:53.022946Z",
      "updated_at" : "2026-09-10T07:28:53.022946Z"
    },
    "created_at" : "2026-09-10T07:28:53.537374Z",
    "updated_at" : "2026-09-10T07:28:53.537374Z"
  }
}

study.treatment.updated

Triggered when a treatment is updated.

{
  "id" : "whe_2LkD88jvvgjll9QlpWDFqI",
  "client_id" : "17b7e2ea-924c-472f-b2f5-cd7ab559f670",
  "event" : "study.treatment.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.615753Z",
  "payload" : {
    "id" : "tmt_3K54IThp2HtAzRiIWDoNGP",
    "type" : "concentration_vgkg",
    "name" : "OGRtfJVobP",
    "label" : "Test Treatment Label",
    "external_entity_id" : "tLaxq7ijfd",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "study" : {
      "id" : "sdy_HuaAf4HuHWekF0XJKyOxU",
      "project_id" : "pjt_3qTmhxURdt4jjR6BQHVBLS",
      "name" : "9KENfxAZJR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1I2bnQHLopteCAjpbpIJ14",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "4nrIbz9w9h",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_T6ZUNP53KmoydN9PVe1iG",
        "name" : "Euz539UshR",
        "email" : "eqo53YPp@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7hT0wnb6nGhd6O0dQC5inv",
        "name" : "0ECe7Z5Ns5",
        "email" : "B4kq5eFO@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:53.022946Z",
      "updated_at" : "2026-09-10T07:28:53.022946Z"
    },
    "created_at" : "2026-09-10T07:28:53.537374Z",
    "updated_at" : "2026-09-10T07:28:53.537374Z"
  }
}

study.treatment.deleted

Triggered when a treatment is deleted.

{
  "id" : "whe_6drXxiWKrwn59RJjbF1Ggs",
  "client_id" : "a37aa65d-65a3-46f2-bb9b-f4585a19eacc",
  "event" : "study.treatment.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.619287Z",
  "payload" : {
    "id" : "tmt_3K54IThp2HtAzRiIWDoNGP",
    "type" : "concentration_vgkg",
    "name" : "OGRtfJVobP",
    "label" : "Test Treatment Label",
    "external_entity_id" : "tLaxq7ijfd",
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5",
      "display_unit" : "mg/kg",
      "display_value" : "5"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15",
      "display_unit" : "ml/kg",
      "display_value" : "15"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "10",
      "display_unit" : "mg/ml",
      "display_value" : "10"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "8",
      "display_unit" : "µL",
      "display_value" : "8"
    },
    "metadata" : {
      "treatment-internal-id" : "TREATMENT-1234"
    },
    "study" : {
      "id" : "sdy_HuaAf4HuHWekF0XJKyOxU",
      "project_id" : "pjt_3qTmhxURdt4jjR6BQHVBLS",
      "name" : "9KENfxAZJR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1I2bnQHLopteCAjpbpIJ14",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "4nrIbz9w9h",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_T6ZUNP53KmoydN9PVe1iG",
        "name" : "Euz539UshR",
        "email" : "eqo53YPp@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7hT0wnb6nGhd6O0dQC5inv",
        "name" : "0ECe7Z5Ns5",
        "email" : "B4kq5eFO@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:53.022946Z",
      "updated_at" : "2026-09-10T07:28:53.022946Z"
    },
    "created_at" : "2026-09-10T07:28:53.537374Z",
    "updated_at" : "2026-09-10T07:28:53.537374Z"
  }
}

study.treatment.assigned

Triggered when a treatment is assigned to a study group.

{
  "id" : "whe_MWVe0ULSv4bDb3vOQOoiJ",
  "client_id" : "196baa40-1b43-4d21-b67b-cb6d1b458e61",
  "event" : "study.treatment.assigned",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:52.398701Z",
  "payload" : {
    "treatment" : {
      "id" : "tmt_1K47MeZcCmU12UDs4KCCLA",
      "type" : "volume",
      "name" : "GFJBYt1tpp",
      "label" : "Test Treatment Label",
      "external_entity_id" : "OIOMjlJPYe",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "study" : {
        "id" : "sdy_4IjgALguygh8qJidgCxeXn",
        "project_id" : "pjt_58N9WB35iVN50fZpFgc95b",
        "name" : "H7BP3rOBIM",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_5KR98pCR8ZHPr86BhWtq5S",
        "type" : "internal",
        "started_on" : "2026-09-10",
        "status" : "in_progress",
        "description" : "WUYTKiXaBL",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_2uiU2RZerDpe8LFaQhQRlo",
          "name" : "SmTXl2jYLE",
          "email" : "yKQnxx60@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_29qeJokG5ON4qnpoY3huLo",
          "name" : "XyBOJ5gd40",
          "email" : "JTzsQ2Xi@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-09-10T07:28:52.059141Z",
        "updated_at" : "2026-09-10T07:28:52.059141Z"
      },
      "created_at" : "2026-09-10T07:28:52.273380Z",
      "updated_at" : "2026-09-10T07:28:52.273380Z"
    },
    "study_group" : {
      "id" : "grp_6uIu892du8A6dgT4Cxb6Yc",
      "name" : "pprmXqv5xV",
      "no" : 1370099042,
      "color" : "#ba6734",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_4IjgALguygh8qJidgCxeXn",
        "project_id" : "pjt_58N9WB35iVN50fZpFgc95b",
        "name" : "H7BP3rOBIM",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_5KR98pCR8ZHPr86BhWtq5S",
        "type" : "internal",
        "started_on" : "2026-09-10",
        "status" : "in_progress",
        "description" : "WUYTKiXaBL",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_2uiU2RZerDpe8LFaQhQRlo",
          "name" : "SmTXl2jYLE",
          "email" : "yKQnxx60@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_29qeJokG5ON4qnpoY3huLo",
          "name" : "XyBOJ5gd40",
          "email" : "JTzsQ2Xi@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-09-10T07:28:52.059141Z",
        "updated_at" : "2026-09-10T07:28:52.059141Z"
      },
      "created_at" : "2026-09-10T07:28:52.259991Z",
      "updated_at" : "2026-09-10T07:28:52.259991Z"
    }
  }
}

study.treatment.unassigned

Triggered when a treatment is unassigned from a study group.

{
  "id" : "whe_6zDLExRsK9uDZAWxpXOhxY",
  "client_id" : "3ec32396-710a-4271-a6ae-4f1cd76d6a94",
  "event" : "study.treatment.unassigned",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:52.401518Z",
  "payload" : {
    "treatment" : {
      "id" : "tmt_1K47MeZcCmU12UDs4KCCLA",
      "type" : "volume",
      "name" : "GFJBYt1tpp",
      "label" : "Test Treatment Label",
      "external_entity_id" : "OIOMjlJPYe",
      "dose" : {
        "unit" : "mg/kg",
        "value" : "5",
        "display_unit" : "mg/kg",
        "display_value" : "5"
      },
      "dose_volume" : {
        "unit" : "ml/kg",
        "value" : "15",
        "display_unit" : "ml/kg",
        "display_value" : "15"
      },
      "stock" : {
        "unit" : "mg/ml",
        "value" : "10",
        "display_unit" : "mg/ml",
        "display_value" : "10"
      },
      "volume" : {
        "unit" : "µL",
        "value" : "8",
        "display_unit" : "µL",
        "display_value" : "8"
      },
      "metadata" : {
        "treatment-internal-id" : "TREATMENT-1234"
      },
      "study" : {
        "id" : "sdy_4IjgALguygh8qJidgCxeXn",
        "project_id" : "pjt_58N9WB35iVN50fZpFgc95b",
        "name" : "H7BP3rOBIM",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_5KR98pCR8ZHPr86BhWtq5S",
        "type" : "internal",
        "started_on" : "2026-09-10",
        "status" : "in_progress",
        "description" : "WUYTKiXaBL",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_2uiU2RZerDpe8LFaQhQRlo",
          "name" : "SmTXl2jYLE",
          "email" : "yKQnxx60@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_29qeJokG5ON4qnpoY3huLo",
          "name" : "XyBOJ5gd40",
          "email" : "JTzsQ2Xi@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-09-10T07:28:52.059141Z",
        "updated_at" : "2026-09-10T07:28:52.059141Z"
      },
      "created_at" : "2026-09-10T07:28:52.273380Z",
      "updated_at" : "2026-09-10T07:28:52.273380Z"
    },
    "study_group" : {
      "id" : "grp_6uIu892du8A6dgT4Cxb6Yc",
      "name" : "pprmXqv5xV",
      "no" : 1370099042,
      "color" : "#ba6734",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_4IjgALguygh8qJidgCxeXn",
        "project_id" : "pjt_58N9WB35iVN50fZpFgc95b",
        "name" : "H7BP3rOBIM",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_5KR98pCR8ZHPr86BhWtq5S",
        "type" : "internal",
        "started_on" : "2026-09-10",
        "status" : "in_progress",
        "description" : "WUYTKiXaBL",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_2uiU2RZerDpe8LFaQhQRlo",
          "name" : "SmTXl2jYLE",
          "email" : "yKQnxx60@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_29qeJokG5ON4qnpoY3huLo",
          "name" : "XyBOJ5gd40",
          "email" : "JTzsQ2Xi@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-09-10T07:28:52.059141Z",
        "updated_at" : "2026-09-10T07:28:52.059141Z"
      },
      "created_at" : "2026-09-10T07:28:52.259991Z",
      "updated_at" : "2026-09-10T07:28:52.259991Z"
    }
  }
}

Study User

study.user.created

Triggered when a study user is created.

{
  "id" : "whe_4LNJfivjLcKLSxbfTlH0ES",
  "client_id" : "bf1a7470-b62d-4d5d-8204-0df4fbe5e465",
  "event" : "study.user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.303212Z",
  "payload" : {
    "id" : "usr_20uNPNKM78YaRvUzuHahuS",
    "name" : "zAfccl6J7Y",
    "email" : "bVJjkfDK@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_5DC3yu4K7nggmeRmyaJWnO",
      "project_id" : "pjt_2xc8RAh3vgy5lrS9av91MD",
      "name" : "hsmzvrOcrQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3daaIrLjkcGYRXCMLGwyRY",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "wl2XmxU1o3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_20uNPNKM78YaRvUzuHahuS",
        "name" : "zAfccl6J7Y",
        "email" : "bVJjkfDK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1CwZmjXb3GyUIXxRUeq9Xp",
        "name" : "LzemHEbsqe",
        "email" : "fCTbah4G@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.774828Z",
      "updated_at" : "2026-09-10T07:28:54.774828Z"
    }
  }
}

study.user.updated

Triggered when a study user is updated.

{
  "id" : "whe_44g36IyRRn3KGXZpavLmSf",
  "client_id" : "bb612eb0-6f5b-4530-a623-feeb50630446",
  "event" : "study.user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.309328Z",
  "payload" : {
    "id" : "usr_20uNPNKM78YaRvUzuHahuS",
    "name" : "zAfccl6J7Y",
    "email" : "bVJjkfDK@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_5DC3yu4K7nggmeRmyaJWnO",
      "project_id" : "pjt_2xc8RAh3vgy5lrS9av91MD",
      "name" : "hsmzvrOcrQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3daaIrLjkcGYRXCMLGwyRY",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "wl2XmxU1o3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_20uNPNKM78YaRvUzuHahuS",
        "name" : "zAfccl6J7Y",
        "email" : "bVJjkfDK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1CwZmjXb3GyUIXxRUeq9Xp",
        "name" : "LzemHEbsqe",
        "email" : "fCTbah4G@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.774828Z",
      "updated_at" : "2026-09-10T07:28:54.774828Z"
    }
  }
}

study.user.deleted

Triggered when a study user is deleted.

{
  "id" : "whe_3LTLfjOBbVdmaAOHh6hXc0",
  "client_id" : "e0da36f2-b3d5-43d0-acfe-2a675796622d",
  "event" : "study.user.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.311165Z",
  "payload" : {
    "id" : "usr_20uNPNKM78YaRvUzuHahuS",
    "name" : "zAfccl6J7Y",
    "email" : "bVJjkfDK@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_5DC3yu4K7nggmeRmyaJWnO",
      "project_id" : "pjt_2xc8RAh3vgy5lrS9av91MD",
      "name" : "hsmzvrOcrQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3daaIrLjkcGYRXCMLGwyRY",
      "type" : "internal",
      "started_on" : "2026-09-10",
      "status" : "in_progress",
      "description" : "wl2XmxU1o3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_20uNPNKM78YaRvUzuHahuS",
        "name" : "zAfccl6J7Y",
        "email" : "bVJjkfDK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1CwZmjXb3GyUIXxRUeq9Xp",
        "name" : "LzemHEbsqe",
        "email" : "fCTbah4G@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-09-10T07:28:54.774828Z",
      "updated_at" : "2026-09-10T07:28:54.774828Z"
    }
  }
}

Team Glossary Observation [BETA]

team.glossary_observation.created

Triggered when a team glossary observation is created.

{
  "id" : "whe_50kk8KHOQaFOtVoroxAf9r",
  "client_id" : "e9a71507-6aa2-42c9-9c13-e9b12df4b0fe",
  "event" : "team.glossary_observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.691668Z",
  "payload" : {
    "id" : "tgy_4XIvGDAk9PRKgvhxC286Ta",
    "title" : "Numeric Glossary",
    "label" : "NUM",
    "description" : "0 = it is ok",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "6"
    }
  }
}

team.glossary_observation.updated

Triggered when a team glossary observation is updated.

{
  "id" : "whe_6lhfcJ6jdmxGEN2H85CYYN",
  "client_id" : "c381cabd-6e27-4067-850b-816bd40faff4",
  "event" : "team.glossary_observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.693625Z",
  "payload" : {
    "id" : "tgy_4XIvGDAk9PRKgvhxC286Ta",
    "title" : "Numeric Glossary",
    "label" : "NUM",
    "description" : "0 = it is ok",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "6"
    }
  }
}

team.glossary_observation.deleted

Triggered when a team glossary observation is deleted.

{
  "id" : "whe_4eTgalJ3aduRHzFMiGzZ8P",
  "client_id" : "2df678d7-f721-4563-bee8-1937ad76cba8",
  "event" : "team.glossary_observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:53.695814Z",
  "payload" : {
    "id" : "tgy_4XIvGDAk9PRKgvhxC286Ta",
    "title" : "Numeric Glossary",
    "label" : "NUM",
    "description" : "0 = it is ok",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "6"
    }
  }
}

Team Glossary Sample [BETA]

team.glossary_sample.created

Triggered when a team glossary sample is created.

{
  "id" : "whe_6ZO89gb4Da0Ucn1eDNWIHL",
  "client_id" : "1f393006-d35f-4f6e-9590-a97f1f4c087d",
  "event" : "team.glossary_sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.825944Z",
  "payload" : {
    "id" : "tgy_7TErd0JDymw1LUPnx88Y6c",
    "title" : "Whole Blood",
    "label" : "WB",
    "description" : "Whole Blood for analysis",
    "status" : "active",
    "details" : [ "workflow" ]
  }
}

team.glossary_sample.updated

Triggered when a team glossary sample is updated.

{
  "id" : "whe_3EFrzCT9efBOuWyQZaOOwH",
  "client_id" : "fbe0a93f-8a58-429c-8571-92e7ea10c404",
  "event" : "team.glossary_sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.831362Z",
  "payload" : {
    "id" : "tgy_7TErd0JDymw1LUPnx88Y6c",
    "title" : "Whole Blood",
    "label" : "WB",
    "description" : "Whole Blood for analysis",
    "status" : "active",
    "details" : [ "workflow" ]
  }
}

team.glossary_sample.deleted

Triggered when a team glossary sample is deleted.

{
  "id" : "whe_10859rh1q6iccOOsBA6v6x",
  "client_id" : "55aedbb3-13d6-40a5-af60-cce0582ccf7a",
  "event" : "team.glossary_sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:49.832501Z",
  "payload" : {
    "id" : "tgy_7TErd0JDymw1LUPnx88Y6c",
    "title" : "Whole Blood",
    "label" : "WB",
    "description" : "Whole Blood for analysis",
    "status" : "active",
    "details" : [ "workflow" ]
  }
}

User

user.created

Triggered when a user is created on a team.

{
  "id" : "whe_4UOYhtZ2HaGoh9vEd4PzSU",
  "client_id" : "8c8d1398-b8eb-4bfb-ae85-422cd471ce14",
  "event" : "user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.540789Z",
  "payload" : {
    "id" : "usr_5A6oGQBlsXVDydmjdCMjzq",
    "name" : "yS7a1 Overwatch",
    "email" : "CEOykScY@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:28:55.478982Z",
    "updated_at" : "2026-09-10T07:28:55.478982Z"
  }
}

user.updated

Triggered when a user is updated on a team.

{
  "id" : "whe_4esbpcaIsxkSQS4ACriCHJ",
  "client_id" : "4840c292-a037-4e7d-be78-8609674582cc",
  "event" : "user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-09-10T07:28:55.546565Z",
  "payload" : {
    "id" : "usr_5A6oGQBlsXVDydmjdCMjzq",
    "name" : "yS7a1 Overwatch",
    "email" : "CEOykScY@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-09-10T07:28:55.478982Z",
    "updated_at" : "2026-09-10T07:28:55.478982Z"
  }
}