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" : "ccd30269-adf7-4666-b89a-67447fbc08b8",
  "client_secret" : "9B4UNJsjyAGa3SBjpcXsQWkV3LcVdKgmr57L37mk"
}

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
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: 1124

{
  "token_type" : "Bearer",
  "expires_in" : 86400,
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjY2QzMDI2OS1hZGY3LTQ2NjYtYjg5YS02NzQ0N2ZiYzA4YjgiLCJqdGkiOiI2NzVkODNmNS05ZmNiLTQ0Y2UtYTZjYy1iNDQ0Njk3N2EzNDgiLCJpYXQiOjE3ODcwNjM3NzgsIm5iZiI6MTc4NzA2Mzc3OCwiZXhwIjoxNzg3MTUwMTc4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVGV1R5YzN1dFRPWFIyeHJwQ21OZjIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.k5dfnQPAndhW0Z4CmYS2-zV6z_2frJ0f3xVt5ahpIdg22sjyHJTYvsolWnOGPfsKdohVofUyoz8Ozex9axhWe56jPn6o9y87g6yZJ-ll9gwayu7PKsLfqJe5EIKocDEI7zrQCq6EjEgAB-NiLQBwDQ3kgtXdeL37KVWRSwdETJyse6JCZIBwSLLBxionzYGDsrpN-Kz-VKPajPoLnrWTwS84vWE8kvEVGCexyrdsTp3vee38WHQqKXvvROeTGdUnnvuWMkpCbNE0OUA-bfxUKmFSRn75pqeSBfUNa3Ge-9RlCBBD8dni-NWmOBCWedUIqXXvpL9OO-v4cvF0as28WzR0eptwGmkzh7FxmaC1OwlKV2oeiMmVUHP4D97n4FUMiWLAcVrWyM7xvxlaSYhBhbo_GvR0_sbyfOiaJKMsRNzXAvwuy87FoKsLYf9yxyyRGKmhb1_dn4o6PbSPsETF2AhrGPJcbu1E6trhAoAkuxjLKrjSlLWd6TQPJhV6XAhlXqct3SJhXELcyOR_DeEfez3bML1aMlPNKeTsjJfpX3nz2L37cYD6fFpAc2ytZh8hIaepIeSJ4qtxY8_ojy6dem1stIjpyksCWPhFG6syt_WxRak4677JKPZMdDVtrGDtJWNtv-wl9kOiQUv8CFpo0DGjTrJbq9qj_VVTIJily8M"
}

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_5xqXnwPw9V5rCTEKA1j6iR HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZDg3Yjg5MC1lZGNmLTQ2YjItODA4OC00YzQxM2MyNzg3ZTAiLCJqdGkiOiJmODM0NTBlMi0zZGFmLTQzODYtODJjYy1hY2IwNWE0MjM5OGMiLCJpYXQiOjE3ODcwNjM3NTEsIm5iZiI6MTc4NzA2Mzc1MSwiZXhwIjoxNzg3MTUwMTUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJFaFVFT1lDZU1jc3c1VTNPQ01CWVAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.CPYXRsCof-EiOD18hUifwDf6q8JTefMToS8gi1ttrfc2cRputFNP7sJ3d7hsReoYhhnMAGjWPB3alETv5Yz-Mmt-karswXv5hxcjbYyPy4aRQCQPFWgncY0rjtNAtP5Y_7ZTUzafsevtlIjy1zjsRoy8Ajy6_fnmY8TYvzs8heZSaLYNW0eP_HjFkFS4nmxS_GIhWsAjc4Cqtxqjo-vEyA9hwa-t85dGeGrw3s7pA6IfNBEV6XLhzrhlXfyAewXdGdgsgBGWJGqsMe1pGOuukihIpDXMnoZG2bS9K_yfv7GSplpeJqIBX8A3f2NTV2fXWJMnYxJ7_SWqrnUzHp8XFLtznqqOpu9JiDSTvUwe2HVuDc_WXhUAiNup-O9ieG19D2KlFgZfL1VNNsxLeUPiQvifV7o4gnlMGg5lMT3KVYNlzbjkIiT8A9BrW4Eor91juNV42kX3Hsx7y_-MfvvAVdaJanWsbkSaNovKs8ShIU1NAKdHdJCJQVKuwl8n23nfkDS0CPDPW2Aof_o-jWSsRHu1Cq_PERQAbvyOT0Zq6o8VTMK6wseS2M3pltTxZ2m_kUVKTZZ31wid9qqhpF48b_RPHv76XpoZoUsxyokkDaK0u8YofXbTFRMJmDQSb5n5mD_T-PTtUthR-83qRDqqK_B7j6X4OgJSyhVAb2yb_As
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: 100

{
  "id" : "gly_5xqXnwPw9V5rCTEKA1j6iR",
  "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.eyJhdWQiOiI4NWQxMzgwOS04NDU0LTQ0NjItOGMwNy1jYmFiMTc1YzEyZDMiLCJqdGkiOiIyMGMzMDA2OC04OTBkLTQ5MjctODNiYS1jN2I2MzAwOGY5YTMiLCJpYXQiOjE3ODcwNjM3NDUsIm5iZiI6MTc4NzA2Mzc0NSwiZXhwIjoxNzg3MTUwMTQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFsb3lnN2Z1bGh3RFdWbEUyalhybkkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.P22WlBoU3vK2hOZKiXH6N78tt7guhTkt3uiC14ST7VaJadzO71X8iGoOEZ66P528Wohy1w9Fm_vPCIy7ojWZbf8Dmm8SlmwHKaGR_Phy_ikzj-6dpDu4a1QiSdIbAYRFZjMNeXnBLMeuEfZ1_-VxIi5hdZdzfJVI-maY6k94SOnKS7r0yHli8DKQFAhjNjNT42jCvws8N2Tazmp5mCNAJJYIAb6KJSko-Wp6avWAN-FIqTfGQ4kHiH7KaACDf8OOx21-wrdRlsQia_PMd5NFa5lLa1JRSY3zvDrHp_WSlIHG4o8qGZraoQdQr2Dbi_lyd5tCdFPMoEJ1XGCF7EZXZfpS0jGFTaWhYhrWz3AkQZ9aP-NQip3sqzVyyIU_t6ilBDR93NBve_fDaWG8n1Ug64LqIn3o_4OULvZFbBehyYNQZctQE3Zf-gkqDTCP0vrlXnJntE5CCy6NDCjYz6JYXbOzeq3riwTm0Xz1JkEdSIC1dU1fc52cRpSrHqsS67tA-_HvnWNaAiFn7JfOqDuEEUDB8MMuhljrzHy_DuMJjicMVsnidWn7eY6n37lFlP75tUICjL_mQkjPPBO8erHspSXTvTXG-wSJKfPCl-ns6uKuzbNc7axfj0ugiPee4F6Ew5q1eIGCQYd9GXY_wfjZy__WfBRgzxOxVse665hbgzI
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: 511

{
  "data" : [ {
    "id" : "gly_4l8FNifYroRWjIXEyNHBWJ",
    "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.eyJhdWQiOiJkNThkZjM0OS0wMTY2LTRmOGYtOTgxOC1mYTkzMmVlYTZkZWMiLCJqdGkiOiI1M2NhYzFiMy01ZDI3LTQ0MGEtOTE0ZC1iMTQ2MWJmMmU1OWYiLCJpYXQiOjE3ODcwNjM4MTksIm5iZiI6MTc4NzA2MzgxOSwiZXhwIjoxNzg3MTUwMjE5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFmcjdwWGt1VXY3bWlaYlIzZUVMU3AiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.BCDPAMIQHOWZQn_zqt7eXshSmOKq20fcKip8BLlZk62nOfytAIrRyFO2_IaGP40hIvv5imPcbl5yAcGzQn3JKLiaa-1zOkFm-1pCyIu3T0HMbXKyln8DaCvhPNnxh2i9-OhUbW94-oiotuB0K_V5R5mo--cwDZZjTwYRHArlNoB8shQ9MzpsOZXA3tTP0pIb9Qzch7G4kVFVde6qSV6nNNHaxJ2i0oZsn241-JyJebna9p-1q1WGRbvwb7y69GvdcoatyVz-VsIOLXuTO44GvhcdcxGLn-iNPWKLixTuBVvLYRrrLHGCBSi5x7w3JAWEzb07UPJWaWz_lcNk8UtdFxvzni8nLASsszqx6XJkqsIOd7yGVouX8LAQyNldGOQwCAsbEjBagI9E4ba1wgsz2khQMPh_Y2HwFH-IOu3oLRtWV6DaO9CQhkeemEkl3laMyAsrO8przH5XYcqmXHqvGmvvurfYbw6uW3_cjXVUI2-15DDAvF57x5OpOslcGYNKaidqszQ9roeV9VzcZ06bCWpofJKkyPNFSSShWp4yMO6dmAPWq_hZUsyJ7u2QGX_sDTAPgYSSY5b3DK5z70iEBm0b7U9b0ctVVdguTBhfz_szLEfcms6INbWZelZdYGzfjiOn0u-XAgoimFTq4O9NwjxStiDtA7VUwHNVlxZ2yTE
Content-Length: 198
Host: localhost:8080

{
  "cage_id" : "cge_2Czq8LU68w1JJuwSLEkujy",
  "name" : "Animal 1",
  "strain" : "yDib6GdQxT",
  "sex" : "m",
  "dob" : "2026-08-18",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  }
}

Response

HTTP/1.1 201 Created
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: 1894

{
  "id" : "aml_79blvHJHoVUGUcfrGLoQ3y",
  "catalog" : "A0000001",
  "name" : "Animal 1",
  "number" : 1,
  "strain" : "yDib6GdQxT",
  "species" : "WHqmPGTL16",
  "sex" : "m",
  "dob" : "2026-08-18",
  "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_NU9GuG8w9VYGokRytmTLp",
    "project_id" : "pjt_2e9fn5at5wUJChjcsZrL8S",
    "name" : "CEu6dpiIO4",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4hkCrLBM9fEuCbb71DU9aM",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "pJDJsnzy25",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5nATlsxRm8APh5SckFOXz1",
      "name" : "llPkCwSPLq",
      "email" : "VuJqs0dH@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_56MXyxeqclhsVqiYAJZCib",
      "name" : "KEfchjWfEL",
      "email" : "cbCyV3pW@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:59.208948Z",
    "updated_at" : "2026-08-18T14:36:59.208948Z"
  },
  "study_group" : null,
  "cage" : {
    "id" : "cge_2Czq8LU68w1JJuwSLEkujy",
    "study_id" : "sdy_NU9GuG8w9VYGokRytmTLp",
    "name" : "axc09eZxrO",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-08-18T14:36:59.623296Z",
    "updated_at" : "2026-08-18T14:36:59.623296Z"
  },
  "created_at" : "2026-08-18T14:36:59.926055Z",
  "updated_at" : "2026-08-18T14:36:59.926055Z"
}

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_E34p8150an0q8H6LrGF7I HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYTBhZGMyYi00MjFkLTQ5N2YtYTBmMy0xMzEyNGY0YzM4NWQiLCJqdGkiOiI4YWFhZDUwNS02NjBlLTQzMWMtYWYxMC02NjRlMWZlN2M0NjQiLCJpYXQiOjE3ODcwNjM4MjIsIm5iZiI6MTc4NzA2MzgyMiwiZXhwIjoxNzg3MTUwMjIyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJyZFVCTFc1RDhtdE04dTNUT0NSYnciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.SRQpiGe2RlSl0WqZZhlhJZXthfYgl1Fs98yr8v53fn9gMXITM67OYd2eu2vuFrbfKzjkrslK9WPq8HVsV7-f9z-e5d7aDPqqWi3rbCWwI9Ph71isYkq6HlzS0pqUL2hHa-6GhjtznJQY9GAE85zDoy_tV7JmkKAWWI1YQSPnUrdvOz-t5wmz5PaIpxy4ANsRHIR0FIJKpCAb75LW1ywhRMh_YrrtBLIWQvUPrbVUXcqQQaD3YPxsFrSd_kT4eaaTu0X-tOECDi3-PtVfDjBTkZQhF9ZIk51onvurXY8Yad8kzyC4tQu8TVnWwR3ScvO_zfbij9hJR10xWlJuNd49h4BwAUWPQeEs6L0EvU4vp_UhVS3H6cIvaLGhPG-pdIL3cfU-YFAayDZIlNTt9jCfCq18A3fIJZK-HF4grS6OpeJjt1Gv2AMe9NPeKm3DmidLggbkESDo5f-xyl_EF2G5YdC8tN0z60gR9yhVSBBAXvLAgqfMSX_NNkOhHNOxTWJ_1sNa2GbI7beqsK7tUmsY_6q7US3fC10kh1dBDEi3QDzief-RLw-ONfvmSSMvNp-K8dcV2s7LrTDzXZWnInwPuF1lCPCY2bBnK_eUXmBzzKhONdlf72bIYIvz8aDdXxXw00efsaNPGi8bwj207TDUduB6YSwU6SfMBybWT0wGmus
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: 2578

{
  "id" : "aml_E34p8150an0q8H6LrGF7I",
  "catalog" : "A0000001",
  "name" : "sUE0KcahYr",
  "number" : 1,
  "strain" : "q6Zc5aTvbb",
  "species" : "aRTqgEHCkt",
  "sex" : "m",
  "dob" : "2026-08-17",
  "tail" : "oDQWu1aOSL",
  "ear" : "3ej6enXGxl",
  "tag" : "n9ukshjd01",
  "donor" : "iIxzMBqFrC",
  "tracking_date" : "2026-08-18",
  "disease_induction_date" : "2026-08-18",
  "terminated_at" : "2026-08-18",
  "terminated_by" : {
    "id" : "usr_5pUpl2BJk5Dc9cONHmABws",
    "name" : "UF71jwy9lX",
    "email" : "gxQbJfyw@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_6NBMvfHSSz6Y9ZUIGQ3TV4",
    "title" : "Found dead",
    "comment" : "T1Ck5upSyz"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_7jIusJMQpD7qJXPcysy381",
    "project_id" : "pjt_1oAhJ2vAm52PLlywjVwNPJ",
    "name" : "UUTExMQjPl",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3wHBr5L3T5QzLhtrU0uu3",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "kud2sYEDqb",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_40WpQmuCQUTBi7sskKgSXm",
      "name" : "MOYnIQdhmG",
      "email" : "wXORPuiw@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6Wl2YYhKPeVvOiRQYxGSRx",
      "name" : "fN707B7sru",
      "email" : "LvantGCq@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:01.444476Z",
    "updated_at" : "2026-08-18T14:37:01.444476Z"
  },
  "study_group" : {
    "id" : "grp_2rl5WJGgDJN1P36dfbOoCq",
    "study_id" : "sdy_7jIusJMQpD7qJXPcysy381",
    "name" : "lvoHkcY9JE",
    "no" : 355960892,
    "color" : "WPKnvwEuag",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-08-18T14:37:01.934393Z",
    "updated_at" : "2026-08-18T14:37:01.934393Z"
  },
  "cage" : {
    "id" : "cge_1No9yt4qXLI9toqwqIH08R",
    "study_id" : "sdy_7jIusJMQpD7qJXPcysy381",
    "name" : "TMP5DNh3dv",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-08-18T14:37:01.868443Z",
    "updated_at" : "2026-08-18T14:37:01.868443Z"
  },
  "created_at" : "2026-08-18T14:37:01.951240Z",
  "updated_at" : "2026-08-18T14:37:01.951240Z"
}

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_6NMvY9OCFPX5A8w5UWEQ8d HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZGY3MzJlMi0yNjYyLTQ3ZGUtYjI1NC1hNWNmNGNlZjhiNzUiLCJqdGkiOiIxYWZmNTJjNi01Y2Y3LTQ3OGYtYjE4Ny02ZDdhOWJhMWViYzkiLCJpYXQiOjE3ODcwNjM4MjgsIm5iZiI6MTc4NzA2MzgyOCwiZXhwIjoxNzg3MTUwMjI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVWU2lOc2ZuMnNLZkl1OElsUG5MZkgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lCniLh04BHXm3rhO8GuSmHq1oZWqWQpXHnFYWHpUyi6Ux_iYK63cGqkaD8npG6o8Iqdn_-iVPysJu_gsZTIN5PBqVGU5GNky39MqGkYBap4TRhmX9A0sU1YPfQ3RXQ_5CY_5DAO1bnLKcx9Pem2EM8qXSLGXe3Xlq5-XwaZrSDJSNia99elvQaJm544SqqGNTVGFBv3ES6Xe0OEvPXu826O0Ijo7oSkUT2Aa9tR0UwY1HMbYHWJMFqShNjhhjuxmuOMnPMpbyf7oMhLKAECDdLZ_BqnEXwupbBdHI5bjDzauyw8xGYXtgEsxjfzH2mey2cZzadfnQ1XXv3wl-hdH2h28ewwOHEZfkcayi8MDjyy13AttDxhBaqEoFKaZ4hkgLLGj73uPsKCy6AtQegTHtDxIe64kHomjmgURPKkbiBlwDloO9PlcyNn0bqlrBfMe3wa9gaQzjGIp2T4RZcj_6J9LVTpF61glGtHchKgfPrkJRSBEUOqMJH2LHg8m1z4qvBdZbYjLTsUyTWyRALgAt9RrNS05tBekMcMGY71-CNunf--xVNKREwQjEmEblFJYlH41mdxnjqL2cUrlkWwIrCeXstJgEIdNozmm34ZPrtXEWtgV_ulZG0ijHWk74GbKLmHGYDsSG_nl5mA7_eEIp_pXMNE8ij3tFAo1BtS3TnY
Content-Length: 264
Host: localhost:8080

{
  "study_group_id" : "grp_u69JycuHIOVS2xrGqIfNg",
  "cage_id" : "cge_7kdYl7U30M79bizdbuhEL4",
  "name" : "Benchling In Vivo Animal",
  "strain" : "uehPNGNBSN",
  "sex" : "f",
  "dob" : "2026-08-16",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  }
}

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: 2353

{
  "id" : "aml_6NMvY9OCFPX5A8w5UWEQ8d",
  "catalog" : "A0000001",
  "name" : "Benchling In Vivo Animal",
  "number" : 1,
  "strain" : "uehPNGNBSN",
  "species" : "TQVBMvZchN",
  "sex" : "f",
  "dob" : "2026-08-16",
  "tail" : "5fJGvuN34I",
  "ear" : "QRDohu1Nea",
  "tag" : "yrmvxud00c",
  "donor" : "p6mL9fKuex",
  "tracking_date" : "2026-08-18",
  "disease_induction_date" : "2026-08-18",
  "terminated_at" : null,
  "terminated_by" : null,
  "terminated_reason" : null,
  "disease_survivor" : null,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  },
  "study" : {
    "id" : "sdy_2kGs61Qhj3eIIH0OO4Ia1A",
    "project_id" : "pjt_XkvJf6PnVHketGLZsLgY5",
    "name" : "48nFRcrx3D",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_Z75qh39knFq4XrGRDjhKK",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "Fv8MZBpnx9",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1jKJOTlAS20OaS2DgnRg5M",
      "name" : "Jm0dlsBPas",
      "email" : "WvzPeqJE@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_JCpr9r5Fry65v2dZ0Thvl",
      "name" : "AB3gfxJaW0",
      "email" : "Y52UNLUl@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:07.705400Z",
    "updated_at" : "2026-08-18T14:37:07.705400Z"
  },
  "study_group" : {
    "id" : "grp_u69JycuHIOVS2xrGqIfNg",
    "study_id" : "sdy_2kGs61Qhj3eIIH0OO4Ia1A",
    "name" : "QOVbzjfWAD",
    "no" : 967844510,
    "color" : "#3beca6",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "new-study-group-internal-id" : "NEW-GROUP-1234"
    },
    "created_at" : "2026-08-18T14:37:08.118118Z",
    "updated_at" : "2026-08-18T14:37:08.118118Z"
  },
  "cage" : {
    "id" : "cge_7kdYl7U30M79bizdbuhEL4",
    "study_id" : "sdy_2kGs61Qhj3eIIH0OO4Ia1A",
    "name" : "MkSQtnwhIA",
    "catalog" : "C0000002",
    "metadata" : {
      "new-cage-internal-id" : "NEWCAGE-1234"
    },
    "created_at" : "2026-08-18T14:37:08.132255Z",
    "updated_at" : "2026-08-18T14:37:08.132255Z"
  },
  "created_at" : "2026-08-18T14:37:05.148719Z",
  "updated_at" : "2026-08-18T14:37:08.404327Z"
}

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.eyJhdWQiOiIxMzdlZmY1OC04YjFiLTQxZmMtYmU4My1hOTllZTI2NDcyYjIiLCJqdGkiOiI2YTVlNmNhYS1hMGIzLTQ1ZDMtYmZmYy0zYzM5NGVkNWNiY2UiLCJpYXQiOjE3ODcwNjM3ODgsIm5iZiI6MTc4NzA2Mzc4OCwiZXhwIjoxNzg3MTUwMTg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJJMFdzenBDM0c3bDBZRnZnYWhCVUEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.a2kgszF1Ek0Fo6Ye1LzB0sI_tratAZa5o_zs4mERXiHkoL9ztRNG1DJYvcQYGvMR0h7xPvsbPm3EAgxCFW3QNaN4rHFFcb7SkuNHuUSTA_63VGcJr9u3MgltFE_ZAgx5eg5RNg1VeBhl4dW-DngCHaOccKs4FQyykIH9Wi15POYFgG8F9P8TudjiCH5oCi6Ps7tw_Vwt97UW-OcOxCXelLUWhO1-6HvTRgc5BuCEONgWxlx0V411FBP2scG077KISozP3fFc5bc8yiwhI8qZxe_rB5fp9YcmD3NtjUr4fhcPVK_pBOoJuRGqeY9tzRzz3S5eKDLvZ9vRDpLCMBGkS4iFmNK0l1xJUSLNmkKM5N2uQr_ryXPVog1-D-H0MS3O11wTB04NdZTBfUV6sH-CAXmU2oD3aPm3QUDZ8Jo_HzNC8NH_CaY_WS8plX_LGnQ6mtJYZ7NR6RLgrWlWOTwVzMoW-BqG5WisWE3XVXEXrMJfCCJEraSSTxPOB7VVT1-GFOV4nQba9FX7sdTQnSd2mBHzzIQ3XNBbm2YaQpxZHAjpWpQli5ZOCI-AfrspmNkG-MwCQvEuVo_-7iUik2o73BX2H0tu7Xb94jBW1sq0OVIPgukve6mJixzR6JDj6ZfD1TInEC9R8vrbDJn0jFSNQgJTbgGfq_BUWOvrHx8qJCc
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: 3161

{
  "data" : [ {
    "id" : "aml_4SbI423gOZJHYVUhjE9ttZ",
    "catalog" : "A0000001",
    "name" : "n9z7xYZpqn",
    "number" : 1,
    "strain" : "o5vbjV8AqS",
    "species" : "VYWC2udShE",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "Aizy8aJnQn",
    "ear" : "7vbCt9wBtz",
    "tag" : "k8tcGOJkkI",
    "donor" : "pmC4bJm4HP",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_3VSHN5hyZgVQEXl4guitb2",
      "name" : "4hiQKqXSja",
      "email" : "HnI6zpCy@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3fE9hbKCO1AAld1w9Au9Xo",
      "title" : "Found dead",
      "comment" : "ayHOTuBeMF"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3H9FWOXXuDvTQRZJ9Hz2Dj",
      "project_id" : "pjt_4PSTrqGocSHgmxhNhRM8eT",
      "name" : "GpANKsvXI6",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1YHtUFz236mrqAEQyvY8G3",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "l654zelB73",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6ZAmC36t2grS3tDdxtCEXp",
        "name" : "QERQUKJ8IF",
        "email" : "iybmDOQf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5cwzmUkEi37Z31tMXCOXiv",
        "name" : "a7mCCnd8KH",
        "email" : "H2lmbKVr@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:26.788572Z",
      "updated_at" : "2026-08-18T14:36:26.788572Z"
    },
    "study_group" : {
      "id" : "grp_3CRv5uL0Celfbx3h8WgB8o",
      "study_id" : "sdy_3H9FWOXXuDvTQRZJ9Hz2Dj",
      "name" : "GJZhkclSTU",
      "no" : 1386386755,
      "color" : "B7gSdEEmQp",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:36:28.150438Z",
      "updated_at" : "2026-08-18T14:36:28.150438Z"
    },
    "cage" : {
      "id" : "cge_33m2Ph2VYjCaEyMcymgXFE",
      "study_id" : "sdy_3H9FWOXXuDvTQRZJ9Hz2Dj",
      "name" : "UcfY2b86f8",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:36:27.973593Z",
      "updated_at" : "2026-08-18T14:36:27.973593Z"
    },
    "created_at" : "2026-08-18T14:36:28.197484Z",
    "updated_at" : "2026-08-18T14:36:28.197484Z"
  } ],
  "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_66oKdK7D5RGuyBcVQYOImR HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5NTBmMDk2MC1hYTMyLTQxZTItOGZhMC0xYTFlZTNjMDNhNDgiLCJqdGkiOiJhOWU3YzQ5Mi0zNjNhLTQ0YmItOThlZS05MmRmZGQxMzUxYTAiLCJpYXQiOjE3ODcwNjM4MjEsIm5iZiI6MTc4NzA2MzgyMSwiZXhwIjoxNzg3MTUwMjIxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQwUGNLT21sbXkyVW9HVTdMSk9HdDciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.F-S4yrVw7pFR0LRQcOgIflDuH3J-iOHGTWHD6N-N0SPexhpwq7w4vrR3EAXov-4kTHTqYR2cT8r17gGCmX84geuyoD0R3ompjEhWIjYD59TbGg9pB1L0mc_A5P-NKufJNlt4PxyqrbzTtJEPvKhiYT7Jq_lyZhoNuq6hoLBa9e4DIDTmeU3uIQwtYqu2I7FnbmgPSZsRvS5jsE0M_hSOE2UxShlz9o5kJq2drbjFO5VpZz4PpY2CoF-RV3cV1Zmrix-WJHGYIj0mIbkJ4ugWOYk73QyUbBu4G7wX7oBBAmQQt1mtj_lmBYPYb29N4S5UX6WELn6timk8oxfhvsEnr77IbmH7XhEDg-ADUbNSTNB14cHnLuW3R7g5Xf3Govd0iAiMqZBaxedVmh8QWQ28sOU0HIDxjhKZGdeMfyKFgN_j7Kad8aC2qT9zK80B-Tdz5X9HdEvxjyJzI29VxJkdh5DjXx-TfWZYafKGDd1i94dXOn19IWnhZL0x22znHMOrR9nXVbwjzfRPlNwhQEWqT81eLVqSs-UZ7a1Qd8Yf7QYvxM683Ie-eXJyRInttSZKQ6DkRQSG0Y4ggSRzpZNcykGACRVBG7d1W7rOM8zBbRXNkKP_a4UqTXKGOdUymchnFGdBkDZNzaZVBh3fdrwC4h2nt-lvUZpE5MmLmuaFMfI
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: 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_C4FPsW3hAFe0veFhiLmW7/dosages/dsg_UAoAnGbGd4qOWask2WG3O HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3NzQyOTFkMS1hNjE0LTRmOWEtYjcwNy1jM2UyMjA4OTQwM2MiLCJqdGkiOiJkNjk4MDRhZS0zYjUxLTQwZDctOGI3ZS1mMjZkMmM4MzMxMzEiLCJpYXQiOjE3ODcwNjM3NTksIm5iZiI6MTc4NzA2Mzc1OSwiZXhwIjoxNzg3MTUwMTU5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJSb3pjd2p5VmhVM1FGWG5rWWE0RkQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.W5lUgwldk-226UHAWtCoSnWQfpiBMESIbELWQxTw8ZqmxzTrZfRN6msBDLgWbgSAnEtDAy8NzY4n5vpxcT_wayzQBTZ5jjTf-FTR3RKCV38boK96pTutoY8Lc9i0_xaVK6wB7DHbma3UrI7uSjR37oKcuCiGQokDxc3GmjAxCIFUfWUl3fFf876c46Pcub7uJqJJxfqHxof5YeNCzagn6raVWWjeQ3fphE0UiRdgm8b4CpzpOWCRRf6c4fDMpir0f12v8pArYsotqOmiHkoF1RgHbT92YzPTgPaciq_y-koSLxORL1A5F4A3ogMsI1GjRvTVkHi3Y5G91Ta064usa6H_TOihgwnF0AKSckYZFM65PxfkqEiY3lDUfTt7xRcUOPemM2TDiXXX62y6g1uWQeOIFwq-6Tl91OhuTFAqMuiPK73CVESi-zXLDeU8wK0ys2xdOkkbB_1jGbDSGTI2FPE2zLuXuvszOn8D0bjLFlv-WYBr3mbg_oHqMjmKQchtZ4rzg0agDQIrdYQU1CdChsKr-cb22AQjOnrjhcZjE4IkTjtiDC-dgiexV3PQEsJ9y7b6dwNje9x7_06AUPxxm4Y6Dhgl4g-r7klUAFcLL5RRVCLxULlNV4Tz1Qm5jbkqTFwinPJ2pWw-_yvuOkNVJuzZ1PVzEoOTgNhuw7LpaeQ
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: 4784

{
  "id" : "dsg_UAoAnGbGd4qOWask2WG3O",
  "name" : "Example dosage",
  "dosed_at" : "2026-08-18T14:35:59.338992Z",
  "comments" : "AGDE5kiG5h",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "4.37",
    "display_unit" : "mg/kg",
    "display_value" : "4.37"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "19.60",
    "display_unit" : "ml/kg",
    "display_value" : "19.60"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "27.72",
    "display_unit" : "mg/ml",
    "display_value" : "27.72"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "35.27",
    "display_unit" : "µL",
    "display_value" : "35.27"
  },
  "study" : {
    "id" : "sdy_12MmBMlyAuCn7GSqFgyYsu",
    "project_id" : "pjt_15fncn3CjuK6ny6IsITriO",
    "name" : "g81Fjp1eLd",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3RSxMSFkQZdytFtCTBnVER",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "0J4ILgT8tJ",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3r2gDwu9fyVr4WWu4nPZ3B",
      "name" : "exU9G8U7hZ",
      "email" : "ofNogmz0@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3JA7yu4dZlLvTB5poWCFPG",
      "name" : "IjxXrI0HFb",
      "email" : "o8uupKl9@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:35:58.664083Z",
    "updated_at" : "2026-08-18T14:35:58.664083Z"
  },
  "animal" : {
    "id" : "aml_C4FPsW3hAFe0veFhiLmW7",
    "study_id" : "sdy_12MmBMlyAuCn7GSqFgyYsu",
    "study_group_id" : "grp_61wilnmizLakS5pBbqv0xv",
    "cage_id" : "cge_5fLTsdWi2TwKNIgsfohDph",
    "catalog" : "A0000001",
    "name" : "Ek1VdFvbLT",
    "number" : 1,
    "strain" : "Ow2fN3tHYA",
    "species" : "gkhqfAI4Xb",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "wi1ahnhBrX",
    "ear" : "bgeybLtuGt",
    "tag" : "lJSmvGAPBF",
    "donor" : "R5QlbB1RKk",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_3PMP5ffmPWMvF9beN5lO1q",
      "name" : "6TwadYoeso",
      "email" : "R6LfHGwm@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1KLEETsH0y1s7knFFv4ib0",
      "title" : "Found dead",
      "comment" : "Tkl9leMIJ5"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:35:59.078342Z",
    "updated_at" : "2026-08-18T14:35:59.078342Z",
    "disease_induction_date" : "2026-08-18"
  },
  "measurement" : {
    "id" : "mst_1GieZyQpbUcRL7p4dAc8Cq",
    "study_id" : "sdy_12MmBMlyAuCn7GSqFgyYsu",
    "animal_id" : "aml_C4FPsW3hAFe0veFhiLmW7",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_27zO8ujRLCV92yREB6YgZ5",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_27zO8ujRLCV92yREB6YgZ5",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-08-18T14:35:59.302414Z",
    "updated_at" : "2026-08-18T14:35:59.302414Z"
  },
  "user" : {
    "id" : "usr_5KIWI0qkNfov27f5Ovy0ch",
    "name" : "ZkBbF Overwatch",
    "email" : "95DwjfCY@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:35:58.609405Z",
    "updated_at" : "2026-08-18T14:35:58.609405Z"
  },
  "treatment" : {
    "id" : "tmt_7Oh7MHQeDssJXECUriK594",
    "study_id" : "sdy_12MmBMlyAuCn7GSqFgyYsu",
    "type" : "concentration",
    "name" : "9BGOMtqQLk",
    "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-08-18T14:35:59.315191Z",
    "updated_at" : "2026-08-18T14:35:59.315191Z",
    "external_entity_id" : "gtu4C0rPgU"
  },
  "created_at" : "2026-08-18T14:35:59.339044Z",
  "updated_at" : "2026-08-18T14:35:59.339044Z"
}

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_3Jeuz2r1Ly7u1SSdIXwccT/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MjJjZTVhZS1mOGVlLTRmMjEtYjc2OC0xZTVhNmI0NjMyZWIiLCJqdGkiOiI4YWExOGFhMC0yMmM5LTQ1MzItOWJiNS00ZmQxYWVjNTk5MjAiLCJpYXQiOjE3ODcwNjM3NTAsIm5iZiI6MTc4NzA2Mzc1MCwiZXhwIjoxNzg3MTUwMTUwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZRemFYVlZpZzlTWHJhY0hHdFFUTnQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PXNy_Ei6HKPUQ0tmVhAnnq8mBHblLJ4C0-Pw-7P43mpuq9djOxYvea8ZmxyXZ7B2z_7PL3rT5TT8N1Wy2C2c8LxJUIJWe_nC9j5OGh4Xtm5k15VP_ae2Y_K_mGXrc4cWKd5i8d3Kg5n6W2Wv-o9WIxTCgJKXX7PaeUHws_A6IU4b4CHjN08RiaFwBZf8sGmG4KCTE1W6J23__nA1rfRCmGijStBYOJy0-C7OXvRIfzEOfMCtsylSSdTocvmeAsx8vKbFDshRrESnTTAI_FdMVja4jKmBigLXezFdCpO7M5E_p-lVmS0mCsGyGCRjq7CrqhLbDIkg3sOPJumwFvETtGsZF4mogZiKrPcPyPMgVkCxanKNc7t7dH85M3ifkZ1vgSZ_nFj2yd3dX5UKEsfSraNpwpa71uufMNRJxVaUTBmRKpIYSAK1W5aNoke5BZKGMwHc5XPUj4ONJKgPmZUOAebuoNahIisKyMYzzMpT1dYYkbxQlhCnRj5WTWf57x20VbRrevWPB2YG5M_32C44gTAltbCFp5Z_phamIlarKnVkAW93Tp5xEVpEBis1lA02zeUOtSu_9BoMME7vjGwMtiXrpAm5cl5QBNpGJYskksfsildbZz4FCsjAymE2-fG0D81NJk7WoxcunHZS7naek61u8Fdfd7N8KJBCpfMz75g
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: 5631

{
  "data" : [ {
    "id" : "dsg_61ucFhI4m1lbK1CRBZniQ3",
    "name" : "Example dosage",
    "dosed_at" : "2026-08-18T14:35:50.398594Z",
    "comments" : "IwXaUcO4Ad",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "9.29",
      "display_unit" : "mg/kg",
      "display_value" : "9.29"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "19.72",
      "display_unit" : "ml/kg",
      "display_value" : "19.72"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "25.58",
      "display_unit" : "mg/ml",
      "display_value" : "25.58"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "35.46",
      "display_unit" : "µL",
      "display_value" : "35.46"
    },
    "study" : {
      "id" : "sdy_3SKj2L4TUwwa5zjEK0w094",
      "project_id" : "pjt_2sB0kfqI55ZrvDjKV09Ce4",
      "name" : "F3xlZjD7EQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5yzbKp2Ury0BmwHBF5uUsa",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "K0BoDMz2xP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6RYZR5xRbXXTX93UBO9A1c",
        "name" : "Bbk4TTyihW",
        "email" : "FhJXBuPj@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7Z0OjvF8FLOdttGoGG9UZp",
        "name" : "NyEMdHtVK4",
        "email" : "xAqGclQO@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:35:49.574363Z",
      "updated_at" : "2026-08-18T14:35:49.574363Z"
    },
    "animal" : {
      "id" : "aml_3Jeuz2r1Ly7u1SSdIXwccT",
      "study_id" : "sdy_3SKj2L4TUwwa5zjEK0w094",
      "study_group_id" : "grp_73mgAlUnEaYXKIJVha3oxZ",
      "cage_id" : "cge_5Q5rwOttsquBsYQC2ThuVr",
      "catalog" : "A0000001",
      "name" : "YwxJrAZlxs",
      "number" : 1,
      "strain" : "DEcbkZcOi8",
      "species" : "L4AWguzCwj",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "p04kkv4p3i",
      "ear" : "jqFlKB0w7D",
      "tag" : "FZrOt9Yn7d",
      "donor" : "k7RcYURsPE",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_112V9YCW72frvWj6QMckbm",
        "name" : "9uvihd7jGW",
        "email" : "LcaFSMGH@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2UfT3GQdgd9N6BJ36IfwVX",
        "title" : "Found dead",
        "comment" : "9a3OKpkaap"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:35:49.915107Z",
      "updated_at" : "2026-08-18T14:35:49.915107Z",
      "disease_induction_date" : "2026-08-18"
    },
    "measurement" : {
      "id" : "mst_3UZj035NPLtL5iLzangY3M",
      "study_id" : "sdy_3SKj2L4TUwwa5zjEK0w094",
      "animal_id" : "aml_3Jeuz2r1Ly7u1SSdIXwccT",
      "measured_at" : "2026-08-18",
      "calculations" : [ {
        "id" : "vbl_5eCkbaj0ZxV1pkRQCdQUzK",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_5eCkbaj0ZxV1pkRQCdQUzK",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-08-18T14:35:50.261574Z",
      "updated_at" : "2026-08-18T14:35:50.261574Z"
    },
    "user" : {
      "id" : "usr_2duIyV2qbrAIxs5Za9pOac",
      "name" : "63Jkc Overwatch",
      "email" : "2ydd6fq4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:35:49.541458Z",
      "updated_at" : "2026-08-18T14:35:49.541458Z"
    },
    "treatment" : {
      "id" : "tmt_3hNcEQN29dd7gZqYkb6CwS",
      "study_id" : "sdy_3SKj2L4TUwwa5zjEK0w094",
      "type" : "volume",
      "name" : "UuNknwXgzs",
      "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-08-18T14:35:50.330929Z",
      "updated_at" : "2026-08-18T14:35:50.330929Z",
      "external_entity_id" : "TgcHNP6OpY"
    },
    "created_at" : "2026-08-18T14:35:50.398675Z",
    "updated_at" : "2026-08-18T14:35:50.398675Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_3Jeuz2r1Ly7u1SSdIXwccT/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_3Jeuz2r1Ly7u1SSdIXwccT/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_3Jeuz2r1Ly7u1SSdIXwccT/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_xr9VTKoKB6uI76QlPlq51/measurements/mst_1fRlVNgFbKtA1eZsRNLYZH HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MWExMTlhYS0yZjg4LTQwMGEtYjg4Yy03ZGM5ZjhmNzhmOTMiLCJqdGkiOiIwOGU3OTYzOC0yNjU1LTRiMTEtOGMzMy02YzQxM2IwNmY0NzciLCJpYXQiOjE3ODcwNjM3NzYsIm5iZiI6MTc4NzA2Mzc3NiwiZXhwIjoxNzg3MTUwMTc2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNxUEVTQjR3RUJjNGdRencwOEtlY1IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.KEjS4Wynx4gWRfHF6JgFReBPDYu2f_p4Dj1jiRj5nqyVlSyebTAScbNN8sxSy2aFoUMG1KCQY_yisokzDlNgjC-BPmpK5ypkwP2XZJDe954zh1rBsB_f1-ql3u9nJ4GkUp6ozo6FmG5fvNu7LCRFkI1jjY6KkQCD3Iyt790Q47BVlY-CHRawYD_54-LRwFlmZoecgskFr11gi00k9g0jiTsJuJtPl6G82cmki8XzGXkl1TME2YPisZzqI9aa8IuemcO-QxFNonzwDij8z8eN1DZNv95T-Xfu4yIOa5ABC95rIsIb8ubCrn-i09-4Ujlt5wJ_urInMQKj2_LqPZ0WjMRSGPhLCy7sMeGu9bVlRLlbASDBrtT_Mu59dx1QNFw6_GGuIhFOVoIvw3IJjyLuOVvBjAK19CcFcjv6703BYeVxoHhoSpKPbGa4on3mqmsdvAwPmW-Lqo5hoc9BfdGT8j1xUIs5-v0jy10X9WNbi2l-4BIycoDXmKnBbnzdxXeL4oUfClSi9SqkiWAubXQCCuiL-jeB6sEm1jUQXaZOunj8QgrVSfXFadkfvIfn21qDrQOAXxMK8JJqULP4PH6E6f_-FWYUgRtNJraseyQ8qL2ExxlacwmWk5oSPGClqeQ0ff3DMEudEYAchoGAt0AQY3HziC8d7a5wcn5B2F2t3bw
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: 3396

{
  "id" : "mst_1fRlVNgFbKtA1eZsRNLYZH",
  "measured_at" : "2026-08-18",
  "calculations" : [ {
    "id" : "vbl_3PBu0Mthm50uCwyXHA8qVb",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_1Uuyu1j34Oaroyi7BarZ0k",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_fegLL2w5YAw4EatuM2Q0m",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_4m5R3ucATAExQkNGtJPqpk",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_4m5R3ucATAExQkNGtJPqpk",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_8aIVnZaFis2WEuuuwn6XM",
    "project_id" : "pjt_c3WtPbwZpNIE4itZZ5TP9",
    "name" : "HonQbeLQ2j",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_17pmfFxYsbeyrEBmAPA9Az",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "CYppXaPrqp",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4exq3H2jG6acS98Ze4yMPg",
      "name" : "SjmAzBfq8i",
      "email" : "5WB9bl4L@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3uhrrpR3QHgcHXpZyijxri",
      "name" : "HXpjgCvPE7",
      "email" : "jTl3fHdu@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:16.045311Z",
    "updated_at" : "2026-08-18T14:36:16.045311Z"
  },
  "animal" : {
    "id" : "aml_xr9VTKoKB6uI76QlPlq51",
    "study_id" : "sdy_8aIVnZaFis2WEuuuwn6XM",
    "study_group_id" : "grp_3F0hLftyCtxEadgK7FhGFz",
    "cage_id" : "cge_6v1hqfN7rVzQcsDNmwQZ72",
    "catalog" : "A0000001",
    "name" : "VjrvIhkgUL",
    "number" : 1,
    "strain" : "PdMsyJy5al",
    "species" : "AgHNVWoZob",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "9mdCdYqwDV",
    "ear" : "LmSR9pwaxs",
    "tag" : "HGTwRSoaAY",
    "donor" : "sN7NOVxvOJ",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_4h9HNrLvig9HEypuZ2040P",
      "name" : "cjZSTWPFzQ",
      "email" : "jpcEUYvH@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7bME9mihQe6zomE2IaXbQR",
      "title" : "Found dead",
      "comment" : "n8vnROqheL"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:16.341137Z",
    "updated_at" : "2026-08-18T14:36:16.341137Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_30eUh0ps1MO05vKAAk3eYw",
    "name" : "B7rXg Overwatch",
    "email" : "rgMisjez@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:16.012477Z",
    "updated_at" : "2026-08-18T14:36:16.012477Z"
  },
  "created_at" : "2026-08-18T14:36:16.442244Z",
  "updated_at" : "2026-08-18T14:36:16.442244Z"
}

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_5gn5247Aj3yhrGOd4ilknq/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2Y2UxZmEyYy1iOGQxLTRhM2EtYjBhZC05YTViYmU2Mzc3ZDUiLCJqdGkiOiI1ODEwMzRhMi0xMzc5LTRhMTgtYWEyYS0yOWEyNjczMmRjNjciLCJpYXQiOjE3ODcwNjM3ODAsIm5iZiI6MTc4NzA2Mzc4MCwiZXhwIjoxNzg3MTUwMTgwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRwUVdZUUNPU0s3c0s5aWtub1M3UVciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LrrTkRbRcSpKPbZzFLEz0-hHHVaP89N3iQRXoTL_RJ1roIc2dsNxjRFBlbRBCjyH-_BxrlgEqgJU2V9D7Sbg8ae5-lkdwZCiIt8suF0x14oRaGANcdNcXqmod7ySUf4PwuansaqetOJhb2wIyrNlrxsZL14nZegqZiyf8JjibiKVra2F0LCWCM5HnrrPM3pO9LOmxUArHPRgGIkAnfzP0dSmxourUHX6qcwq1tvYwgvDxGRAXXDASsmt5YiF03VwfPxv4FEmgnDSSgkcmPoZ9Cdbgdi1bBBXXksdhkPjJ6es90_reTUvmlKFfs9XyNwBfItmUBDgUNBDP1K16tHyPX0JqaFCcnDwcwJB8UvP6eX6NyLoEJWu-nC7UCkmQ5yDOKANxYf2arprW_A1bxrXng7V85HsiQAWZV5jVSNnN1TXYwTvVk8iUzfbf26S0tf_Xb6Q9mQDgrJvOpqGp376pdf7f3fGiiBRh1N4swKw4m5LCMGC2hu0GeVSoIg2bbp1VTfDsqOe7JFxJH8_GMJvut-9HReYJG1Mp4wv2Uo79HSL8sBmHT8x0VocDNDbgZn5OVHBjdzD-9JZQl5ve_7i9BMjhMSV-CfFKygdbqiK0bDoiMPS9tJU046ZJ_9jHkClezekDbYGeVVRVvrlEU6AfaFTvL4l_f5TkZ2uGpTflgw
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: 7801

{
  "data" : [ {
    "id" : "mst_4YI2TvHC2FBLViKdHlthbK",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_6mvniqR6dBYTNwZYCpuxgf",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_7ITGntv3ldGVXkioqJITHU",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_5sFmBxDYuZYRvq79KEMSpA",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_FQVWpRUUdIRtc9mZEfEMr",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_FQVWpRUUdIRtc9mZEfEMr",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_55LZflRDtkwKy3raL0uQQF",
      "project_id" : "pjt_7W1m4Tp0B1WFqtPhqDMjh7",
      "name" : "EsYXUVWJxZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6wiil6a9bzR9WcfrSODL4R",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "0DhiKq0RTc",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7RSDN9C2AeIb7QGOfEGbde",
        "name" : "ubFgtrWqyO",
        "email" : "bMmRXdIx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1ZsL1Fdv8hK4DEYg448D4A",
        "name" : "qzTDdFeXpR",
        "email" : "R853qG5H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:19.627950Z",
      "updated_at" : "2026-08-18T14:36:19.627950Z"
    },
    "animal" : {
      "id" : "aml_5gn5247Aj3yhrGOd4ilknq",
      "study_id" : "sdy_55LZflRDtkwKy3raL0uQQF",
      "study_group_id" : "grp_6RBGSjE17UrMW10VkSpcd",
      "cage_id" : "cge_7maFPdXBfY0k2Mwt9PGAMR",
      "catalog" : "A0000001",
      "name" : "ytSiQjoNOr",
      "number" : 1,
      "strain" : "QMY9P8mvOs",
      "species" : "jSvLG7XZmF",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "zY0vijilcM",
      "ear" : "OLiS2DlIt5",
      "tag" : "MLXvpRUZ8Z",
      "donor" : "9yVR52OSJm",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_5DjeehBRZBVWH1bPuI5efh",
        "name" : "bBgcLzV6Ee",
        "email" : "dmlEnQkl@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3ANCYPD0CNwighxYdCEQdq",
        "title" : "Found dead",
        "comment" : "Ur1oV9FHUH"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:19.820008Z",
      "updated_at" : "2026-08-18T14:36:19.820008Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_1IV4sPYvA4dnGNXSPC5EMn",
      "name" : "xy89l Overwatch",
      "email" : "dq5wyVmw@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:19.612323Z",
      "updated_at" : "2026-08-18T14:36:19.612323Z"
    },
    "created_at" : "2026-08-18T14:36:19.958236Z",
    "updated_at" : "2026-08-18T14:36:19.958236Z"
  }, {
    "id" : "mst_3iLJ7LClq3JkZcdNwmHPSl",
    "measured_at" : "2026-08-17",
    "calculations" : [ {
      "id" : "vbl_2Q08vHuQ4A1EmmRBta1fAc",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_3KRXAxwPh3Xz9epkQHvayV",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_5LcRz1s5fBjm9T7VeNmnli",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_3VjE1TGFzOQbcR1kgSeRDl",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_3VjE1TGFzOQbcR1kgSeRDl",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_55LZflRDtkwKy3raL0uQQF",
      "project_id" : "pjt_7W1m4Tp0B1WFqtPhqDMjh7",
      "name" : "EsYXUVWJxZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6wiil6a9bzR9WcfrSODL4R",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "0DhiKq0RTc",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7RSDN9C2AeIb7QGOfEGbde",
        "name" : "ubFgtrWqyO",
        "email" : "bMmRXdIx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1ZsL1Fdv8hK4DEYg448D4A",
        "name" : "qzTDdFeXpR",
        "email" : "R853qG5H@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:19.627950Z",
      "updated_at" : "2026-08-18T14:36:19.627950Z"
    },
    "animal" : {
      "id" : "aml_5gn5247Aj3yhrGOd4ilknq",
      "study_id" : "sdy_55LZflRDtkwKy3raL0uQQF",
      "study_group_id" : "grp_6RBGSjE17UrMW10VkSpcd",
      "cage_id" : "cge_7maFPdXBfY0k2Mwt9PGAMR",
      "catalog" : "A0000001",
      "name" : "ytSiQjoNOr",
      "number" : 1,
      "strain" : "QMY9P8mvOs",
      "species" : "jSvLG7XZmF",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "zY0vijilcM",
      "ear" : "OLiS2DlIt5",
      "tag" : "MLXvpRUZ8Z",
      "donor" : "9yVR52OSJm",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_5DjeehBRZBVWH1bPuI5efh",
        "name" : "bBgcLzV6Ee",
        "email" : "dmlEnQkl@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3ANCYPD0CNwighxYdCEQdq",
        "title" : "Found dead",
        "comment" : "Ur1oV9FHUH"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:19.820008Z",
      "updated_at" : "2026-08-18T14:36:19.820008Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_1IV4sPYvA4dnGNXSPC5EMn",
      "name" : "xy89l Overwatch",
      "email" : "dq5wyVmw@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:19.612323Z",
      "updated_at" : "2026-08-18T14:36:19.612323Z"
    },
    "created_at" : "2026-08-18T14:36:19.966426Z",
    "updated_at" : "2026-08-18T14:36:19.966426Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_5gn5247Aj3yhrGOd4ilknq/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_5gn5247Aj3yhrGOd4ilknq/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_5gn5247Aj3yhrGOd4ilknq/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_uQtJ2dvXTxStRYxrBqJhQ/observations/obs_7iGi2uudonBXtmMLd4tFrf HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3NmYxMGVkNS05MjQ3LTQ3NTUtOTczOC1hZGUwMWYzNDNkMGIiLCJqdGkiOiIxMjZjZTQyYS01NWYxLTQ5ODEtOWQxYy03MGRmZjhiZGRkNGUiLCJpYXQiOjE3ODcwNjM3NzQsIm5iZiI6MTc4NzA2Mzc3NCwiZXhwIjoxNzg3MTUwMTc0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR5anhhbzNnb2FScE15QlI5YU5taGEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.M_BG99xmdWpv4RIGb2RB9gbYotfh1rw6y140w7kUv4hC5HO4T9EOxHlEmYij6ANQy0OeVBeSTYHUoJK_V2RSZMt8xdIL8Guv9vq9OrLp8XB4FvH1YqEI0v6upLX43QMYQFg50EldWmjEp2m0oDv8O-JJWpBEal7Nz7EpizKTr4kQA3zTMHIQgrhvaZvQuNhubYPnZiiQge6I4IRjb8WVvml5grtOPtx1nJ-C1wbvLbbeP8hCzbyx0knaL5OlGClJ9D4Q_GI3yplwPi73vIlsi8_h6-piUdfsFibqXaF1f665d9kMQZgMYLDUYbCFYrik-ivWwa2ArBAa9oPXGLuqp771f0b_RhiytRmNGE9daQ9zR7XvrX__ISG95dDZKVr7yDhnIxJ0o7bIuNf62XMRVja2vhEmXvZHhGPeUjh68YjXE7HbUH4OhgonSGDdbTFF336G_mNQB4gruBNMqbeqzRFP0QOTguQSmUc2s3pyHXADnb3UjpRkY6c7taa87cCrv06-QbvMfyoeHi3z6n4iXavE8wvUdEx4vphiGC_zQWJhc8NLRZoj49PKATe1bNbcSHEdFRZPrZ-L-dp6ROoDvc0EzvRqjM1KdDFlT0ELS1AXN7YhaBI-7kAB3_vSOTKkKnMkKC3Ewo0THsjx9Lqtn3lb-Lv_RGG4DlDspG3B4Eg
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: 2808

{
  "id" : "obs_7iGi2uudonBXtmMLd4tFrf",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_1RZiVXaJI96w6nFWFKKTux",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-08-18T14:36:14.302999Z",
  "study" : {
    "id" : "sdy_2JpEtw9DMjzxxdnuAJVVZJ",
    "project_id" : "pjt_30fAs3M6ZqY1DDMNpYnEKE",
    "name" : "bBuho3etq1",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7RP9NPDL8F5G3WRlY4QXAn",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "PZdnuRtVq0",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1Lc4i5bCTZiI4tZxV56dUn",
      "name" : "rOyefsbk3q",
      "email" : "90ZGItMb@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_42jX9b1psLmWqSoZkjE4ut",
      "name" : "aJca4UoogQ",
      "email" : "MrzbxOyg@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:13.521570Z",
    "updated_at" : "2026-08-18T14:36:13.521570Z"
  },
  "animal" : {
    "id" : "aml_uQtJ2dvXTxStRYxrBqJhQ",
    "study_id" : "sdy_2JpEtw9DMjzxxdnuAJVVZJ",
    "study_group_id" : "grp_5C2tmea14uQu2szGoPfAno",
    "cage_id" : "cge_2tSlQ6SFyZ2o77utr0lE4e",
    "catalog" : "A0000001",
    "name" : "TlBovYl8Pd",
    "number" : 1,
    "strain" : "Vx1iGqB4O6",
    "species" : "k3vP2SwOQl",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "xH9iuHPNoW",
    "ear" : "BcSyS1l1Te",
    "tag" : "1PojEL7cpg",
    "donor" : "pIZUizdaND",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_6D5T16hM1MMdxYXyiJ4jWo",
      "name" : "2lxShtSjwq",
      "email" : "ic3wqpSo@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3cLVlUBEbrmIuZ1zIkdmOt",
      "title" : "Found dead",
      "comment" : "n6wrqJzrwa"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:14.131658Z",
    "updated_at" : "2026-08-18T14:36:14.131658Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_10Ya2IAwmCJ06nk2B8btrn",
    "name" : "lFCcM Overwatch",
    "email" : "vbf9IxKh@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:13.485415Z",
    "updated_at" : "2026-08-18T14:36:13.485415Z"
  },
  "created_at" : "2026-08-18T14:36:14.305218Z",
  "updated_at" : "2026-08-18T14:36:14.305218Z"
}

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/v1/animals/191/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJvdmVyd2F0Y2giLCJpYXQiOjE3ODcwNjM5MDAsImV4cCI6MTc4NzEwODMwMCwibmJmIjoxNzg3MDYzOTAwLCJqdGkiOiJjN2JkNTdiYS05NzNiLTRhMmMtYjFlZC01NmJkOWVkMDg3YmMiLCJzdWIiOiIyNTciLCJ0eXBlIjoibGx0IiwidGVhbV9pZCI6InRlbl81UGdqS1NQZ280UE1uM3FaQ1RtTG5SIn0.VyHDGOXDGh1jvG4Wc6A6aXab-gY0LtLxsStOOeZOsqk
Host: localhost:8080

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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
Content-Length: 854

{
  "data" : [ {
    "id" : 28,
    "api_id" : "obs_2WWAaAHtTAuZMBftr1Fvdg",
    "subject_id" : 191,
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_4QCvkaaXwrcraftYeg88RX",
    "observed_at" : "2024-06-15T10:00:00.000000Z",
    "text" : "Example text",
    "title" : "Test Glossary",
    "type" : "severity",
    "value" : "Severe",
    "options" : {
      "details" : [ "weight" ]
    },
    "created_at" : {
      "id" : 257,
      "email" : "LSRTloDh@benchling.com",
      "name" : "TOOcEJ2keO",
      "datetime" : "2026-08-18T14:38:20.979640Z"
    },
    "updated_at" : {
      "id" : 257,
      "email" : "LSRTloDh@benchling.com",
      "name" : "TOOcEJ2keO",
      "datetime" : "2026-08-18T14:38:20.980637Z"
    },
    "grading_info" : "none type desc",
    "benchling_assay_result_id" : null
  } ],
  "links" : null,
  "meta" : null
}

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_7lQymWUF90TfUvuIS7MtQW/samples/spl_4CoNp6FC3g5CydhbI5NDuY HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMThiZDM5ZC1iNzlkLTRiYjctYjcwZi01YTJlYmQ4MWMwNTkiLCJqdGkiOiJjZmU1MzUzMS0zOTFiLTRmNjAtYjM1ZC01ZTExNWI5MWFmYjgiLCJpYXQiOjE3ODcwNjM4NDksIm5iZiI6MTc4NzA2Mzg0OSwiZXhwIjoxNzg3MTUwMjQ5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJtWGdVcTJtb2UzS3NlWGhnRkJzRk0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lRcJWP2qChT7iWzTECCBDOc0KP71vdhDCIJxsun5liabsyzVSLsbjUFEs16oBqVfHu7nKjBkcfHQbepdicdkh-JHE_VhUHk0MWAhmyblCJUKcyvwEdzjiw_lgm2Ht4yget9sczuhwF-9RHk2fhnXjKbnhFu3-lc01HQQ03K1zozRZQO9jkoDK5vmCdgJtKsUMLQGQJpa_boNTMo9yBv8Ce6mFTtbgmKkC3gUuPSlScYpLiDdaGkAh45-QZKya7NAzJwueDyAURdeaWAOJTdcT49eqkihOm9dneKIAbRrP9U0hSbTy5kPdVmplFShcZAtKwZBIcEI8tRnL8Uf6Z4WvlZ8Qv0O2TKx9p4A-Rejm41pOX9oaaDmLTvE2nLifitaXyiRDTUIIWIgA0ERw3_Nf0xxGFZ2XAIFqEHwfiGV-vUfr2bqseExsyEv2vlmNih2v8H5UufO-Rmz4sQsuyqzB_oOrXXeelc5d5YdT3VkVAia2K0hRyPndNZFUYNB0UxlDr-SFcNxaByDGl8Q7kPIZ0xjY8qk2MsJrCL2F4XE6Xf5-pzddvpAS2LKERwMpqz52zSJB98ahy8mL_eYqk5L7UUGnXVABJI00a3YFtsWUyLVIU-QVtY2bPUTYR_iBhM1Wf51urfPCeZdpxkXAb6Kl_Nln6UbC58v434cFaZghD0
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: 2960

{
  "id" : "spl_4CoNp6FC3g5CydhbI5NDuY",
  "sample_id" : "S1517499612",
  "sample_definition_id" : "sdf_193a0mc8g7eU3kpNjmMBPZ",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-08-18T16:37:29.952167Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-761071116" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_1gTVYYnjsLeDg8kvlJSSKg",
    "project_id" : "pjt_3cwlpAK8bNe7dVevFdULu2",
    "name" : "NfDhLQ1I4K",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4lzJcHGTkaHENqGfuUoFTo",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "TdisdfORvB",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3lPd0qepFUz34y7zS2BeZx",
      "name" : "4e80j8vgqF",
      "email" : "ye1QL9pU@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6jEehMfZhcBQKbsBbnntI8",
      "name" : "KOzH5l0NNX",
      "email" : "AmT7eFMn@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:29.323457Z",
    "updated_at" : "2026-08-18T14:37:29.323457Z"
  },
  "animal" : {
    "id" : "aml_7lQymWUF90TfUvuIS7MtQW",
    "study_id" : "sdy_1gTVYYnjsLeDg8kvlJSSKg",
    "study_group_id" : "grp_6aTAizYV31CwBsqV07ldKh",
    "cage_id" : "cge_2TuV2epgiaaGOxnmEpTwsP",
    "catalog" : "A0000001",
    "name" : "snQK6ZwGt1",
    "number" : 1,
    "strain" : "pOw6sRnMj2",
    "species" : "YkdlPQgrSH",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "pyZysYPzWv",
    "ear" : "VNX5Fyd3LA",
    "tag" : "E6eh4jssnv",
    "donor" : "1qCnbDWjms",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_7Tr5ThUD7tYT1fopgzM0K",
      "name" : "fy5MVMtQKH",
      "email" : "kXcCeMjp@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2ESzUJRpVST1J03VTRW3vZ",
      "title" : "Found dead",
      "comment" : "qEOM62dzRD"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:37:29.670577Z",
    "updated_at" : "2026-08-18T14:37:29.670577Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_7N85kfu5yMPzeWb4uATZOM",
    "name" : "kBasDS30pl",
    "email" : "zSfnsxIO@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "S3SDdJcmXl" : "3GVj6igIt6"
    },
    "created_at" : "2026-08-18T14:37:29.933819Z",
    "updated_at" : "2026-08-18T14:37:29.933819Z"
  },
  "created_at" : "2026-08-18T14:37:29.953572Z",
  "updated_at" : "2026-08-18T14:37:29.953572Z"
}

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/v1/animals/4073/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJvdmVyd2F0Y2giLCJpYXQiOjE3ODcwNjQwNTIsImV4cCI6MTc4NzEwODQ1MiwibmJmIjoxNzg3MDY0MDUyLCJqdGkiOiI2YTdhZDkyOS0yYjA1LTQxYmEtOTQxNi0wZjVlZTJhMzM5YzgiLCJzdWIiOiI1MDkiLCJ0eXBlIjoibGx0IiwidGVhbV9pZCI6InRlbl8zb0tRaUttWm13akEyMHdRdFR1QTFqIn0.IRGKLNq-liiupSleC3-3JFjzxR_uuH7nbaHIxf6Yfec
Host: localhost:8080

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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
Content-Length: 1606

{
  "data" : [ {
    "id" : 2912,
    "api_id" : "spl_1pjHtmPhSu2ce5ETF18zlr",
    "subject_id" : 4073,
    "sample_id" : "S612456571",
    "type" : "Blood",
    "label" : null,
    "team_glossary_api_id" : "tgy_1ehpprBOC8MdORoGV36EgZ",
    "sample_definition_api_id" : "sdf_UKgK7DPouqTOnCMEVSWrk",
    "status" : "collected",
    "timepoint" : "PT15M",
    "date" : "2026-08-18T16:40:52.601226Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : 5
    } ],
    "comments" : "A blood sample",
    "created_by" : {
      "id" : 509,
      "email" : "aVL9sfWX@benchling.com",
      "name" : "0KwGUVNqWV",
      "datetime" : "2026-08-18T14:40:52.606053Z"
    },
    "updated_by" : {
      "id" : 509,
      "email" : "aVL9sfWX@benchling.com",
      "name" : "0KwGUVNqWV",
      "datetime" : "2026-08-18T14:40:52.606633Z"
    },
    "study_id" : "399",
    "user_id" : "510",
    "study_group_id" : 1087,
    "metadata" : [ {
      "id" : 8256,
      "glossary_id" : 904,
      "glossary_api_id" : "mgl_nW143foZy3lJg9C3XlHA2",
      "active" : true,
      "field_type" : "text",
      "options" : [ ],
      "slug" : "sample-internal-id-1943468222",
      "title" : "Internal System Id",
      "value" : "SMPL-1234",
      "created_at" : "2026-08-18T14:40:52.603453Z",
      "updated_at" : "2026-08-18T14:40:52.603453Z"
    } ],
    "created_at" : "2026-08-18T14:40:52.601324Z",
    "updated_at" : "2026-08-18T14:40:52.601324Z",
    "benchling_entity_id" : null,
    "benchling_entity_web_url" : null,
    "synced_to_benchling" : false
  } ],
  "links" : null,
  "meta" : null
}

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.eyJhdWQiOiI5NzEzNmMwNC1iZjMzLTQ1ZDMtYjY3Yi0yYzEwNzU0NzljMmMiLCJqdGkiOiJiYjRhMTY2MS01M2Y3LTQxN2UtYjg2My03NGNjMWQ5NTYwNGIiLCJpYXQiOjE3ODcwNjM3NjYsIm5iZiI6MTc4NzA2Mzc2NiwiZXhwIjoxNzg3MTUwMTY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRna3FqTkZ3Z29kaEJjZGlvNmpXMDkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.l5Y1LRYWqs19hl8wpkpq9bxLUuVwR3tubWfZUWKx4ey9xKQWBL3eytdfgATC7-W1QVY7BF_CLVJ_iCzvp5EIzB1Sx5BFaZNEBqlBws1BOMS2PLPvoB8Al7qX8iT0xzpD--CTA8gFULPDQglSSFuZR-NMqdkvpD9qPJ6mq8qVGYPShOTRm7Lay5NVe8ML8Ka4ziQJNlg97Lf5CtqweUJ7uGnj2Fd8vaEh1EN5B9hmRCdelk35CT03bii2XM3n7W0fHZIysqCarYCCCqsAf6zIh76ODacAbTi-dNJ421Nluvxa0O64mHZlryPrA-awQ-3JJEnG3DYRjB-xG8WRCcpmUDPyOJ9o_mPVwfCMO6ZTmCyrXX-Kb3UThjmltGhr3OPCgEe0FP-TNcmCR_EyDiXs-gNeRDR4d01k_r7JUO_i7d1q_OQyUYMq9WU9SFezJuI-OpNUmANC9YDEYv6PLu7Zkctld3oSqZnJpJyirn79M3Ri005kgMmNleYsL51KKUcWLmLO5_xcJCMB2KzvaMrcoTF-8EvTSx5kfFupZ0y4e1mbM-kKHlMmZnrcgBXEt3x3XF298gsY4wCu9uQ29G4GTt8VoMmDIgYtRXGwCFSbvmt8uwpgMV2qPT4uTyGPWIHzhS83y7uAl-YQUh7aNTem8xcTCmGOe0r7pZ9zA_LU3eQ
Content-Length: 107
Host: localhost:8080

{
  "study_id" : null,
  "name" : "B5vKODRpcg",
  "metadata" : {
    "cage-internal-id" : "CAGE-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: 265

{
  "id" : "cge_3yqAP6XAat90ApRxwzt0Yh",
  "name" : "B5vKODRpcg",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : null,
  "created_at" : "2026-08-18T14:36:07.036584Z",
  "updated_at" : "2026-08-18T14:36:07.036584Z"
}

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_4yrVBQhwDREw3qZAobAH1p HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3YjkyN2Y3OC1hNzFmLTRiMDEtYTgwMS02NWI5Mzc2ZWZmYjQiLCJqdGkiOiJhMjg3M2ZlOC05NjI5LTQ1ODQtYjAyZC04NWFhNzc1MmE3MTYiLCJpYXQiOjE3ODcwNjM3NTYsIm5iZiI6MTc4NzA2Mzc1NiwiZXhwIjoxNzg3MTUwMTU2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJPZk9zM0I1YkJDYjFMWjVBS2Mzd0kiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.COK8rTV9at3c_zoamVjprOqxLB_f1009k3KSrzT8gnsFerkdBDOGGTHsRsruqkUdbelc_CXmXRXOOHxQYyOTDjURPHUZx8jgIirdm5ijyOUVEXhX4Pfcz0nD7zeOQ9ZcTPYMzxZLmunGN-oaEMNOuen9cBIeZjNOQqwK2WjIn3BBVAXnHc8bRY1GDad3nVs7PBmAiGgHhe9ONTj7PXSWwKZWwbh7sTrop65Eq_raoPiBfxU1oDXxmgrOOjdfeojG4s7BaTjvCsW7_h5Kt7mWgKizMje9kt8QhX9eqljBKapRvXK8TdjBzzwkMoFoWjM58xyOvr4AZCeruFEz8pKQU45eAZ7MizDRmw7e-awn_Umg6CVjJOaP72cc_OWUiN0KSHCYuG5TNLkPe9IKXzw_iNpdpSN1-mANPplfqa2g0RrqQxK_sOgbC0kVv8ob1MlwRoaJU255pr46FepBxHdqtBTpDQoEnk6-TY2PKkBxmwgHMjZ4-PRoKf_VrXthAFd6aPbQ-4S7_7CHGsUSsGP5UxA2Nvky0kQgzwErpLsFOi0zuVjPlImqfgw3M8PlcE-H1zUHuuiwQP87E60cPIhG6grlAg2kcOBH8rl7spjxllcHqbTWJfdysKJhdlnCHngjmNhnSAPR3E8EzyJ_uHOKOpOQTwaKdUL5smZi09w2zjg
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: 1195

{
  "id" : "cge_4yrVBQhwDREw3qZAobAH1p",
  "name" : "ljwzAwHgzC",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : {
    "id" : "sdy_2AR8YZMzulEN1nHAv1g4ow",
    "project_id" : "pjt_1z4cmpAIHYVsCB1DtawIHa",
    "name" : "7ji4lhnBGf",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1DKQVZjVMLxmhbgPSIQz4w",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "EJOqD7sxtx",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_oLKIhp9wL8PVqIHvDWR4z",
      "name" : "NJXLvrxB17",
      "email" : "ggRazrAZ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1as1XEyJkqB7U8ok3liAra",
      "name" : "hjIycYZpUS",
      "email" : "ExCxujFu@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:35:55.899338Z",
    "updated_at" : "2026-08-18T14:35:55.899338Z"
  },
  "created_at" : "2026-08-18T14:35:56.429330Z",
  "updated_at" : "2026-08-18T14:35:56.429330Z"
}

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_6rkvhmKsu6dp9XkJ8Iv2eS HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwZmM5MTA5Yi1hZWY4LTRjMWYtOTgzNS04YjUzN2Q3ODUzNDIiLCJqdGkiOiIwYjg2ZDUwOC0zMDk3LTRlMDctYTFkZi0zNWU3YTJmMzQxNTgiLCJpYXQiOjE3ODcwNjM3NjksIm5iZiI6MTc4NzA2Mzc2OSwiZXhwIjoxNzg3MTUwMTY5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJyM3dJTm1CVFp5Ylk0OTg0eDVsbGciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.CSFDZLynx_b13hNTesHwBgxQrIb9rmO7TwiXev5a4bJrOpYjiFGHt0BZomM33HnNB8nfYp4O30rXe7zrhH0KY3icZ4N99IccYGmTqKuJYJ_qNc8mmNm4PXLY83sTo6wzNdiesOBDI39hZhn6yBA5AS2uXeZ-7vmZAjrCJSliypEN53sLaN8JhgdIlkXXRjJ7gaAqgOdAFW66WPgYYB4TScf82kMbreHY793SZREbdlrU_NxZkDa9zCULYv3KUD_vuLWQr5x64D9ru5GLdCCG-AGWPwAx8rEAdFg_NV6WcK9rKU_Ajctf_A8qjuVtBOnINwDgO9xjCnfmHZawZapyTyuj1YG-CbZraYyrCl0GR5_xrB7G0LrEbUN_HqxXEfKVdfUuYKwF8qtUdrXwRcrQpmuPTkrrvz-M8WEHf1WDVeKxhAsggnNeu6zh1CgCSYh61OGnw5rRnXLPuiTyRK1-nmRmcNlomcg2I12M73W2na4uC9YNnX3UnWrWIH7uS5P7IG5ZkxLJW4dTpJRntaea6gAZep-bvUbKmTJzGcN7rw0wbnm7rECp1Qa7Q1kXOxVMB4pB5Gz4aXMjTmbug8EETYjHhGTw4uTLOgq5NrzPSa7RszRpY191Lb_fvg3Zo3CyRfR3GHdiIfUXhPbq64i5D7zW54Wu4kWHwRBIAGGfHbo
Content-Length: 143
Host: localhost:8080

{
  "study_id" : "sdy_3JnKVy3njXgtUSUtvwCQAD",
  "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: 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: 1215

{
  "id" : "cge_6rkvhmKsu6dp9XkJ8Iv2eS",
  "name" : "Benchling In Vivo Cage",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-4321"
  },
  "study" : {
    "id" : "sdy_3JnKVy3njXgtUSUtvwCQAD",
    "project_id" : "pjt_1ygdt8tWFvtKIzg1AsjJ0n",
    "name" : "v7jB9QqKMb",
    "code" : "CD-26-446",
    "study_code_id" : "sdc_1eQSjo43IndLRrjm52aTdo",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "YYpJtw6rwK",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "new-study-internal-id" : "NEW-STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3WR0owdVp17CGhHbothCml",
      "name" : "FtaZPCV2JT",
      "email" : "nJNg9NYE@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_xkMdmupbPMCN8aKpvVQ8H",
      "name" : "YM7NYwHDHr",
      "email" : "ki8dwItW@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:09.236938Z",
    "updated_at" : "2026-08-18T14:36:09.236938Z"
  },
  "created_at" : "2026-08-18T14:36:06.427478Z",
  "updated_at" : "2026-08-18T14:36:09.493782Z"
}

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.eyJhdWQiOiJhZTFhMDA5ZC05N2FmLTQ1MDItOWYxOS0zYzg2ZjIwMTcwYmQiLCJqdGkiOiI2MTY1Y2IyMS00MDZiLTQ0OTktODNlOC0zODllMDEzOTIzYjEiLCJpYXQiOjE3ODcwNjM3NjEsIm5iZiI6MTc4NzA2Mzc2MSwiZXhwIjoxNzg3MTUwMTYxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVLTlVzcTV6R1BKZnRRUlJ4YWtMTHgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FPpEfPqTTuAaiVjWuB7epWqqT39NSsYwO2HsSmmjZezSAWjL09n1eVtItKD-33BxGYSEU6SK4H8Zcrfx5CxP6Ausq8IU0qJDAun4tUY_-ZHQqjGVLxVIBfxAR5TuArWIyiFROXzIx8rDS5-f27eYhc0kewkbep0mTFkcm_4meaVjL7VbZ-GswRTMyiA8-wCut0TYnT-rFrPSF7d9kBBMh0oWwFHh3xUVboEplqX-YNh4wQS51hlVb8aWLstuATvRJN3ehSPngeWQBzVDxxgEUBQHI1rfuy0SbhWp4VBhwoUyXsRkfGAYjmDprxlyUwUs3DQRDhoWOxfTF7iz_VSbeYjIHTxq0kGj1A2nLIgAAgHHhzP5wokwDdH_jbCOhlMfjM5lgvwTyukKvbDZPNxw75ZDhSxWdP-whRfr_9zQ0C2CiRhPkdbx6E6fRhyXwStscSZqn3L-tz7htwrNlPnZPFJnty_QBV7DEFQrCrNk1_u3cSNJYT7QrVaJYl2GJ_BRPdshrbMywxLDJ-YR1o9ciUwZ268-8M06y84lmzFNFx086dpdHOmmAct1635zMM4ekLjOJwfnElsr4gDAmxxA3tO-E0KSdwt-tP4EaCUEN-3lkgA7I6eLy3QlzfFhTSLQBl5BcHjlQ2HUlsj9bb_f5uIYY5vYXoQ_28KvSsCwxpw
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: 1670

{
  "data" : [ {
    "id" : "cge_mLgQgLLRrkEGrpDp9S1pk",
    "name" : "H7djmo8ZsT",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_37YOXmVOt7hwQi1xTtIuGt",
      "project_id" : "pjt_7AhRF9jwHfY9meMPQC9ns2",
      "name" : "Rp5BoHw3rZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_507o9inmwjVJU7ZPxwlUWt",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "CWC84ELiZh",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_T9dgyYdxad6dHyCFOMQz1",
        "name" : "1Cot4uoaYo",
        "email" : "Ulml6pf0@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3NSjw3POtu23hlb6TxYZwJ",
        "name" : "Iuq6dDc3SJ",
        "email" : "rJNViFI3@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:00.635920Z",
      "updated_at" : "2026-08-18T14:36:00.635920Z"
    },
    "created_at" : "2026-08-18T14:36:01.124914Z",
    "updated_at" : "2026-08-18T14:36:01.124914Z"
  } ],
  "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_epnCVF2ccEGdjmqHISoLc HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMzE2YmE5Zi0wMjczLTQ5Y2EtYThiZS01NmRmYjU3NzZjYmEiLCJqdGkiOiJkMzA5ZDhiMi1kNWM3LTQ3YTItYjgzMS0yNmZhZTY1MjFiZDQiLCJpYXQiOjE3ODcwNjM3NjcsIm5iZiI6MTc4NzA2Mzc2NywiZXhwIjoxNzg3MTUwMTY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZTZ0V4aTB3dGY5c21oSjJNNndvN1kiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.e3Q61DprMK6wJ-aJcKyf1K3C1C3aYZlmR6flxJN25-1INboK_AFGhkXhAQeEu51nxB0nuGStubvlJfF9JW0nbZnIGsrDe2kR91CLa-T3vHQsxQoNwpynG1ZLUSs-rCxMq_YEePAxBGlumREXOF20Y_jSm7CWXOpmTTcZiIaEIkUekx9y-2WStcutgsIAjKcEwUrsy-0GjG7Z62HelkTYTLvCiGd6DfiIqd9X-OQmjQIerOrg03AhadMcyWcBxxDaCbEnAg94xrOxObc8ae6dIeftaN5Du0Fc4GkBvNZ2ghPa_aW46xaCs7Ocj2OM7yfbsCmUXjuFDC5Siyb8Gsyf7-X6eQNnqoeeWhfBPBVpckn3qSuRtuaR-69kYAmIFC6GQgHQLniV__a0knX71DX744daz5Z7smVL7FQNKo3WEaENpzyJTYMmMfAKaMN6KYq3sMX-yuxUvIVRMJztCNLjEvABD_0ZEmZI31CTfLE2yQOKS06vQfUjNyUVuXjTjpMMS0_Ey0DAAH8nNC4G6fMDy7YNvMze93jLNalqbEkSifvziVB77lgVNc8AoiHfz89gtyyvvMva0VP-9yEfw_r1L4iLqZTtox--Q-JknMOinRP5K4N-OHOYXuckK6ymHNYtszhpAdknO5dIdOm5umL1vtUymXeo9aUgG6e3HAHEJ6k
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 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.eyJhdWQiOiI4YzVlNTFjOC1mYTc1LTQ0N2QtYTY4Yi04M2E0YjZjMDZhMTQiLCJqdGkiOiJkNjFlMDFjZS03ODFhLTQzNWItYTZmNC1kOGVlMTc4OWVkMDUiLCJpYXQiOjE3ODcwNjM3NjQsIm5iZiI6MTc4NzA2Mzc2NCwiZXhwIjoxNzg3MTUwMTY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZNWU5lNkh3SW5PbUZmalk5TjhHSFIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XA8Q-ytoa-aKU_JO-i7BjmIpvVEOtaeiHCiW7YxZzW6mWjRi2pzStRlnwAvPF3hjz3CIA2nEcG5qC_0GR9S8EiCUMMnR10ElFBQsXdgFlsnx4byqWU6D45soebQa0PVidL3wmKEy10ZJDV1rCNrPQHE9yBzZIO0yR-8sdHNnjEvjHX4d_UReyfTvgB-eZMW-oCxyTwwf4dkZe5vcBut1vz4M-4LiA6rV7DEXVO1d34EFBDD9lI2jOjse-FqL3YcR29IEIz1_gsGWhpwiVA9UTChF4hycIRFIH-ccRBD2Me-J-E6_csMzb2Ho0-4Th-n_-HC_08CJo27XegQbIyY0B8NTD_Uesbi_qQna_OUggi4zV_WOSSbysXHrQnd_sd1lpcpwH5qONr3FfWo8xI1Hj425Ij15zsQ8qa9aJUwV4psA40fW6Y_vxkX3wSTYjfHzI0Zzr0vsg_dQMYUsWAXuqAEBno0-Sf18Z_lImbIxx2o9ao6PK_2J4KJwU4G3bTx5tyyjrLIyrv_6z3o8AXrqmX4OGZg7XWnd1BG40p5RTrN17e5P1OaxN4kJb5Cw6ilk6NOh9Av6Iv59uVvmrVSLQOQQ-6Vw07hRLy524iRSh28BeCNs_yN6rd39Nj1e0Kj63G_HZq0_7L9LBeZWp3dPoHrM9Hn8HB6CyHtq5tC6oh0
Content-Length: 174
Host: localhost:8080

{
  "type" : "study",
  "title" : "9J8d7xlmq8",
  "slug" : "UgkIJLHlub",
  "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: 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: 213

{
  "id" : "mgl_1WTuSLM3CtciA3wvKqQM9N",
  "type" : "study",
  "title" : "9J8d7xlmq8",
  "slug" : "ugkijlhlub",
  "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_7LfoeSAYn6zABZss0h6koB HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZTZkY2YxOS0xMWFhLTQxOTYtODUyYi0xMjRjOTdmODJjZTIiLCJqdGkiOiI3NDhhZGNlYi1kNmE3LTQ1NWEtYjQxZi1hYmFhNGU0YTM0ZGQiLCJpYXQiOjE3ODcwNjM3NjYsIm5iZiI6MTc4NzA2Mzc2NiwiZXhwIjoxNzg3MTUwMTY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRTVzM5c3ZTY2l4SHZjVmNkZDZwMmgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.EWGaRPaS-gFd40kZB7cEmR8mqbE3o1Vu5v91HlS5fe-tAylT4ZKxXhkublmlYJuuE2UJxzfHUq0G4hDGC1e5RyS3d69SynRRurHFT6oEJOsDPKUeuYPBW12Yk0IsfVr0y8A61yHwmVBxbi9j-MKib3xi651GPmMlF7_qdj-naJxd4pVvUI_1C0EWhZNsyeXcaaWnWxCWIVpisq9KoTV0XTjr-1Vvn3lLV_RnIEeEcVcUpQGBk7lMuaoiRghkCMvS8CzzE0QatDNcHffi2LFw2wSYGaqqCUDlRVEGfLeYpJw24-7vFMWU0PVTV072nSdNHZ7yWOt417LJ-Mw2WBalgw6vJ1a8LWHa-t-hDH3abZGGL5Idl0jfLBUpDKfrwltiIFswQRQxDEeCVG8QFnAJuTCioRLZpgqiSjbjBL5yFUtOKfjmUDliQe5lRPfFAUZ_hFBm5-agesdYzCSxvEvaVitTGFPAtD5CVni0bHVBK3wI03MgXP6l4mhIoovZL38uueBHeNDdfo2ol0Z3cnbJZLJfGEZEKYKiAhYxCEyrW987MBOuebbOn0X0ucP8aykqhBD1iidBdu5IidA9553xFQQtBy8FYaocUZcsSVcJ1-eaKg2P8bwX-WULeFUGOguZmLC0kWBC0MNaJh5SDrTnOo2RE7lFjUEuDqVoQGu7dss
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: 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: 236

{
  "id" : "mgl_7LfoeSAYn6zABZss0h6koB",
  "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_3RubIBhfRjRCd7jBR9oXqN HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MzFiYzM0OS0xOThiLTQ4NzMtODZmZS1iZmI1NjA2OWI3MjAiLCJqdGkiOiIzYWQyODc1My00NDZhLTQ4NDQtODYwNy0wMzBiYTViMmZlMjkiLCJpYXQiOjE3ODcwNjM3NjAsIm5iZiI6MTc4NzA2Mzc2MCwiZXhwIjoxNzg3MTUwMTYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJsSE8wU2dPR1hleTZ0am81ZXhDaFMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.do4hAQD1IqfRnyHTOOCyihBOWba_Gjd8nabpYKXZJsMgOuYCAwn6XR39MkyoXZYDmzOd73gxeBKT1zYiHFjuks5wYgqBHP4lU8Z_k95vxRhzIyiGtrl38gPayc05RnbbDEDjlAdUvvzM46DVdMdaxCA6B9JHzsgyKTf-lJ55dXNgILYkCzPT9X4r8FunT7UDPU6ZHCmbbNQc_eG9Fg-HbgvZL_hljvUXHo_wjBRN8V1ZTdL8vyxeYO-KrROuIwBp2hHcbLrFQEOi5YW-AP4cVx1yTLvjrOR0sEIf8lpdpwNPGrv6dGhuHwBTuvareANOy7eKgYLJVKiWsqvKz2J7IQ41OdkgI6oWnQyZL8qZ7ZV5MOQDVKgQnOQz9LTMnx1HBF8DEErwC7P7_PYQTq2BIWfHT29LWfbuEPuNFaED7gcAg7C1OGTQw0CHsAf_lApdHahNvLH0vGG7_-mn32RsxqNsok87P5ziJAFcOUvItAZP8jazYvxCxRmRHfc7d43pGdPYDYVELMoLGnUE70ms7Lu_abfkLSoFCM-SVZPx03pT57YPKOCT8uedBk8iMoNoKcgQyUj6IE9Bw88EwxALLyREMYqe_OvZ6qGjXLtR8CUaLSDvsTKytmUJUpfFzpJOQXUddsNgcglmzdIMI7V9wvAMHPRV3G8EtlCOGmhlA4w
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: 232

{
  "id" : "mgl_3RubIBhfRjRCd7jBR9oXqN",
  "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.eyJhdWQiOiIzNDBkMDk3Yy00N2FjLTQ3OTQtYTA5NC04OTkwOThhMDQ4ZDciLCJqdGkiOiJjY2I1OTIzMC05MjhjLTQ4OTctOWY3YS0xMWU0ZDNjMmNlMWYiLCJpYXQiOjE3ODcwNjM3NjEsIm5iZiI6MTc4NzA2Mzc2MSwiZXhwIjoxNzg3MTUwMTYxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR4bGdGYTFueWl6WThKbTVYN2JFSXciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FInB6GR9E6rxt_S3XdrNeHwTE0wLKrQv3-hVQWljXZDyH4J3Jeg3DM71UOH7hTQfiHkGVT9HOPL_1Jh7ckJDXKG2iwAyGGJxbc9HvWjvHA5jf-N3IaDXQI4mqvaJqLP0KYN3ogVgZUEOJ-KChE-tDi9LOUaj-aMja2GWsrS-sDB2IMvkcSTolc5O6-vFrJxIONMbKJfpQKZYXn8jomPR8CDtcPO0VdwGSuQWFEHOcCdifj_lTMb0GniFdtDjxkXCxz_vRBT-FdWeGv4-bnMiQwQIjPHectpIz2Yd-tdQTtD4s3DhZklbBenC1KEUktja-LswK7Dt1BmIcmdozpHN9iP5VIwdBZmdzcDROBtVVWo6p739c2EONoxl-2M4E4cjJo6QUOWg4LRJpR7bJ6xeehg_0x9UgKRShIBXb7_Z2ehSvHHW5FF_s4q2zjb0yj7Di8N-7UJob8ywuhpSSXlnAXIjGSnY4dKxeSfu3gdd6_kP8r3sDYarg_t9uJvsB4p0yT2YuCuQkAt0ajpEmtrjvg9h2d9yBSXsL7VmOXHESPJeNpDD4m8Otek2x9kocaTqwsElNW8j8uYWlFUDzCuDy3JQg0JvsEygHlZSFXkxzUcz8bTwEkovWrIdaxm5hus70OxMOnzE3c0ip7ru7Amh4nucyvJpHu5mEJQaYLLKxss
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: 653

{
  "data" : [ {
    "id" : "mgl_69CmVFk83MCNy234Ac66gU",
    "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_PWcghJm3HjcMSrfKPML2s HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMGNmZjM4ZC1iMDM3LTQ2N2UtOGZhMC1jYjdjMDYyMTlkZTMiLCJqdGkiOiIwNzc3MjM3Ni1lYWQ2LTRlOGItYjBiNS1lNGRiYTUyNjMxNjgiLCJpYXQiOjE3ODcwNjM3NjQsIm5iZiI6MTc4NzA2Mzc2NCwiZXhwIjoxNzg3MTUwMTY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX29qWXN6YWl0MXBBZHBlS3ZJVDVGYiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.GGgLKBzVOd-96Op1h4Rl14sNr8tzh-epCAPkqwf028Eg4zL6-2BDTgabXUthI9piPfxn6cf5LoKRs8Eww67_NJnf7m7ZYA_tb5MjoGV-Fe6Rghv4Cc4MVonSDv5plEoXC9PQF9iQNX50bLhigiS2GwX2qMTt816FuoG6jz3plSD6F99IEiUS9bazPEPYq7HSwx1S850IdTj0J6On0xJPRKbZFap0f6WbywpeXTO4VKAUt3gSyFb_VDK1H76Mu3M0DcF7V2Fnpic8etRdBwGim5KtppwgVSJ_E-ivvaWMtYMmBPmruCEVsF0pido5h3ZRxaaVfu6ebGd5jhg980hCRNbbU3YX8BuMyG6xrwaXeFeOhEPVZ0mDCd_aJlvTr-FmOjCr9tq7DPW_T-bbH_6IPpYR0qYuXJi_BJM7KvSoU1FYAGhFG9lm7RBlwUtBrSRy3UTAiFDn3eLYoozN5pTSqIoXl7fw3WuPBUXuWSqELXyRq994iol5UoiyRfuQOBQTDbIi0uc0tOQn0gK9I_0sEctIj7UpmUm3YZ9W_Bg47nvW9yKdYzyXfK-hQ5HY5EG4TjVwbopViLOt55NfQsG_4NH0V9rIJpDYnBITSGMX7wNRJtW4meK8P0guzXU1KOuBQcA3KFnm_5l1uUibFwRQvkki6K7OeG0sL8y5aoqQhPg
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: 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_5hVFpK9RJazlrJ9VDWcCUP/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyMmRkYTU5NC1jMTE5LTQ2ZTQtODljOS1jZjBhNmIyMTBlNTEiLCJqdGkiOiJlMmM1NmQzNS05OWRlLTQ5YzMtOTdjOS1hYjg0M2M4YzIwMTkiLCJpYXQiOjE3ODcwNjM3NjcsIm5iZiI6MTc4NzA2Mzc2NywiZXhwIjoxNzg3MTUwMTY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzEzNUtlTlZIN3FEalEyN1pNVUZzRG0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZmnvK530NxwUrereP-Oz-ybJJJszyaQFgoebmtPj90yc6SjlY7_bu8_M-sEoVzx4hMxPS7-xblvleNJZKcklKjL486O1_rMNsuvfgVtf4-o52KOPwsUphLLyS9freqcm81JaFexXxnNkcSqJP_wWqVOpLi9JyJ_hB4qYwHgNgCvTJ01YQuT7si9f0YYAXmkCGNeFdSfFsepFp9dwbBZOc9jr0BHQPiiQxY9n_-2apVS9HUpvYrs18IYmrgbrdIP140l2SzBtEln6Itnkyx8Zrw4VxfOJShz1mwMOX6Lzy-VIlpvW-ac7Lzjke-4qXs23b0vAFo6E1FAeXByphbv6nCNe1D2NXncK-vw63zmse0kEpe4BG2va5lGTgi-rXOvlZsgDpkFL9BuMcLJ_EsoEqwHYIS6Ltm6kLINQucUXLqtVCZqFZ2XfSuQL-jdxLLrST9Y6f3LLbd4cvQr_7gLLcgcOhGipGAB0gcPq0d4OQbJQAN7UohJgUw-Ychdo6WVRvYnj4Qzq6RRWtNvaHY9AiWqtvO3ow5ggrCw2uDhHEXXYK6eNhI0UftJyf9v1llXxoPaxfEQdbgB5V6ZZVb8Bot_Go4njrOYvkoU0LW0BoBlt0piQ1UCU_y4hbboCf65-XbF617i-DdmKtH64wUCHcAMlhP_HR7zl2zxb6o_j61A
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: 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

{
  "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_2ifL3LqTMM5C4kArv43TOy/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NWEwZjYxMC04MmZmLTQ2ZTctODQ3NS1jZDZiMmNhOTc1NzMiLCJqdGkiOiI1YTk0MzdlOS1mMTZkLTRhNTktYmZhNS0wMGQ5NTBlYTljYjIiLCJpYXQiOjE3ODcwNjM3NjksIm5iZiI6MTc4NzA2Mzc2OSwiZXhwIjoxNzg3MTUwMTY5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdRSkp6RmZ2QzZGdVgzejZPUG9IMXoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.E-xqh_U4Phytz8k8J05FPsSZAp_m-kiwKwIsd-yQp7vgo0fyQGGz5ltWgpxMYsm2FcADuDkF07ghyIho4W6LWqVIpG_QQVls5S4kynv-WaWXWCdxBNpHrEQO3PhJN14h7N751CitvIWt9BtNjtHa4tGdtf2hti-_QjZKJ7C6kZ8tb_15p4cOvam2GNr8-KIBlVE_ouQqgfAKaxU4gzfBpASU5g0vWAveNHKpPGmNJzGE-UYQPjnWVD6ACIo3NOxRQeXg1R1c0szo7gSS0hFqsU7DW3bqmDg-9kZbYtDG9c45dy039sVjV-1epq_AgNGqjt-_7fvEZXZsuxtlpcoeCaNUL-lA5AVGhE0c3Q8AgcYPAc9BijV8qHJELAmnTlgrRda0UM32c3lb76xZCkoucGWBLwDMluP4yWH20aoFpvroxLnG7_o94oMHO3FmhbbUkHnAy7-rgFNvVd3LWu8mbNFBFwkgUwJAXES2KDUXRRhQF94v9g_NAA1UHj28o83K0J3IPQ7EGDbmvw7V_qzxypVG5Kjig9NZA6CEgN2BzShwzO251YUf-YCh0jP_58Ns-3oFTXx8CVftQdclGviOJdNr4Xl6EGNq06Rrk7JPu37ms93BiZOnwQ_uVHxYkBw5xgx8vn6TDBO9qkrJjvdSPcjv8hg8RKH_4qJerDY_2Vo
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: 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

{
  "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_63j1VnkuMsF83CHNtQd8eT/options HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNTBiMzg2NS1lN2UwLTQwMzctYTZiOS01N2MzNjJiNzA2MTAiLCJqdGkiOiJmNTZlYmZlZi0zYzllLTQwMmItYTkxMy1hYjNlNWJkYTZmZTEiLCJpYXQiOjE3ODcwNjM3NzIsIm5iZiI6MTc4NzA2Mzc3MiwiZXhwIjoxNzg3MTUwMTcyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN4am9RdEI1aG1IUzZCQzk4cEpOZ0wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Jy8HUm2u3jJoYUNnPbJlhnYOLa5PZwHFZXQJGE2sEvDa0RnYK4IpIflk-LNX82NU2YlsYFardhSjQnq2HHKjNMLPCmP9SQU9ZR49Tb4ynqwkypXG85zkaMf863JJfUWTfpGaq1lQ0OkttDiMRZNgTnw14GT7_PCnxzy92gQ2tRocnDc5TTVs113pHIjBNgbeP0IW20B02E_wFe_FeKI2ZOvil5jrlrGQTIJTBUTApcycJQtwn4rrne0qN9INuD-_v4ZT7B74DKMltFMRddDUbEMQ4IoPYMnZSngjA49lCzomxPniPJOE8_ZHCg56g2OEX3M5XfBw_pPGPL9LZVUxdVzqWstjZPENaf81PPa1BeM7fqbzSEYZndjuAQ-69T7gtLRE8KbE14hEnM99r90et3CSsMcIsjTFjZ-X2Wbc0v3nF6UBuKOJczmeLL_ngWuvux_nOA4aUryi18oaIYCqY5wpCbHL2ZiQmJ-If7pAgvlP0KpCx-_Ic3i-UY--9jQV3toaB3NowsuHFOEJr3Igv7BM_qc_6XZ2fbyAL2-M1K59QUqYHpLUv8Gn_55N-D4dLe63_WVgMVOiKeVI4EBiE_R6c9dnp_kFgVBK0cDuRB9ttzgR5XFBNu9aDHmZNwWh3T8GzIrZgFgxDni6Aoebn5kxXNFPl5cVqvhYf7V3MCw
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: 605

{
  "data" : [ {
    "value" : "B6129SF2/J"
  }, {
    "value" : "B6C3F1/J"
  }, {
    "value" : "B6CBAF1/J"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/metadata/mgl_63j1VnkuMsF83CHNtQd8eT/options?page=1",
    "last" : "http://localhost:8080/api/public/v1/metadata/mgl_63j1VnkuMsF83CHNtQd8eT/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_63j1VnkuMsF83CHNtQd8eT/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_6TGVixONQCYZx3jO83tcv9/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1N2RkNmI5Ni03Mzk4LTQ2ZTQtOGEwOS1kNzk2OGNhNDUyOTciLCJqdGkiOiJhNDkwNzE2MS1iZGYzLTRhNjctYWUyZS00NWYzMGI3ODA1ZTgiLCJpYXQiOjE3ODcwNjM3NjcsIm5iZiI6MTc4NzA2Mzc2NywiZXhwIjoxNzg3MTUwMTY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRPcnpBVm5zODQ4bzdsZFRpVmQzRmgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GU5neTwFu3wrD_-4xgvVCwjlnd9KFLV8J7I9TeAmdYd9jsF5nl9vEPouet3UCoUW8hnRJIHV6VoSdn75v9q_ZopkqUOA6yTYN3oyn7AE0GGA7jsiZwVuGt9np6eGxkVW76jF-dyvCBwqAh5ronIgm6TdOoyP9gNCa6jmzGqGvAVJ_g03WrTpj2F3SFZbJjgqOLwLLfKmzijqavTazCb4hzxBAbrpHkjuJZXIt36d7u4pSIV25wWu8aq-yuMM772MxxbKLWe8yAa2-yjd6uL2CTaZuTklH6mGfq2iSrWeI_LiojkZE4mB7IMsl22rsyffB1zo-gFnKVK8I6LoqlqYRPoUqU1-ZYxbiWRzN6PZmrk4S3-W0Q4bG2r6uVdngrxoNPG7QkjoFaMqHrVksCS6EAAHbQYyGERPmUXoVVdUiTVNbTVb1KaEXaLQYqC6TFISdqDJsZP4LWGHMmyY9FiPZwsWzDSoFOnJOtcmt9ZVuqMiD05IY57I_cOdxYJm3V_fMps_CtpB8Ffox37GALuaCzrUHiXjIxBg94oJIuGV3T1O9CJGcbjuAFJKBJwBxvAQxSSeRELA9RHWtvGJ5ngZnRBj9C9WRct_hOHbMwXOFFjUw759-kzxrdwqnTNKNii3LU4z4C4zNkxnMpZgj-aZvGWQLYE-Gay2IKgrNXCIhkY
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: 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
}

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.eyJhdWQiOiJjMzAyMGVjOS0zMDJkLTQ1M2ItYjA4Mi1kMTQ4ZjYxMzAzYTAiLCJqdGkiOiI3NTVkZDUyOC0wMDM2LTQ1OTUtYmM5Ni03NWI3ZjdjNTg3ZDUiLCJpYXQiOjE3ODcwNjM4NzEsIm5iZiI6MTc4NzA2Mzg3MSwiZXhwIjoxNzg3MTUwMjcxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZPRDRCbVlsZWRIbnh4VkY2RXk0OGEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Paa35FFzvJXxFv3EF70aDZjav9a3CBYymr1VDxZbcIfXkLp50aeZe8roJe_w5XU2aI--xjfDt3Or-e325OnGyG30QhsXeTz0VrxTxv57lKGjnGN50S7SMkdLARFofNXrqpMZHixcS8xbW7aXqCIp72NsGona5Y9yjwIbIo9IcQz6OhbBLzGkZg7sYkML995xcG1n289RAxY7SOLfEcqAN9wvIZkSGB-AmlroHHLF-XPd2HlgONdUQAVZX2VRqu2QC5VIsxs4BnjHB_PMUfulF-DKRzlcFAsGjkIitB0crPq1y_Jaa76MU_KEB_P5hmtNfRvdwQTzc89fD6O_YhjCOa4JScTHaylp8dOcV9k_3aFMqV7BVE_I-CtgdxhoT-dqBDaTxCDmzxN6Ib9t95QGc_4CrjOPnHrUq3xhO_G03PGkj-T0DlXK2-lCeDKxyECO2o4m4pn_5a3RqDTTnFI6Sk1uNnyCKIos6qvh57zeW96qTba1uiJXyA-tGd9TUNX2WqYBMGh7VLkpvjCqM2ld9LD3krAHrt6JI2VOSNxiZ_qIf43mMyCOYmusJEoHgb9fgJIPxQhoQn229Ue2G9laHchmJAExQFrXt5fFyvEqj7tvlc6lAynYJElsA_D4Mq5oT1gNybacYWLRQKK51kRJUMmAJGfItIwoKmcVJj0oPHo
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: 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: 696

{
  "data" : [ {
    "id" : "tgy_3UVLWw75AtFgvgMg0o1tQk",
    "title" : "Body Weight Change",
    "label" : "BWC",
    "description" : "Percentage body weight change from baseline",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "100"
    }
  }, {
    "id" : "tgy_2bAbhRoH1CStQNVUV0Bc9x",
    "title" : "Coat Condition",
    "label" : "COAT",
    "description" : "Fur quality assessment",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_2ePXqmcnan4I65d0rcUURQ",
    "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.eyJhdWQiOiJlYTM0ZGYwZS1iNTdiLTQ1MWUtYmI1Mi0yMjFjNTNhNDRlMTciLCJqdGkiOiIxY2U0NDJjOC03NzAwLTQxMzgtYWRmOC05NTVjMjRkMWVmOGUiLCJpYXQiOjE3ODcwNjM4NzIsIm5iZiI6MTc4NzA2Mzg3MiwiZXhwIjoxNzg3MTUwMjcyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2paQjhoUUFzOTdmemdGT0ljTHNsbCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.e3DPGIo9gBhXy-zA8baTqtNvwyF-QiI2EhJCDyscwAVfCC5ypryeXxAvga8CqhwQYWp3H8ovxdACVnnFWarMPKnoS-MIlXVmH53ZKaYV8M9hrCRUwu_9rJwa-cuXpmpAxUuCg31u9B3bR7r7-F2UJjaF3JzQzDEUvmChBrmaVtLFhFid-uI2pFP7LFdqaw-pFPv1UT1awh6H1V4bkp9jNiLy3obYckPc0azs_uZO9i4Q-8LR5P2tt7Yk1PpAiirwe_bDe5Fie1_pKWWrh3isBVcr6FbZpjHUU3CRvwmYBgQUkiZeJLNZiw3FX4Z3rO7O6jUuhRJiL3MqrzIxuLt1Y_5MPMHVxxMFRtSO_4UVxAPFoeHKgQNIoaR0mXiAdvfxIli_-YFG7xVz_V6XM5GHBPmRxNcWGuA3-Gngn1oqDdQNBNenifqtubOHmqKLoRZrcOTqHba5ImTUHnAngkketPyXcAOKFupnTbux3PkFSJDfDMAmvnclNbwop_5Z-9hvD17AR6M6pASFcwo3Jpi0P4G9D8GVSpU0pABJ-gtTWaQn4a3KSiZkJqLQ6wcjixLpQGmV9GLSiGLi4Lm6ULhsBYDhiNoL3Q57sRmTPP3tWySHNGnjnOIFktDTGG5N7-6vsjgeNWeqn4RhISCcFz72w8rM4uvLm5MN_vC5YYwdD88
Content-Length: 547
Host: localhost:8080

[ {
  "id" : "tgy_3vXk7qWjByQJEWaDhR3Eqh",
  "title" : "Alertness Score",
  "label" : "ALRT",
  "description" : "Archived alertness assessment",
  "status" : "archived",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "10"
  }
}, {
  "id" : "tgy_6wQiGYNpIvXcW7cS26YVAE",
  "type" : "numeric",
  "numeric" : {
    "min" : "0",
    "max" : "5"
  }
}, {
  "id" : "tgy_1H22VSOh1qfo5ODb5BO3mr",
  "status" : "archived"
}, {
  "id" : "tgy_56z87qyh5GFp5ODYAnAOq0",
  "description" : "Body posture assessment",
  "status" : "active"
} ]

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: 891

{
  "data" : [ {
    "id" : "tgy_6wQiGYNpIvXcW7cS26YVAE",
    "title" : "Coat",
    "label" : "COAT",
    "description" : "Coat glossary",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "5"
    }
  }, {
    "id" : "tgy_1H22VSOh1qfo5ODb5BO3mr",
    "title" : "Gait",
    "label" : "GAIT",
    "description" : "Gait glossary",
    "status" : "archived",
    "type" : "none"
  }, {
    "id" : "tgy_3vXk7qWjByQJEWaDhR3Eqh",
    "title" : "Alertness Score",
    "label" : "ALRT",
    "description" : "Archived alertness assessment",
    "status" : "archived",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "10"
    }
  }, {
    "id" : "tgy_56z87qyh5GFp5ODYAnAOq0",
    "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_6N5VbcaxA3F23eAkqCvPXD HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0N2UwMmE5NC1kNTAwLTQ0MWMtYWMxNC0wOTVjZmZhNDE4YWIiLCJqdGkiOiJiYTUyOTNmNC1mNjYwLTQ4ZmEtYjRmMy1lNWFhYjI1NTMyNzUiLCJpYXQiOjE3ODcwNjM4NjMsIm5iZiI6MTc4NzA2Mzg2MywiZXhwIjoxNzg3MTUwMjYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRZUWJOUEJwakhRWVZlZzFjTWpSYjgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PHdBx8D3m4hMnPAGim-59aNflgSeqPlSLh5Sqp_85sz1KPsoSTNB13Ch-FcxyBsjHR3FoafJtjCdn6Vcoc4ErEec5N_LeU3TgXMMz5qDmdTTrbMQ6J6u83qC9E7xkN5HaDiTsUfcSnhjojNvpWIEvsc2dkg7_pk6u_n3O2Npu739CYuoGn25OSBiInOM4PUi12fbfAnOAPBK_KCIAYLet8ByO1b_930O2RqJwCpl8O5Ek3jdvEUF25lgiKJev8UH3xNWspvedzyvI8UvNSiQsYt8BgmHzHk5MrZ-Q5T8VvF0TPgERlOocEKzHBwA-OuM6BYIk_AGalBoC58nRSFPoNmqs2N8JQwsfhVjBrV0l5-gZMnmEPR3CzSK_baM-32GklFlFQKjFSAjRRhkaLqUlqfAyqu460NVlcwIoPjwXdiIKmUUf7dnazn0HlWU4JI0s8Y1iBKTUu9t53S7kbkjAP5W_BfAW26BV9DlceWVzZLWDKbDVEI65VpJuZzxYI9Qrfal6T60dC_MHoF667qiXj1714YyhwOGCgrQ-4CYsENHOZHWialX6CQkKSSu04Fm1sme0H5AQB1c_OmyHMsysycJuNKhJvHMhjD8Xss_w8jASMnEozGESHq78MPcSq3uS52nchGKJzTRksA6R_6gyw0hhLPvhtL7JWkagsGaZw8
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: 225

{
  "id" : "tgy_6N5VbcaxA3F23eAkqCvPXD",
  "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.eyJhdWQiOiJhMDI1NWViOS1lMmQzLTQ4YzMtYWNjZi0zMDUyNjhhNDdkZmIiLCJqdGkiOiIxM2JiZGE2My1mMmY2LTQ5ZWItOTdkYi1iNWUwY2NhM2NlODIiLCJpYXQiOjE3ODcwNjM4NzAsIm5iZiI6MTc4NzA2Mzg3MCwiZXhwIjoxNzg3MTUwMjcwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJuaUtCQ3FkOTlNbnhJajlpd2xxQUsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.dgsvpeBJPeRVm8T1XcOl6smYe1P_LGFrhEYn1DH47uEoWb7KPPPcvcC6JQB_X12aanfWXMImkuCaYx2DrA4oWaE6XOwbXhePJcreZgbE45m3W4jalCVqb7U4LylAitJdZsarI-ik4Mlh7K-Z-8jqfn9OR_0LJ8CkyUdY2_Kt2STYnHmbXdF2ks5fiNcW9-mNvgMdbqVrItEXJhSpi1Q4SKkBo096sAybRscftp6c9hlzN8Rdlup2YlByBiGtxpPKEmgtjeArl_3hrHLF6byFgwDVDopQ96pGY4zGJPO4A7hCRMehyxAwClkeKprg1uAl0Kf7_1W3QIfi_HxIpLIIppcnhHBvIWJxhl9YmFBf6Z80tYJREW01SnKDa7JbjcnoIkxmVf31S2JCQ0jG2g_ibm_sgtjBUGMdeLbWMoMgJY2U1JTmW7ohaeYM3ZaqBQ_jz2UuYsz8sScXj1zEcfAe3mQOTlqZDjNFKt_C8vuhHwMv8t6QQ6jhKduJAXwPdA_9Hi9ywMud5Qr6yS8Z1KgwCgU0vH1odFk7jW8MU8yVA1XGv6E7CaoMW5MlcEOIcxcZN_ZsE4EDC-0n1jZTzWTiZr04K81mRanByj-5uIFubTUrXYDTo9TSiS00pV_K84dUwGbuCZoTCnSn1TeHfMNveUGoysYVtC9BrnZVBALnmvI
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: 965

{
  "data" : [ {
    "id" : "tgy_xJ1hxyuCKPzBGhEwPZljN",
    "title" : "Coat condition",
    "label" : "COAT",
    "description" : "Assessment of fur quality and grooming",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_4QW6EbcdtFpwImaXVmal81",
    "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.eyJhdWQiOiI3ZTViOTNjNi03M2RmLTQ3NWEtYmQ2Yy0wNGJlNDBlYjNmMTgiLCJqdGkiOiJmODFmNjY5Ny01MzFlLTQxZjgtYjBjMi1hMTAwYzM0NGQzZDAiLCJpYXQiOjE3ODcwNjM3ODIsIm5iZiI6MTc4NzA2Mzc4MiwiZXhwIjoxNzg3MTUwMTgyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZ0UE5ncTIwVGVtUVFGQURSNFJXdGUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PBGXt7SNR8OZ73TbfqKmGCgtlQdIvBpQHxUQX5osVRzXvoDz7kQORQTwAZtmB41KUERFbaF3iD_sMOOYakJNUCTI-KdR1-Ooo8vqKhaxbdORs53yqva_QJLc_Z68syfZRKSf6ajSjqLLgXUQYvNzPloL4CJckQVmPrmrKQKaW-SA9sJUUaiNsrU6ZJt48InpuKM45tziG8cD-M7TZKfBOwgvzvKKtYb0YeWMiwq7NuQh77hkdynYT9H-TK_6OsqYHK7hKHIXFzWQZPTWhLWnWFYcTFyqf9WLs9PqqYSgVewR1qlspRlL0mRqrT2JD1Dvc81g1ZpYNx0NXqdHmH_pQpyRgB__d7iV6hOul8VjtQJDGEporXm3Zy3YgYGoMa5tKLbWUU6hbAmxGZEZfNUojD9HSVSbmyNeLOVz4SsTOLtpQl_06zgbIURA2PY6Xkuyk_tZbG6zSP9ZwikGOIg7XwveDaoHCL9mF7_WZKBj7puDSPUGLIQmn7F-euXIeNqattNr7lWEAlIoCIGlUODNWu8NBfWOQ_0ot_29lr6wE9bMNFVInvqPMjo4vDW6AiJ_rVSJ84a6DqUivu3bge9K03lXfQL_3gGoy6ptk64aeJlsIYOdBX7Lzd3sAnHSE0A9NuRnQnH3d4akQjx1hBfHn0Bb-wdqXXfYeYaeGuI1R-s
Content-Length: 89
Host: localhost:8080

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

Response

HTTP/1.1 201 Created
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: 223

{
  "id" : "pjt_xyA5ZdMtAyI09jD9jhiTI",
  "name" : "BgGCsbYsSU",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-08-18T14:36:22.598265Z",
  "updated_at" : "2026-08-18T14:36:22.598265Z"
}

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_7PIIe5DUm1x4fmSgWZZYq4 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MzJiZDAxMi02YzY2LTQ2ZTctYThjYi1lODViNGU5MzlmZDUiLCJqdGkiOiI3ZTQxZDg2My00ZWIxLTQxNWQtOTJmOS00N2U4NzNlNjEyMjEiLCJpYXQiOjE3ODcwNjM3ODIsIm5iZiI6MTc4NzA2Mzc4MiwiZXhwIjoxNzg3MTUwMTgyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVITjJEM3ExT09wdDh6TXZHRFhPZlAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UquwZ2-1Yq1JkqY_hc97i3pPYf1WimC7HFlpwwtZmmhCZNYZzbJaVOw5jNkIWWU1IPWtHzuQCnynTQmEcTRJpfVmTrHVBRJjR9ylTtKreFq-QeYqMV-a3fyPX86dmZfYtdIKzgM7e8oyMhifVJA5nuM6A-cZt6N8f53CbgoI-tZiFiXZ3Jlm4Jv9cZ6ORAcOW-AYOi5HAa8oKVjPbE_Y1Hg6S-RAasOamvuJfx9u1f4Ez-VS51uSp-XvJYP2XucOf4R1Z-hquv7aLn-CGRQCzzX0MaSL52tE3pW6PDcu7arnblqM_Kmqg8cOndDjtXSS-SKEQDMxP9ycjxK4Oe3k5S7QSV3UrOomhA9t_m7xF4rBKcv2Qx9GDdRRmqdLuMCH5GLhD3jnYmdP4vS6Ij018D1QTBPhMZnvkmrE1s96d1hu576jQiSzK4l_5uEJIrXg2y6w5_ZtoEjfZ7GjsvpLNEA0z5tCYVsn476Ci-urUDg78FUIh2hfW4nORLiP8fNt0YUZB1Wydwy6b6BhJ1XqYIzyAem2sszqhZGMpgyMCS_OYwLCy4OSqYmGer81lPMFPLu6JqQaxJVATWpges9wtOntUGshlRvy7QSDjW9RCJgAeNm_9zIOUCAbPUcIc6lbXNgj6okUi9VhEohhUSVIeZvBoatCi4MoGbB8ngaD22c
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: 224

{
  "id" : "pjt_7PIIe5DUm1x4fmSgWZZYq4",
  "name" : "R4M1sGcFbW",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-08-18T14:36:22.324100Z",
  "updated_at" : "2026-08-18T14:36:22.324100Z"
}

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_1kYTuTcoeIBTLXFlh1eeZ5 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1Yjc5MTg1Zi1mNjI2LTQ1ZDAtYmEwNS1mNmJmZDcxZWE3NmIiLCJqdGkiOiJhMTg5YjY5MC1iOTQ5LTRmYTctOWQyMi0yZDg3Y2UwODQxNWUiLCJpYXQiOjE3ODcwNjM3ODMsIm5iZiI6MTc4NzA2Mzc4MywiZXhwIjoxNzg3MTUwMTgzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJTQVpoajBqaWZFclpiU256RkxMMGoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.esmW1GnaNC1Y1WctRWpdxFv69BDzmmaXBPJlSN0Cto9DCpitwY1Ow1CHiLUPnZJL3UzBanyYoW6jwaRKs5XyXfvwjKqxBJ6UGnBgcLwDca1wm3knafZie_Jkx1fjTZ2UgvSbyIszw12v53aSljUvpumAfTDS633L7a6XIONzRBfOVnqwZoYANCN7HQxYxu5z-BQoSEDShmYEC54456ZT1b8ZqBHS-hPlD5IED2ycx99R9nV3Z8e9pRiLVxwI3fGVCci15y1flaysrOAmhYvzxN6hCJ1Tl8KYpBZSxi1kgm6gGlfRgG8F5YPt2XFAtsRkkdEcXovv8KM1hHXLnhqcoFcJ_gPjqEa8CeCqxv-NnLTZ3ptHJ7eHVk_L3zd9FBuLDor04HECLXT92wrlh6POnFtc90BjJQsFXU86VSQP6gutfRhoNGdlXyRlOdQULXBqBlhGHJMcG7sVpjr9r92_alPcjyofrL9V8DkAbT2EMdKkJKY50qcNDTGiNeZ3X6a31ovqryKKvIQgYMWrHjt0yxUto2kjLJ6TnIx5tkh8WA8PJB0ME19cfCKAeyX6C65U3yBOn0Y3Ocmi0SsrkvgBrC0R6HDM556JoSZP_9z5Dhfq43mdGIwtPRvu4WmpNvm8WJIFKdktjS2oll_uWfm0nV9fOU3o7-DbIWgQ72jNlPs
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: 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: 239

{
  "id" : "pjt_1kYTuTcoeIBTLXFlh1eeZ5",
  "name" : "Benchling In Vivo Project",
  "metadata" : {
    "project-internal-id" : "PROJ-4321"
  },
  "created_at" : "2026-08-18T14:36:20.037923Z",
  "updated_at" : "2026-08-18T14:36:23.176572Z"
}

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.eyJhdWQiOiI0ODY5MjQ4Zi01ZmVmLTQ4MzItOWMzZS04ZDk4Y2M5MDMyYTIiLCJqdGkiOiI2MWQ0MDE2OS1kOWE4LTRjMTMtYWE1Mi04MjZjZTA0NGU3ZWIiLCJpYXQiOjE3ODcwNjM3NzksIm5iZiI6MTc4NzA2Mzc3OSwiZXhwIjoxNzg3MTUwMTc5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJORmlwcnJBZnVLRnNEdGJnNG43ZFMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.YmAJGLX0yh5Z6HHs96-6fqSyZ_9h0-0swkcuVZ4t_jVsSSCvLI6kIgX9_tnRjw1FoLv8AyLHnHJOuMxcgKNVXh1ioOeNVF1fjEW2ExzTJ-WRuGz93qFwPHvbzG4Tn776oSTNNLG2RF2ywDxFxxCDDCV8O5sq7U9IwZZ5XBe_uMXE3SrtI-lWbFM42QG-g7_AMoK3TFaIRa4jdIx3t5CHqVc5-nZQLvCouIRDVxMsgSuW7mTlytzBDWl_sdB0phtxj6N5xssLBxSXAAKeANTobBmPi121fhJ773XithZGt3ZWTEzy0TFARPBa7Y3mtpQRxlrtSGMoRTLm4BoE2T0P1u7FVZSWbv4tZjRq1otTOmR_UprarcU3wrz4W1pri8Am_RZSDcHK_yxjbRzxCyTH_XrQ9lRhf2CC0sEoReQttTWyHtye_40jfFQHyolryiet9lwPF48T25N0aghW17ReRwnoYIWjccZOhD6ck_RwynY-RDLddyie2hGtOkHDEcEGVno7xoNwwUDH9HW2cowJKXoQ67VCrU12A9ywIHQaEoqKZG2ggbl38bmHUw3OdogIyhnlKjIK1hWgeO7HruSfoYJB8wo98r93wLk4-KORL7BEFapRus1vmp7aIQs8xAxfNG4ru130ghxY1SThsUAeSaDWyYpsB1giaN6R6xmcYok
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: 643

{
  "data" : [ {
    "id" : "pjt_3FL0rLkyPYQwPU0MlP9bWg",
    "name" : "Kog8zJL967",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:19.492205Z",
    "updated_at" : "2026-08-18T14:36:19.492205Z"
  } ],
  "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_7GSy2Ebqskc2nJ0QJ1LPcH HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxYzk2MmM0ZC05MmI5LTQ3YTgtYmFjOS02OWY1YWEwMzAzZjciLCJqdGkiOiIwZGE2MzdhZS0wMGZhLTQwZGQtYWQ1My00NGE4ZTMzYmZkODUiLCJpYXQiOjE3ODcwNjM3ODIsIm5iZiI6MTc4NzA2Mzc4MiwiZXhwIjoxNzg3MTUwMTgyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZUMnBzYkNnZG0yc3pVVElsU1F1YVEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.bWt10bSdFxdLJrv_qvFnxPpd6IOi4Mp2Q4u1QzUPU7khMvk3jSQtF1HU3TmSGf_JfIuB1g0QTDKugIneSWG4UvpojyFUYMbxDFDhXJoSIBwxRKnIH_F8i68TVPDOhqXAs7Ra9E4dldwT9shx1FJmRGrE4cn21m3WBmkiM7CWwc2V0r2FqViKhlp5I592Nzlh7LAF0ijolnMV0EWTzC41pkOaaBJVSNDAYhVN76JDAiYVPXf04JEztOELCGkBH2cP0mHtxpw9Ud-LHkQ03DBO4EaGrjPiqrAzupjsfiBFcwHsWPe45V7M1wSBF5hSWCL9UQOb15ehqae4W-osILnitbtDugnbmz-Fdm0AB7hQo3NChSVl2WgxvSxfdeWjsi63vNqDq9NTkJa-5dRQdxk_a5Rm41kaFJH0WZ-NsuorIcmtnHXvADtZkzNTbOrP_LNJtQgRiFALQ_N8QilkxKBCVDdHnRe4NKKIoV9LIN6I5fz74UEsFrKbYfXfKMSL06kXkK8KHiLDfrnAto3a3cPyobZF0nYXZ3lkQQwJdFgpmgQLGaDAfCgSXKYcJj7RhGppnDUXDFvc9O-0fMNEvYQXYjT3d9SEs2CDsu_4EcFeJC-rvRnkd_IHLBnju5gtjKWMoyWAB9QmOoNRSiqoTil2Sh4tDPZJz7AeAmP5CRBBlA0
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
}

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.eyJhdWQiOiJlOGI3N2I3MS0xMmZmLTRiNmUtYmUzZi00ZGZmOTY0Y2FmZmUiLCJqdGkiOiJkMmI5NGMyYy0xNGNhLTRiZDAtYWQ1OC1mOTE4MzE1ODAwOWIiLCJpYXQiOjE3ODcwNjM3ODgsIm5iZiI6MTc4NzA2Mzc4OCwiZXhwIjoxNzg3MTUwMTg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR1T1JFU29qWUwxRDZsbGlxSU9PNnoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.i8i1o6uF6tGWGmBZZlBP8T4dCNIi-R-P-3rYV-Qse_f2G0ldnpcPHE8Gl7RUv2QGWv5V9nzsM0dil3kDsubKRjpOkT6tYp8Ewp1dibHymcawDOV9wUjLqUVdnvv8wJ8FPSlw-97BFwwAjIrYIlh-8XrMYnA3ZkPYizyikCS1m9yEV83z1Jy8rlREIKSJdyMKhp8FqtyKGjAoSzJueBQW6T1XyG2iNsiXjO5gZYfaUMzDd_e_NcPOBmuFPqedhtIZHSX8oV9dxZdu4JABU4FC3xJ9JbddvIod31aWSf7KmZJVfNFgHDzMZyF2OHFYwORP65xDWWEyZBVwaJOal8i2avOA283VXwkD0NhfJcSkYCjOKBYOhSBWZpnzotvteAyVRoTFqLojO-39HJk_N7yv7izj9_2Xq9-sCLyVH2TvooecntAnqRLa34-0UNpSmFTSoplqIRVWOOWD0Tto2xUSWEC4qljOaEan-jq-FNMZhNe1s79zmxdvCUvFGOLMmvDU9fJ38_gX0fkgwpJ-b4qyZieLyYgG3gBfSeV8mLZXd3j4XTLMcgYTR08_75A7pc_kTc6weVBph0__J0tkz2cFbGyFLsbL7rA7Kyg2UX6j1KW_aR_OuZuccEX9PWKH_viJUdug04WedikUt6PHdZ5zbbR50os_zlKZUZ2YdPMqWus
Content-Length: 99
Host: localhost:8080

{
  "name" : "QixMXT9PcS",
  "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: 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: 234

{
  "id" : "prl_5csGha1ziOy6SQdQewxNic",
  "name" : "QixMXT9PcS",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-08-18T14:36:28.460913Z",
  "updated_at" : "2026-08-18T14:36:28.460913Z"
}

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_X8h7Ry7F4h6gEgVhTySOL HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYzc2NWQzZi05Yzk4LTRjNTktOWI4Yi03YmIwMjIyZWYzZTEiLCJqdGkiOiI0Njg4OTU4Ni1kNmU1LTRjZTUtOGUyMi1mYmYwYmNjOTQ5NTAiLCJpYXQiOjE3ODcwNjM3OTQsIm5iZiI6MTc4NzA2Mzc5NCwiZXhwIjoxNzg3MTUwMTk0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFTaUtYMlYxbFg2M003Z2pIZkd1bmciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PbbyEQ5MqKLHdJfPk1Hu-FbvkZOHgEqOth_lt2JQCdOe19g4iaYmOGJG9QUZModKkKddnZ9pF9o-hYL7AqVtHlnjos8Wps2onRxreGRNtnHNppefHjhInNturKnp-zMi2qmYH-BhpBnAbFTEXkTDB7hiVAMqvNWIn7mADZrJsZOqzZQ2l_jjJeViv780u4bHmEY6GsNLH2xP_DC9h0VvidvPPhbdEr9R50cN9FmPnv7aYOPhCzeuCGvnSzDF5gR-tWY29iflqrmdhBo1dalzsnGnDRNSa9qDiXeDG0VvXUWkLcZ_jX8fOMtm0LYxIUORykn3xxmY05E3bQIJ6kfV-WYrgLSGjRZTmXPcVqlFHttsbkooPROBcske7eAsd9m_un2IK13y3_GGwlrle5RfZOo1hwHGY6jvHit7rHszJ0RDmTN2oaTFdd-HPEtTuUE6ZkcmJZjsy1wmqDnHJyMmJKFGhiZIgLVvO7FoX-nPkov7RhRGMfF7uVrfGU2KgoVoaORe_ZfU8yAacgKDVtkOgFkEhSJ2chWr6QosJyqsjYO-1crEmYvZXvonn1g2YczU5f2tLNS51AaWwusBx-XRp_jFCXr65J2sLIO6Q5XlQXOHFmol9ILTShVtaX3RTUY-QWFsgVN-Ge54qkF565rtOAwUeM-oEa3tVSA9T6EAByo
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: 233

{
  "id" : "prl_X8h7Ry7F4h6gEgVhTySOL",
  "name" : "oAemYaj9KM",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-08-18T14:36:34.595171Z",
  "updated_at" : "2026-08-18T14:36:34.595171Z"
}

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_4KypdZnREPPWt2oCCTNXNn HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNmVmMTM5Zi0yMTM5LTQzZWUtOTNhZi04ODc5Y2Y3ZDY5NDUiLCJqdGkiOiJlZDQyNWM1YS1lOWIxLTQzOTUtYjk2OC0yOTIxZWFkNGYyOTQiLCJpYXQiOjE3ODcwNjM3OTIsIm5iZiI6MTc4NzA2Mzc5MiwiZXhwIjoxNzg3MTUwMTkyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZuYno3V2c1cENNOXNHbDZtbDRBQ3MiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.nWhhKPhEI5BB9oqkv5N4yHxo23-Xvu_BXCKqQ1M9uJNqXX2C_Ca_2LWLX_98p1ItVqXSuna__d6sMWJdXRG5FmvVsZ6E6FrjcDpx0NmwVGjbF19Lhy8kUO-ZHTN291aemcENrGMYM2Z7jKM-NwN_l2QKac0lg0esn4YT8fzVW6JPiH6KmaUmWCqL5BLgyBTPX9NYzMSUleJ_D3RkHKRhP2Lppbh0tniP0cAKiD4usE3PvYnWTaqk0vKF76ForEhMQ3Cvxw6zLUoB1F9KI5F99iXLpvocsJ4AszuowCUr4pHlkuF_rAWJubUJhdv2eSx63BofWuvstr44ZLG4bsVZnLcSC6QKsSqtwYLEqQptQADsPNwfdGad6ETeEJ6vSGJzpb3T3tCYjBGDOvqvR2Dvv95u-5HbmhUDhis-U56_TcMhlSIJtKkmt_vbLv7A-3PbDwqFj7EQipxibjdtEJ1ihbBhOqhrecbc6xWWVMYROa2rgtIzxqS_gsEDOzVUaIAHNm6A7Vw2TBqg7rsqbBv3tqRFZEXTE9ySE4byjGykWWTTROD3f054hZxBGW1jN7ZDk0_YOpuDxLFL8ijcAQ2vz8ywAGWivBUkjv-8d2i5r_oDpPUlDDcIEqEBzGAqPa1yxYnyTG2n3lbP1a8C-QKJKUnyke9Vo5DER2nhwNoCcq4
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: 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: 246

{
  "id" : "prl_4KypdZnREPPWt2oCCTNXNn",
  "name" : "Benchling In Vivo Role",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-4321"
  },
  "created_at" : "2026-08-18T14:36:32.227413Z",
  "updated_at" : "2026-08-18T14:36:32.316623Z"
}

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.eyJhdWQiOiIyZjgzMmNiYy1kMjMzLTQ1MzctOGQ2NS1kMWE1ZGNkZWM0YmUiLCJqdGkiOiJiYzM3NTk1Yi1jYzBkLTRjOTItOTFjYy0zZGMyMTI4N2VkMmYiLCJpYXQiOjE3ODcwNjM3ODgsIm5iZiI6MTc4NzA2Mzc4OCwiZXhwIjoxNzg3MTUwMTg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJxSGxVSUduU1M0ekF1U0lCUmg1VGwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.gQUifGJ9J2o0FusSCAa5hQmXRtQ6EVyEBs12EdllHEfvgz8iDzpYhcv79dSO0AqeIqDXzD7iBPkqTmD0kGWiwZ1R8BPXSctB2OVWTDWoMxjrio63DZrjfdtVA9U8NWIO6pJ5uAdCCHc2xuOHC-9WHPWKdqRncwtysmE6F2yxEjitWxTZqHySup_7jaFSQfbRuyYBVJAXVBtrnZ7KfsvvfFYjCqDgWa9N1YhuF8LjmntpHv6OGfMPz4Lj_h1yWR2tpmIj6k1aFCkNcjUT5fcvBCwnOB2PEKwjCZYeorXEzmAKo5sElUpzXBzfHqDuF1D30ACYlXH0RkNWQzbIk3Vf0LrlP8SzZf6orPrlp_7wHY-xfvqz_DBw5Q-8CtuICvEuO9l9sNm49gAMa_Yv6OQEFW_wBPTKcdMjutEVyR-qhgIIIad3_KIp4i7K3ZArEYPLxVejulq-kthBlw5BirZBl5pJv4vC1dHzCI6OPl0b-mUjdZnWHUMfSsxOzsCsN-6-yDfbZcwc6dZ8WapnFOywawcf92EFbrFUAZjkQcvtGggmH97Iz1RNZFIdb8Z26cBxFEkr204rOzFmE9gQQ68gO5xtOb-XCvWTIYVVrVjX-dq-NQQZwaaS0rW7NdM2Ej4bxVc7FT3CpM-Uk9FuXNbxXD_s8yZcvMpH2HZgZbsZkRc
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: 668

{
  "data" : [ {
    "id" : "prl_2iN3N71dr3DPaHEbrZSDXO",
    "name" : "DLObb5gWtU",
    "metadata" : {
      "project-role-internal-id" : "PROJ-ROLE-1234"
    },
    "created_at" : "2026-08-18T14:36:28.194023Z",
    "updated_at" : "2026-08-18T14:36:28.194023Z"
  } ],
  "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_pxm2GIyqVDaswFxIKc2JY HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MzIwN2UwNi0wMjYwLTQ3MjQtODRhMS03ZGM1YWVlZmVhNjkiLCJqdGkiOiI4ZDdkNjQwYy0yZWZjLTRhNTMtODEyNy0xMjJiYzc4YTBjZDIiLCJpYXQiOjE3ODcwNjM3ODgsIm5iZiI6MTc4NzA2Mzc4OCwiZXhwIjoxNzg3MTUwMTg4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzMza1lYempnNjM2bFVMZU1vZ3hZdHoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.isnkm9kL4ApfRMce34eI7mqJTg2hSXLLrpx-eNZbDk2Xvy0Ityq7nqsd6XZ8e--UfbTjpvUcaFRpEDFZtyUAvhE4n52BSfCLAc_i7K499NUhuqnkUMAPMr0XvmkpyndIb2ZiqlyBQQO--BxamtoMarFH-L8it5jNlpqoJCzm1esx3gUPVLVFJLU2moI891WGh0ICQUN9UEBMsjN2D5LyULoRlYweUaXnEi4s3a5R_QHfdHWG8htoyUoi9gCp8A5iXND--rXkCHvPUKihm3_4ITFBhNv8ncQOVm-Re_HiwHL-Pd84ysgYvCw1TDVzhRuN49t3hKsDV8dmBcX6Wr8fG0S-j9dNjUk1Sib1xakX5nlznQU_jmlFn8qXLWAhxM2C7vaMvG0qOkJX7wusNMxeRff_OjlmUGcMt2jsRYDffuRxl67bXYyasz9_zmbdQJtpwZiyFm3yzhjHDV_IGHOy3NuoSW1p9wqZ8Kr467c4wNYPKH_Uz9nx365fTVu003KktsqDroXFnl1cU_bJmVpRIIfbv0PzJKyhTJgwgMAAGWO1-gdu6t7mXupcS1jgzwjhvdr4edD6LN0osiVbrgrDQZCCExDnZbg2TYPjxVgGMMWu6ojWyEgyU81J7KHA3ySg8BhX5Emyy0OsyVHqT66jH-MBRAOJ79m-jA5kGYzdUWk
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: 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_24XXiBTJ0NqEeQdRgrRoXJ/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhZGI1Y2M2Mi0yMzYzLTRhNmUtYjExZS0yYmRmZmYyOTFjZWUiLCJqdGkiOiI5MzFjOTM4Ni1iZjJjLTQ4ZDEtOTVlMC01MzgyNmFkNDAzOTEiLCJpYXQiOjE3ODcwNjM3OTcsIm5iZiI6MTc4NzA2Mzc5NywiZXhwIjoxNzg3MTUwMTk3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJWUlk1Zk5nMUt2ZUJENDlFMmdaNFYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UwraZbUtUxSr2EuKC59Zxw_zQGR-KUxqkVTK7vqEx8-aFelfW6Ea2-q45p4F4067WtRRTnbW59y-6xgiUwwgdjKDDA3BYSVRefcOup_JWLcyllNIt7tD7kb24COTc602m6aJCwRAd_lhFU7wO9KqAp2x9IoH1Y1R2A8EH0GYUVj2d_0o_I_1WvCw2YUzY7LIfoVkRmuwJFchLUDOgargXXu5Bm6DBd1QGtUFwbbeFRlH-xtOztoC5t1N6hlBRdv7rorw4ez-2pamD9ToGbbrJFBf0VF2WKJIZkXYRWCvLEx-KA1MjfZhC5coDjN5ZCcTnaaD-DqGyNDv5swgbKpa6LVqcSLa6wWqkMtMkpziXmqldzvNbIukMtgaxmllhnssWFQx9PB9gcWQowTF5toAi-ghvBRHVJl1RBGTTZByIKAXrmpzUlF3H16RHMETTw-KJXEFwUTcAQMUwpABpQgDl5zwVGRPMKm_f5nohA7c0pTgOY8DSLJxNJ4vz1sWUFXrQEcNb5T3Fcp0cJfWGLiWgh1psdzajFRSRMnEZYa3xgKaFhuUNvRVd_oQ6tK-0sKL7NXgXAVu6w9xKbK7wb5UwfOTE0MBuvS6Yrb_7sqKIoofVNNcs1DMXY1JENL_h0XXxQIGb6O-6NFVvdJ_bw81lEOM6_H1NueS61h_DWuuHJA
Content-Length: 98
Host: localhost:8080

{
  "project_role_id" : "prl_2dj8S3tFyxyBapGkfhEE3u",
  "user_id" : "usr_2e3vPIlRMON5eTOQ2MCEbZ"
}

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: 603

{
  "id" : "psl_5RtlXGe5RdGBjfGlSjvwUC",
  "role" : {
    "id" : "prl_2dj8S3tFyxyBapGkfhEE3u",
    "name" : "dJAiHxkatk"
  },
  "user" : {
    "id" : "usr_2e3vPIlRMON5eTOQ2MCEbZ",
    "name" : "q7MwaT1eKx",
    "email" : "IiXwWRhA@benchling.com"
  },
  "project" : {
    "id" : "pjt_24XXiBTJ0NqEeQdRgrRoXJ",
    "name" : "iz0xDUsQkV",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:37.559297Z",
    "updated_at" : "2026-08-18T14:36:37.559297Z"
  },
  "created_at" : "2026-08-18T14:36:37.823773Z",
  "updated_at" : "2026-08-18T14:36:37.823773Z"
}

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_1Tc7huTwcR9VaaidaId32y/roles/psl_59W0EbLHWzvp2O5y09Cx0m HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NjgzM2UxZC05ZDkxLTQ0NjctOWYzYS0wNjBhMzNjODE0OTYiLCJqdGkiOiI4NzRjNDZiZC1kNjNmLTQ0MDItYTAzZS04NDI1NmJjODY4ODUiLCJpYXQiOjE3ODcwNjM3OTIsIm5iZiI6MTc4NzA2Mzc5MiwiZXhwIjoxNzg3MTUwMTkyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2RQSzJDbGlRRTczZ3g0S1JFZG9jTSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.Yiqwv8xVlb2h7kMmUpCRaAFYHpUzU9d-zhpUoFWEtHgpwc9XWH4fvqjx0GE5d_eHhrXxhtFF71YfK67uwHdpdInKivmIbGR-HbPJ8Y3dUi1r9bn0lbcmIxFoUaDe27xxcutcK13wrU9dJiaSfBfmoG6MF5ztSBzXCOkQfAo5bPtdNqFwVuExofUyGnZzeJYXflyCmaahijdorL0gJyhLt7mADOijjVIbpmV3kE-CEFcocDt-D3Y1P0fHQGNz3AuarE4X__l9F9zVqJ0sSEMjOkd-w4SOosVx-Ug4CI9j-5k_b8O5ZoQ27Y5cC_uWegaYZ6Ds2fQHK_mP7sugX9en5C5CfY6xGKoVlQz-kpjOqUleLvd0WaffA9gSmWLU3j08JjrPrSOvb5mqtlxyXfSraRRhWZWGEhauYXNWYgq2B82VL1sVbNKMAnoxpE6-t3Panqv2-GJUJ4IqIlwlSr96-M5fG0NvFTyPc6jwVAXHBdLdiBT-fK1e1DGlSL3imrO-cOsVajPMvDwyY68SW6f7lM3bTw_4v9VZPVEbp_PxIU3a7RwYqlMggmGKVPiqznKumx2HYGKrEO7z6bcU0D4ANTqILeky9NIekbCC9zceywDaaiR5c-wnecuzKfoM3PugN6e1QvwH0-rBqvaGK2k2CHWfc1BXdfHeT3bmVym7XlU
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: 603

{
  "id" : "psl_59W0EbLHWzvp2O5y09Cx0m",
  "role" : {
    "id" : "prl_1hUYdO1oaupPzJ3Won40wv",
    "name" : "OZtwZSZvYk"
  },
  "user" : {
    "id" : "usr_6UPJluZSqZH5eWlv7r71Ms",
    "name" : "CVy5nO1GVr",
    "email" : "jvX31rRa@benchling.com"
  },
  "project" : {
    "id" : "pjt_1Tc7huTwcR9VaaidaId32y",
    "name" : "KnGid4rU1q",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:32.367831Z",
    "updated_at" : "2026-08-18T14:36:32.367831Z"
  },
  "created_at" : "2026-08-18T14:36:32.501508Z",
  "updated_at" : "2026-08-18T14:36:32.501508Z"
}

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_5ObBcINbsIDp15DOZJmcyH/roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZWVkMzhmMC1mMWViLTQwY2EtOWRmMS0zYzJkYzU5MmQ3NjQiLCJqdGkiOiJjNGM1Zjc1Yy1mNzZlLTRmZTctODU1YS01ODc0Y2EyMjgxYzciLCJpYXQiOjE3ODcwNjM3OTMsIm5iZiI6MTc4NzA2Mzc5MywiZXhwIjoxNzg3MTUwMTkzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdOS01VY3oxaEtGc0NrQ0xUdDZiZVgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.deGYWzJ_FQH3_n0cfLJ7Huu6GtOWb2B1KasB5-8P5hvK8CnuyvR-a-ajvzrgFbaYhuqLYxYCu9m6YIh_TlZXoonMIZhEDWslUXMU6MrXLAVRcZXCpdbNHxk2gAMqgmmrFQnGOqavxiVzH8RegkgCRPcmuNDv-7abXURDefVA4cqB_386XyapfnxzvKW5CpuDR3agXpqRxtm4o5QOEfzucRPxN4KtI9JG8aLfAWAjIBECUuqWYwTlg-c6rjvgzxW1u-uN-ztw_BccC_6klYgX4I-pviVUelgKqFFMwVSxz8HtDDaLlgm_pOIma_Q-7M7R02eeZE0WbJB8Ay8bjZ-u2fCSAV2-IZLKOzVZ5MopDaF2l4yGf4nt0dT66VOYo8yZ2di3q-h1IZz18CVOmP8PHEn2orAwavxUwWDTnBBnswetZ4lsz5F_Izer51c7SEjLC_O3KBvaF7FJ1WXY3knMz72he6Kl2giNEIyXHL3EIVReNo-WzlxY5iPYAzbobKnJxoxXwdHTNqDhKjTuutdTD9ArxF6y87L024N2QudNYxzb21dcGhkQE4-bO1Ag6wMIQ1HWf_0YgW1EqFFj4_G-JNOATkkKSocwrn6kzuxmSMG7beBYBia-TM85SJfvhZ1Lu36zU8m2G7pKCDVp-xDGKZR5MDVQj2KRc0ZaVsiK2dE
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: 1149

{
  "data" : [ {
    "id" : "psl_4W3wQVsTQAhm2UikAU9t23",
    "role" : {
      "id" : "prl_4ENHdACMbpoB5WIdI4Psoq",
      "name" : "oKx1Gb4BCK"
    },
    "user" : {
      "id" : "usr_79s5hSCNXXqmdRAJbt8yIx",
      "name" : "6lgWYexTSw",
      "email" : "62VAVcD3@benchling.com"
    },
    "project" : {
      "id" : "pjt_5ObBcINbsIDp15DOZJmcyH",
      "name" : "Rp9cKK5ufo",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:36:33.119296Z",
      "updated_at" : "2026-08-18T14:36:33.119296Z"
    },
    "created_at" : "2026-08-18T14:36:33.289818Z",
    "updated_at" : "2026-08-18T14:36:33.289818Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/projects/pjt_5ObBcINbsIDp15DOZJmcyH/roles?page=1",
    "last" : "http://localhost:8080/api/public/v1/projects/pjt_5ObBcINbsIDp15DOZJmcyH/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_5ObBcINbsIDp15DOZJmcyH/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_7EjxkWFpC1YLk9pkfKhuhp/roles/psl_2fhW82l346MZ2PNLd8zpef HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MDE5ODE1ZS1kZDg3LTRhZjktODVjZS05ZjY5M2FhMDMwZTgiLCJqdGkiOiJmZDYzMTMyYi1jMzdiLTQwZjYtOWU2Zi1hMmY0ZmRhNWEwOGMiLCJpYXQiOjE3ODcwNjM3OTgsIm5iZiI6MTc4NzA2Mzc5OCwiZXhwIjoxNzg3MTUwMTk4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX283WFhYdjlQS3g1N1VNd25yOUxRSSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.MANv1RWzAaRF09RvnDWKLT5gWRvDLoh7z1ZFl33iZpB2Zwauvb9inz9R15YX7IQf2oCfS0zeWmq5lMkb1BL9s4mqXgAlVWSs6Kw99WSm6PAl-ZmAKRHOjjsmvufKY_69dzu2ZdTCB3jgvGVx7VlFL7USzScT_XlDGzxVIzFOS5ZEccOpEqzcJvBza3lBhg8ky7piLERSdL7_KOCv2J39UhJRfYCY8P4D7AwM4QM3QxnWZnbbLR8mUyZVjUJgvr5pGiV2Ii-7rHudtNksVsuAtETMwjVn8lnYmxFGCpqPThDdKdJ9Uf6Z_XJEWyVeG3tQ3RfMCyoal0b6FQx077xioy-cFN0qnRjkR4iUt9Z_wUF1hgaGzo6t-Nro3TehWywg9vPCOdU0lfnCBTmejP0lhtxwtIPf5bDkFOALDv5yZMeVDm0bba985kKVp8cnUrKPyTxX-l5l9Cb3gis8EWeExJTfhCow685GWWVbN6CKh10JE1TK92D652GOORjZw4OoQb-zC7muT4kTlExLeyL3ihilHtx-2_LKwn908oIdzopWQpKO85MEFa3hAQplvnP8OSIsrym3HMoQtOyUSu_2X-BI5Mv6kC2SW9uapC8yq2-P7oluavF7WAAyDsl4ZRM2fFjmcT-vyQydrGGTsBPixyYsJxeBQrggOK9PwqtcgxI
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: 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.eyJhdWQiOiJiNjhhOTBlZi0wZDlmLTRjNDQtYTEwNC1kZWNiYzRiYmZmODkiLCJqdGkiOiIxYzI4ODU4NS1hMDY5LTRmZjMtYjg3YS0wMTc1NmFlNzA5MDciLCJpYXQiOjE3ODcwNjM4MDQsIm5iZiI6MTc4NzA2MzgwNCwiZXhwIjoxNzg3MTUwMjA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZXRzZKekFLdmFtZWRRYkZ5WVhaOE4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.iVplfk1rI6AVB56FbWjMWsqHC-dcyz2bIYXFwNJBAAb4OwPjB9Wg8yYy6-TmGPtztE0sKYDQBEWXrHYJ08sDEKSq11-CHQQyxMNgxDRa2-VRXHG_5cRYvfhgGAtKBQEnb_-YiNPSW_WTXVhd6u794N14bETUVxcV4UPFCF0ZQCcJz8A-2FAULrqpxFWNKnaGMpilebKuryvTJH18qgqMrSwOsMlF7K1jLuhnNaZA4rBXz0y3cSz3UQQeDC3kwHjbffbC68dw-R9IyqaBFnoM-81ghZ775TbL3u7BN51NFFPP3JazP_zfYBEtMioIioR1ObJ3GCKO-JUMsfKMl3nfAahn97agkLO9Wo-HOWvcJUR1Ujws6gcVm-KQHku3loOB3dPpw0VgLJsOlVVX53nJmEpCcmHNyxbpLaulUqN5fDH9a4age2pCarCcr4tjtPny3fyWox9x6fROxw6LAFo0hD4HzOy9bmUC4V0fyZOXwWxUSsbxIxKrqQKYWZWQrDieXMz1ZmF-DrKTh_OkqSWYhy9A1kprW20Wm3CQr_RFnlICN1LbFG6iTQbwbxmrpiMgt7tbS52oq9SnFUZFEt262TvNbEQ6cDISSVKfXz9VQ_C8CgdBBAdozXn3Mk5CHnkg79lAkTRULY_ZxngyYmBVOD_M0Xx-XJcYrV16JdJuSOE
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: 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: 399

{
  "data" : [ {
    "id" : "tgy_4DdGuDAvDsVYUdIQtPwb1r",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood samples",
    "status" : "active",
    "details" : [ "volume", "weight" ]
  }, {
    "id" : "tgy_4ihleCyrK8hsbkZWYO2Qco",
    "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.eyJhdWQiOiIxZTg1NjY5NS0zMzA0LTQzY2QtODAwNi00NmVjNWQ4MTgzYzMiLCJqdGkiOiI0YTRiYzVhMy02MDM1LTQ4NTgtYTdmNC1hZTJhOGEzZWEzN2MiLCJpYXQiOjE3ODcwNjM4MDYsIm5iZiI6MTc4NzA2MzgwNiwiZXhwIjoxNzg3MTUwMjA2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJIRU9yQ0VKVEZGTHpjbjBHRzdqNUciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Ibi1EjLCo0UPBdy7cih0QuRJ5J_0lnJDB9NgSgyv-HUQUJNymc0qqpgAjcaCX9LuKaCYJLvBoX9aTo-lCu28NUadLBEgsNbW5DjwFEu-Yro8I-71LkaYwrAZPZzb0kXEsgpoKmkYwa85AtPJh6yEukoZhmuu4iNRzSRVp07j504ZQJkGBcyLh7mcIPvZNCAyKZrCndLBrT1np9puwBmm8cueH1XJ1PQ4CX6tf6oaKDa6QKfKtyZzfZW3luAVvXgUd4BG2CQGRrISbh2lhIvXIr4k_Sdl5Gl9_GTV6PMwv4QjLVFy2QKla6C_lgf0V2KXazaRHeaC1EO8KACEBiAzqqUi4PtpCWU1D7zW3UB4H3xCE3718_LhwztTo2tSBOF7DVwxNVQrtrI_8QAokaCw7HqOmwoRP0tCdsQPv_BpbvTagnr1ir4dsbHsT4peaWgA0UtUV_4a2Xo5zxRRRgHhZYZpdUj7X8XogTx7NQQGOBAozo126eEuxVQQK6mG5Zz9PRxrL9zWBx1vf3eeMdNGeqGvuCnavBuarvO4sX9rX0Y8dzXqAD4yy4B9FJegdhHrwmZCO35IpZjTvLDQIS5dtJVam_twQjbyAM3cNIbGP3hLSLDPDhyUtgocTKLUVf4OjK1f1R5DFbBanzsC4pSM2BKRNrU24QiOuHiUFhnS8mE
Content-Length: 448
Host: localhost:8080

[ {
  "id" : "tgy_1tl2QJzxUrHlG8NhTbpEF2",
  "title" : "Whole Blood",
  "label" : "WB",
  "status" : "archived",
  "description" : "Archived whole blood sample",
  "details" : [ "volume" ]
}, {
  "id" : "tgy_1bgPby6bJ1HpYQ6suXJNUh",
  "details" : [ "volume", "weight" ]
}, {
  "id" : "tgy_4BwOOidlI78BcA4CamaHHv",
  "status" : "archived"
}, {
  "id" : "tgy_5usDy97VIB4fXNWp0iBotJ",
  "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_1bgPby6bJ1HpYQ6suXJNUh",
    "title" : "Tissue",
    "label" : "TISSUE",
    "description" : "Tissue glossary",
    "status" : "active",
    "details" : [ "volume", "weight" ]
  }, {
    "id" : "tgy_1tl2QJzxUrHlG8NhTbpEF2",
    "title" : "Whole Blood",
    "label" : "WB",
    "description" : "Archived whole blood sample",
    "status" : "archived",
    "details" : [ "volume" ]
  }, {
    "id" : "tgy_4BwOOidlI78BcA4CamaHHv",
    "title" : "Serum",
    "label" : "SERUM",
    "description" : "Serum glossary",
    "status" : "archived",
    "details" : null
  }, {
    "id" : "tgy_5usDy97VIB4fXNWp0iBotJ",
    "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_5V6gyKwOqqa0TQqBh0DcDn HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiNWM3YTJlMC1jZjUyLTQ1MGItYTM2NC01MjQ4NTM0MWMyNmQiLCJqdGkiOiJmYzNmMjYyYS1kNWQxLTRkMGEtOGJkNi0yNGU5ZDM2ODI3OTkiLCJpYXQiOjE3ODcwNjM4MDEsIm5iZiI6MTc4NzA2MzgwMSwiZXhwIjoxNzg3MTUwMjAxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJHZjE0T05UcFI3MFc1N1V4MVNXN1EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.l5qRkNehCTmdlyZbgC3KiYvkNOboMzpVVwm67Rh33aPPETrJKhbq20ftd3VFFY3hYwUj4nOKa1UnZkPDihzM_GezgL-48rk_BBaLJS5a8fHRm7d7YUYW8Kl-Ebm8xxu6wUSUisICBVGfzkSCj0qhp-EyTNvTNGoxD7BzHRdsv_HxK3PA8rniYLggDoCLzQVch1Dlf3eKQWGTs3-CjiEG_y6Iu7229RtBkPa1bY-7c4Fvy8bia825qTtsQ7jPbRCN2zpJCaeuv638T0O9sgK-0Rtw3toaPLli5pcOekD2QfkF33vYzQyxhYASDAyHAgeDwbH1-Mvgt-8WxPn4kW1y7fOj-UcRNXG7SPr0nW1tnAGJXkLNnfwRp79JO4i-YcO2pN-HFNeiwtPNptPh5nYvCKl19Uvv28D_k_iGQ_ag4Xdu2OMpTYAhpvvjoYXNCjF8vm8WZzSyw8YcTDDhQDvLBjzLujup-mNyO1_P2RTFo1b9xsjrIy7obfEmkqIigM45xDk6Ofo_ZIAZJkOA8-i6_83_zKQQDgnrI1yYbNxL-_3P1DRQ5Ut8BMKBVrCcgptP-lhNvUj9Bkh_FHYKJai7PMfEQV6KjycDQkK_kuJWqGZvRlDa5BWlHZRCO3mjHnuZRHYJtk9Wi7k2jJY1CKnxdb93SdhkMU3YleRUiOLn_B4
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: 207

{
  "id" : "tgy_5V6gyKwOqqa0TQqBh0DcDn",
  "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.eyJhdWQiOiJmZjE5MmQ0NS1hYTcxLTQ3NmUtYWMyOC0wOGVjMzM0ZTU2ZjEiLCJqdGkiOiI2Y2NlY2I0Ny1jYzIxLTQwYTMtOTE4OS1jM2RkMjRhN2ViNjUiLCJpYXQiOjE3ODcwNjM4MDQsIm5iZiI6MTc4NzA2MzgwNCwiZXhwIjoxNzg3MTUwMjA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFVNXl0bWlVQ3doQ3dsWnVFc1hYNjgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.MD6VTN-_Y1F-_L0a462LzMePETOyY4-QnhinfnfTMyC0jMcwGqQh4ZcAOQyVk2fvdGz--F9-C56pPpU-fPe-FKsAbqtrkMXZf2GOGclxcvaEJRt8RLMEx2e1E2zyO39XPmCwyoVUdCRW-hJ-UyZXbU5b1jdJPGpRI6vjctydCrODzJNjp7ZDVc4wxKgOLixoEzsPhhAFJlhpM6WIKvSx5RalcO_0_zlK8br1uTjqsaBkeLW8LwqOqew921_HM7pzWcfYc08KEnu8mw87n72mGJ_j4YnX1_cvlPylw9ld1LXiSgLIIZ-JyXClIq1HAl9pKbVXSKBKvzI1SsWZQTdMcpLJw-nMfawDt84RzkMILlcdafR8loyn4Ayihkaa7uCb4WZrciObREi2-fGJ7Z2RXggZEUqAsN20BKHAOATdFVfOXLw2ofkEOcVUEivMygJnRzslV0jk33JjZCUOOf1yAT44Im89t4yKsDCqj7loJikKIptU8g0ypD7UInyBdjZGjDreWVmUhrlhSHwURTDh0QxgKoMYIpF7GSc4SPSvjjssvZCMtY6D6k64lq4DPidZDMDSUbZkTMNh_FK7HOnIOC9wdtwI1rmI33bep62h2gpNH1mdrsEsHbLSCsDxljet7PslrPBoTxr-o4AAC59JrUnYhVRUoU0hCnHZpULCglk
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: 888

{
  "data" : [ {
    "id" : "tgy_4WXes1shCO5Vo9hlqTkvmM",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood and serum samples",
    "status" : "active",
    "details" : [ "whole_blood", "serum", "plasma" ]
  }, {
    "id" : "tgy_2GlZovoGRxQj12qw5zgZF1",
    "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_5yORB6OiuPb8PkbBrk4AOd HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNmZkYjI0Yy01OTE2LTRkMzEtODAzOC03MGVkNmJhMTc2ZjkiLCJqdGkiOiIyZmRjOGZjMS02NmIxLTRkODAtYjA3My1jODA0ZjYyMDZiN2EiLCJpYXQiOjE3ODcwNjM4MzIsIm5iZiI6MTc4NzA2MzgzMiwiZXhwIjoxNzg3MTUwMjMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVMQVRBek1iQnppM2ZsRU9XR2lremMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.fSOxygTEMJsR427f8sBeqzMIKyDUZ4c0Oi3TlFMAOzVynF41F3kV41-eYDMtTLwyeNrl5VQqm3s3NA_Q7bBa7IC2vobF8_ydbPV1SmWQXKbn7yXhMZX-XJXERkTQVF1_CwsM13plc_0gfQ0qn9Me465HqNnzi-QlqbyNmJ-vrPiYd-EGcQH_-J8Z5P5nDaNNcsWKsUKzGGT8ljNAkPRndbN5mGHONTPSJgh3uxwbMw4Rx6TqL8Y0wqNMiRmgYtiaXumkJqC0wmfdH5ZNX8bYyeQzXYuHj-5m2fYbhBL_2w_CWk70uDYYkFWHVU_VRIhdVAdgIk0t43Xsu74_Su9vcfs5PeXY3H6v80Vnfw3NnOsaEex2GN2KEJSj7_HVlzItMDIESQ01k7gecIfwCnP6hjvxE5ThIqD2VXPetaxWDPsHaN7DaywRqSxmO9sjZFRoNEfMUBKx7pUPHmSIo-WwkAKplo5nv5miTG6je8qeTeGRVZAQBf8ODrhsbnUMvVhPWTuUYIwBEcDsFq_XHVZKyvpNMqPmihMaJvDptms-5_ikx8cplzPXD-XONE7kX973Tn8YblZKzSS8hITZiKZilManAo5hqZhb-j6y7a165PSIFXlmNScpQy33boLnVUOJP6s0cN2wE8jPxlz24z5FTtiVnwInLd08t6PIHfNlhHQ
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: 2958

{
  "id" : "spl_5yORB6OiuPb8PkbBrk4AOd",
  "sample_id" : "S399123053",
  "sample_definition_id" : "sdf_P88nxs7TZYD5Cs6WZnDGn",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-08-18T16:37:12.443019Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-931773223" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_552in9rlFOw1trdxSKuhPR",
    "project_id" : "pjt_5CltAtigE8d21KoLutJAfM",
    "name" : "TXySNRS1rs",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4P1Ter9kXox6X3NoMeNyDq",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "ARScoHjKMS",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_381Y6QgbHJZSUj8bsxfPl8",
      "name" : "LPHYvK5HQz",
      "email" : "Ruw1ObGn@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_tXaTcvQ6SFTg7oDQLTjKj",
      "name" : "q0BNgSeTPl",
      "email" : "2PLFqMAF@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:11.512420Z",
    "updated_at" : "2026-08-18T14:37:11.512420Z"
  },
  "animal" : {
    "id" : "aml_2iaNo9gx5iooeNcjmjCml8",
    "study_id" : "sdy_552in9rlFOw1trdxSKuhPR",
    "study_group_id" : "grp_4xQdwrk2bqqz8Aer5E5FKZ",
    "cage_id" : "cge_5BS464owIL1YGrZSfGwun8",
    "catalog" : "A0000001",
    "name" : "GxE0ymyno0",
    "number" : 1,
    "strain" : "zNemde5J8z",
    "species" : "XwHIRgVIjb",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "TW0ZZAG3kT",
    "ear" : "NGSt5Sv7D8",
    "tag" : "F0Pgr9Oh6X",
    "donor" : "hANYnUMXUY",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_5C2ZJz3RwsTdkclN2IjnjX",
      "name" : "qO2SYGQ42u",
      "email" : "3IaJsnLV@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7YEszpkfkbnwpjeZXM3MrL",
      "title" : "Found dead",
      "comment" : "6lD5lrHzR6"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:37:11.936636Z",
    "updated_at" : "2026-08-18T14:37:11.936636Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_3tEKhomj4LLJFTocC78l0k",
    "name" : "omnJOejrfj",
    "email" : "TBgQIaxz@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "4RrqrFexRn" : "Z1YH1CgXHI"
    },
    "created_at" : "2026-08-18T14:37:12.420112Z",
    "updated_at" : "2026-08-18T14:37:12.420112Z"
  },
  "created_at" : "2026-08-18T14:37:12.443206Z",
  "updated_at" : "2026-08-18T14:37:12.443206Z"
}

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.eyJhdWQiOiI5YjFlYzQwZi01NTc2LTQzYzEtOGM5Ni1jOTIwZGM1ZGQ4MDAiLCJqdGkiOiJjYTY3OTUwMC03ZWIxLTRkNGUtYjg4OC1hYWE2ZDBkMDMwZjkiLCJpYXQiOjE3ODcwNjM4MDMsIm5iZiI6MTc4NzA2MzgwMywiZXhwIjoxNzg3MTUwMjAzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZWRktERG5MQTRjRWdFeEV1bENpN2kiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.iNTI1t_juwXDzJZTfTL4-J1fjIcGJdhXTpD-kWtQlGX124w0so71KR2IIVbqgk_Rd5ENxZ4jGWQF6d0V5lgikpsJP8N81xPSxsW--Yz47eP_kxtXONF9oy4uA5xuXk63gLg7Qn_Uuo6ABwJXXhkr0hrZYK_IpdhXDFr8Vwt6jeCHC_KN4WiaRdNqRJ-E2JMx4NpAR9yPiizgEDh14iY9-AASHV9Q3zS4MyPPau0VK47xM1TbnSjRh2Bmvho_i7RYUFJU6DxmeONWESTAcMoxEVBy-53DaI8j3ZAFMOXK3V2QvnUauLt88_bTWhIxXuZQvdiTxkQqkRyYdHnSF6S57OHiIxTgV1Vz98hBQn76LsCjL0BMC2D9wjd-RyivcakfXZbnZhs-qYnlsHwFznAzPgIGqp4Qt0VtmJhswMpOJSLIieUd_CTy7mEhXH_pklPwVSC-gU-6YcMfSz2Snio51Sd4wPFqeHLPzvGjI0EywNfh2AIcZY4UdL4ftDQxSsKn9EK8HExzf95QzB96DPsk0igz9s3ogLZTQdUMX8ES6bwTSAhAPNHcd2CMnKYrQy9brsCRGOp8z6qMVI9Vnmpu2ljTfVrR5wJk75OaXIZbZaCT7jtQkrWOKFGV15spzsDeIgaMRlHgtK3ghiMX65TirQiK1z7mFlbNlNbpHN7SZ04
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: 3562

{
  "data" : [ {
    "id" : "spl_68qxjvvjdT4vwwC3M0VqOU",
    "sample_id" : "S1445773331",
    "sample_definition_id" : "sdf_1213vcuIsjd7icVEapRLXK",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:36:43.911106Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-761371294" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_3pTYHWNyH20c5axrbJMn95",
      "project_id" : "pjt_6Buou3nnU6tgsim9Ecyuz0",
      "name" : "fcs1LY5Jta",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7TwAHDxNWEA9nEQYPefAJ0",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "WX0MM2a2yD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4Sl0dSrs2RAUF6HqV6h3cS",
        "name" : "PMKAQIAniF",
        "email" : "vwrZ9dOi@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_OyejzB2bpntI6klki4vIh",
        "name" : "yaWq3XzF25",
        "email" : "tYBu4KQL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:43.121249Z",
      "updated_at" : "2026-08-18T14:36:43.121249Z"
    },
    "animal" : {
      "id" : "aml_2rNCM0AuJ76u6WzR2iSkCJ",
      "study_id" : "sdy_3pTYHWNyH20c5axrbJMn95",
      "study_group_id" : "grp_1IIpCtgBdYl9cKNTnlKBzV",
      "cage_id" : "cge_5AOYku8cg2rumSczxtuLLE",
      "catalog" : "A0000001",
      "name" : "xEai4FmMG1",
      "number" : 1,
      "strain" : "7pyXmZUOqR",
      "species" : "Gp6cnQKE7b",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "lyRsne2Bjb",
      "ear" : "3BxNrITAjP",
      "tag" : "W8IYBLuWeV",
      "donor" : "tXLPX7wXW6",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_2cGsJVO2LOfsW1JGyeugCU",
        "name" : "YSWFD1HCY7",
        "email" : "BNbLGqqh@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6JCgBGVxqxlN8OJWcmePtu",
        "title" : "Found dead",
        "comment" : "0kIXvePFri"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:43.575308Z",
      "updated_at" : "2026-08-18T14:36:43.575308Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4UhVXaubRc98e07AM1Gn6k",
      "name" : "YkbT1agwht",
      "email" : "9fl6kggt@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "pjlDL72gX9" : "8Rhh6OQvLd"
      },
      "created_at" : "2026-08-18T14:36:43.889379Z",
      "updated_at" : "2026-08-18T14:36:43.889379Z"
    },
    "created_at" : "2026-08-18T14:36:43.911330Z",
    "updated_at" : "2026-08-18T14:36:43.911330Z"
  } ],
  "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.eyJhdWQiOiI1ZWVlYTg3My1lNjQzLTQwODYtOWE0Zi1hOTVjYTQwY2Y2MTciLCJqdGkiOiJmMGY4NDViMS1iOTlmLTQxM2EtOWYyMy05ODgzOGI3NmE1YjQiLCJpYXQiOjE3ODcwNjM3NTQsIm5iZiI6MTc4NzA2Mzc1NCwiZXhwIjoxNzg3MTUwMTU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNxclF5RE9XbmRjT0laZkM5NnpDbGciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.iaoXdRHliTMtegWnrwVoGE2pR2ax1fYESrvZfIeVIt5y9_sN9MTc5Ewn6c5p1qPIdDQh11GJ9zfzOzFHeFCIhWXdl4Ct9sfbjhF0Vc4Ay_3hCN6epEMeZIEfKbZWXMgA1ZoaB9PNwi2JXvDpks_B5-DzZJVDxuOTR9FfYoA4DGJ5mLQTuZUdtpS-F0myZxOYAuVZV-arkZn9HVzWLWGiyTcqNa7dKGTZFyYR6NVGEt8a4EC_RQfq4S3TSpBFa1AJTfCga0gWMFCNNSATN5bkLzwZY_67e9baqGetRlE4zzo0f8kIBYRRjuCnd4X02Gvd8EqVHjL1f_Ahd9fVKHVRuszHl8FIuOKsGdl0GU9tJi4N-xUmK335JhWvPEvb6t8PiGwnYB-G7FQvcO59ouytDhVsQXRzbF8sSRmP5LKcPQcz0ZQKgFfTyJk9zDb2-il_8trUP_V5zoFrl8oaOZtS9JeMmuVTAFF96ObDM_2JTUkLKJPWLCZ4fngemxhMi-xrUKdjLaLSIyC7nNy3qB0h0FWikTHs_cD8rC9CT0mL4G8cWn4Nv7A8MD2K0_E9pxm7SRYAkP8Rja-3XDSKiK8Vxd3Iysrzt-fNIaTP5cvJ5BNtbYv-0FWwoYrxwIKQdhGJ9zsxZ8Hm6PnRrJltWu0yFYBrWcCyyLOWOxuiP3erg8g
Content-Length: 46
Host: localhost:8080

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

Response

HTTP/1.1 201 Created
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: 181

{
  "id" : "spc_1AcUKxENhxEEUna1SlaCaR",
  "name" : "Rk6RsBaQfV",
  "active" : true,
  "created_at" : "2026-08-18T14:35:54.570231Z",
  "updated_at" : "2026-08-18T14:35:54.570231Z"
}

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_8NeLodk3Libc6fgA8Wl7E HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YjkxNzI1MC1hMjY2LTQ1ODktYWRkYS0yYTAzYzNlZTVhOTQiLCJqdGkiOiIxNGRmZmM5Mi1kY2E1LTRmNGYtYjU3Mi1iOGIwMzFhZDczMTQiLCJpYXQiOjE3ODcwNjM3NTQsIm5iZiI6MTc4NzA2Mzc1NCwiZXhwIjoxNzg3MTUwMTU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZROHplcGl1czNwYVU2OGFwODZXMUsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UjfAczBG3b44u8pG7QgdUQl6lfg4fT-o3YQyjaGSBe3rGyFpplgpWoWXx8jK1ZyLwiDIQDvntyr1RH5eh__3U2DHNKy7VtJxrsa6hP3gSjmJ_5jdMNCOi_Sm5sg-IaGAoQJZGTNBml7WVmQxfDbuITWRDEmh5_8J-GNj69_In25a6HYWhZg7aMZfVgpSAMAtnFDoNMxi_McqsLwh9ECsM2Xtf6u8fgA_PmYcJqg__AmFS3O2ztsk7vIiESqcP3WtfXxRDM98tPiAmjK--jTLdtXcHSx21NrluOPf09mpD7LaFzC6pho8Q_k7pTyZM1pNVP6bGvOoBWK19xHzFEeM41ui-H2bQOjbF7qXRZO12zOEmK--pRqquQ7XrKTeo_DA7YrPhON5rer4Ra2IPsHe68rvf4PVrIaLuqzzQ5IPI1SnWbPcQzuHdZR84zj_5Q7WLTKOuoUFFZCUPPQMdAjMHVv7Cb48rqBFPC0ydH321ZtLIFTVkAHwT4l3VVlS49uA_QLKsdiF0y7jHnSZFx1HWKf7xTqGweeFMSY49zM1YI_9-nCGsnJVpx_Mh0Vw-i27D6FHPpB3AgLwDf7iPRXbj2NmutTDps7aedNnRm5BKK5viAUb9n7NkYNd2_ToGanRze6Pt6MhQn5fmoTlh78oK_9Hj1ola6x7STKWAyirgrw
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: 180

{
  "id" : "spc_8NeLodk3Libc6fgA8Wl7E",
  "name" : "iug8RnLWYq",
  "active" : true,
  "created_at" : "2026-08-18T14:35:54.699378Z",
  "updated_at" : "2026-08-18T14:35:54.699378Z"
}

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_5jSUEB1tyLNRGQdAlFPrQE HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZTFkYmQyMy1hMzY4LTRmNjgtYmU4OS01NzFiM2Y5ZjAyMjEiLCJqdGkiOiI5MWQ0OTllOS00MzA0LTRmNWEtYTAxNC00YTE3MTI1M2YyYmMiLCJpYXQiOjE3ODcwNjM3NTUsIm5iZiI6MTc4NzA2Mzc1NSwiZXhwIjoxNzg3MTUwMTU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVQbG01OExGRE9DWG40Zk1oSDJzWTEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.cNhajIqVIT5PvjRv0gafBq6bkZUvW6CqhxHCpOjZg17K1qwsiPEv_QcxLdUG9re8IJHTMJn7rPlmwp3BmgZoSyUVGYSVVaJf57A29J-tr7i5BkVwFOTixuonll3CeTLXd8daFeahGnCVoZSouQMb0DWV1etUfLoYHColqR3nrEiuykekNLq1G9Q8JYhuCfQiPa-fwvGlP2HrjAs5CGkk6WGzK_h2TVX77qYLLIdNXKU2fdMljZEilPgge0DLnM5wimkYqqysnCgOtQhRWcOygo1Kx7rQl5gOACl9YMAtNbc4ZTHaXQdookZM5sYxRd5FR1s2BQBYl9OWoZDa_z4LVRl3NkP2VrcpI0ZZyBeDYtf9JB0SxLBcbocPQinZxL--0BI8BuoEpx-vB7XMSsu5wm3OZSa9G_VSkaKwQ8fgFglguAf4JDeSprz3MY9q53Ip0kyd73iQJTJyP3AaeFBIAyFvBvQIdz0Tfpi0LuLmod_5WEG2KG4haziRufO_kD6ivJi-IFINI4kvQNhYP2pNtK-vIhMVelmMYSFF4NtpZz9MyR6xW946dIfURbsj0-O3_VZxYWHSBDFUZ59tOLip0Gc3FD28EUvincNnkCeCqatxy2_Mzz6zIDpcGmec0ElnAQsdcyMt03u1QbqDL67gVi4WZ2Gu8T5x9tBwI3s2Q2w
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: 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: 196

{
  "id" : "spc_5jSUEB1tyLNRGQdAlFPrQE",
  "name" : "Benchling In Vivo Species",
  "active" : true,
  "created_at" : "2026-08-18T14:35:52.161308Z",
  "updated_at" : "2026-08-18T14:35:55.456497Z"
}

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.eyJhdWQiOiIzZTA5NzMxZi04NGY2LTQ0OGQtYTViNy0yYjAwZDA5NzI2NTUiLCJqdGkiOiJhZGYzMjZlYy0wZGU1LTRiYzgtYjdkOC1iMDdlOTgzODJmYzEiLCJpYXQiOjE3ODcwNjM3NDksIm5iZiI6MTc4NzA2Mzc0OSwiZXhwIjoxNzg3MTUwMTQ5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX25tSWthZlBxMDF6TGpHQzVsVkNrQSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.DL9fJ--b91UQnYj6m1K7JmaQ0bhtbJY53GIUQHcfG7AYkaumSAT3zYQaAxoV0n47d6xM0-jBa1CHKr1CVqC2euo4g6zTOZMPmCnBpeQH6JO6KB69hj7jlFZ1GqHLYXiKla7MwsTockVzLSua8b1-Sgab-rb_Ez0RFD1fhyEkbdN7YSYFZA7MlQa3NSFPJ7yxvqAJj_LaDlZWClznZNZ2W6M5gb7dnwdilneBeV9878-XtE_EarCyovX__u_43-_mnD4n8MzFGGzqvhsM0EwUlx6EA5p0HpULIXtL0iNgmE2eQhupS2KtFhGLeohf6p7ngbqLbll_uMEYsNCdKhPL0nQSfkKUydqOWjGY_Z4VRwWTKnHMuHRA83TlFuPTjJTa-eIkJCJjIss_irxGhb9fvRx7Tk-eWZm3Dkkb3EGmMH3KypPDJzuxb3weZetBf9jr6uqIMY5tTSxFV0Tj2GdoOYVexXycLuSbSWwoVZAdxeXiyLx9JJJchdUrqvWcRawe_j0KO-yAHcLGVpUCqPIj67W0_EBqHjQKWt-hM_Hiwp6N64yK2j1lf_AfoFRrLedfckWWfxhXAg1uJkUX_BBvbAEpfcqgSIa1A0s2LF2xknqouNTsHrJlYnkkcx-irzg-K7vMCZu4ABnqiDy2cEx3jb1327MR1wBkJ_e0mSK1llg
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: 593

{
  "data" : [ {
    "id" : "spc_2cOFUNyyDHUlqtQxwDvXrA",
    "name" : "spDKRgvw2V",
    "active" : true,
    "created_at" : "2026-08-18T14:35:49.056603Z",
    "updated_at" : "2026-08-18T14:35:49.056603Z"
  } ],
  "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/v1/strains HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJvdmVyd2F0Y2giLCJpYXQiOjE3ODcwNjM4NDQsImV4cCI6MTc4NzEwODI0NCwibmJmIjoxNzg3MDYzODQ0LCJqdGkiOiJmOTA1OWNkYS03YTY4LTQ1ODAtOWZiNC02ODU1NWVmMmRjOWMiLCJzdWIiOiIyMDUiLCJ0eXBlIjoibGx0IiwidGVhbV9pZCI6InRlbl9XSjVCTkNDOUluU05OVWZwRWplZkMifQ.wi7JJam-20moDLoclukiW4FLAzSwAkEiXb_dF77XgFo
Content-Length: 75
Host: localhost:8080

{
  "species_api_id" : "spc_vB27P5synhSQyUjR4RlAD",
  "name" : "strain_1"
}

Response

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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
Content-Length: 289

{
  "id" : 22,
  "api_id" : "stn_6QNale9P8o3pVPghBHM8PL",
  "species_id" : 37,
  "species_api_id" : "spc_vB27P5synhSQyUjR4RlAD",
  "name" : "strain_1",
  "active" : true,
  "attached" : false,
  "created_at" : "2026-08-18T14:37:24.034157Z",
  "updated_at" : "2026-08-18T14:37:24.034157Z"
}

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_CziVXWI9r5nyRAcqWuUMw HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlY2Y0Y2RiNC05NDk0LTQwMDQtYjJkNC05MGE2ZjVhZjFlNzgiLCJqdGkiOiIwYmQ3MjU0MS02MDljLTQ2ZTMtYTMyNi01YTA1M2UwYzhmMzMiLCJpYXQiOjE3ODcwNjM4NTgsIm5iZiI6MTc4NzA2Mzg1OCwiZXhwIjoxNzg3MTUwMjU4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2hiUG9MajdUak00UWU3NlRVRzZpMyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.ZtEJ0euhZPMig4hbhG0HIzCmANgH9r01eEe1OXYhTelDQeLJ1N2DwwUnxsK1RsPy1pgjQm0YOHaO0EOCxF2b13KqRVoC1OO_lxcVdFMoWLvTkRDbv8wQ_Nr8tILyXLC0ipXjowgNKCdNQ4ZxD-yki1FHnMRt4mBrCynNKF9mvXbWy8CtXHnLab3zSZyCL9AC2pcYOohyOl6T_faaN-X1jA7ID37QfnGKA9325I62jvcdBk1x2Y8qBwmbcGj0vU7xIfDRBeVJGk-qs76j-vH64M2HJvEJ87l6RqRj2sBuaWgquS03AnsZiZ5Zob4KrHkmUW6fkODsQjMgDc1zFnJ8yrmTTyZ9Kh2J7KWBXj4qnLKRO2JooksI8_TOY4q3mKQ8p5mcGSPXAHoeb0tQXw7NXcvd9o1qtWzbBUKTXK17fGK8IElFXneRUfBVTdkqBYIPiOXf_ImEkPnfHVBC_8-r3JivJiCxEXsU_rt43L9X8zwT6j-5Lcxj9L7BMu19ABt6oBnctpSl7dxsrPRx5JFCnGaDiuBSyjmM6wBnK8PaQF7QiUalFBsrlX5ngVcfWnVG1bOlNMVVHqStqIWdpSUsdKiUPJYzGXCndOvZRdRGLqx7dNF2cfFC_Aa-xjt3s6Jbnaiwn_ZW28b5dmva0M3o0Xuzz5AVrRjRukTTSLT0mBc
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: 389

{
  "id" : "stn_CziVXWI9r5nyRAcqWuUMw",
  "name" : "Rg6wr5EmQA",
  "species" : {
    "id" : "spc_4286reZ8suTKcckBx7WylO",
    "name" : "280uFLVWW7",
    "active" : true,
    "created_at" : "2026-08-18T14:37:38.009527Z",
    "updated_at" : "2026-08-18T14:37:38.009527Z"
  },
  "active" : true,
  "created_at" : "2026-08-18T14:37:38.012047Z",
  "updated_at" : "2026-08-18T14:37:38.012047Z"
}

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/v1/strains/stn_3rrSxOIRdyRBkqgoVbyESC HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJvdmVyd2F0Y2giLCJpYXQiOjE3ODcwNjM4NDQsImV4cCI6MTc4NzEwODI0NCwibmJmIjoxNzg3MDYzODQ0LCJqdGkiOiIyYjA3NjcwZi02MjRjLTRiYjItYmEyYy04YjJiYmU4ZDc2NTciLCJzdWIiOiIyMDgiLCJ0eXBlIjoibGx0IiwidGVhbV9pZCI6InRlbl80c1ZqVkVEZTE1SDd3clQ3S1hzUDM0In0.jHCAGCs4pS2rgBO_gz75FLi_PuujkLnMPanddoOShGk
Content-Length: 25
Host: localhost:8080

{
  "name" : "strain_2"
}

Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
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
Content-Length: 290

{
  "id" : 25,
  "api_id" : "stn_3rrSxOIRdyRBkqgoVbyESC",
  "species_id" : 40,
  "species_api_id" : "spc_2MVKHwVmxvm7JGwzRYTIFl",
  "name" : "strain_2",
  "active" : true,
  "attached" : false,
  "created_at" : "2026-08-18T14:37:24.266816Z",
  "updated_at" : "2026-08-18T14:37:24.283608Z"
}

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.eyJhdWQiOiJlYTgzNmMwMi0xYWUwLTRjMzgtODQ4NC1hNDY4ZWVjOTA0NzgiLCJqdGkiOiI0MTg3ZmQxOC1hZTJlLTRhNTAtYWUyNy0yNGVhNDc5ZTkzNGQiLCJpYXQiOjE3ODcwNjM4NTksIm5iZiI6MTc4NzA2Mzg1OSwiZXhwIjoxNzg3MTUwMjU5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFaOEdYQWJBTEowY3NiSWJUWERaWGwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.fXOADMK9-cyGTEnAHW88p97OIz6j-701GivyXV4esTT6GASor698zfkNUKJGXJtQ91662Q57Az3gcH2J-hKZ5Md9Cq7594w2Q-WMIyOvHiFVUGFTNBtwLkjBz3m5gUPkv0_-9JTd1419ufU8rWszL-M97FVj2z41NvspuiZv3WbarEh3ZIL2ixCd8_4LXLAS6eZoI98YlVvH_whF_ZhFCXwaN5OrsSDyAaiaC5t81GC85fupuY9OZmf0RGRZWd9D7cJdm8B80AYhS1foQmeIs8ZFub7DFOY33VOcVR_2uXNeN54Nk8016zP9SFm_6ul5MaW5FnKwjYHUxXwVFyxGFjFPzAkT4fsnEda7U0E4Hcbdb6KLRaDMVpERbR12h-2MPMIjv0F9QoJzfkcATltfXysIBIL_2YF9QS43gdeyfrDZj3fGEj9DcuKoFcat_jRYxlGAPxsX0vnZFqrPR_3ps3VTZGucUpXsy-13Ru9vMRlYnFbaZdehqpz6qShvPNRNPLf3MTLZZ9rkT6BRtjUZtQMVwq-3tY7tyMYKrU2EC-Lh_5K-Dj_RMdu9veOIFBB1Qla2ByzFyPfJ9anKBnl-7QVUTQtt37W-Y4c70NtbI8Ge8ARsqXDRYsbMV6HxURgC1AEMT6MdAFGexb1Ju8cQhUVxE8WGRE4a5j3w5teLZfs
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: 816

{
  "data" : [ {
    "id" : "stn_30d0PdxfB3uWhpD9OgVSZr",
    "name" : "OARQThsdSA",
    "species" : {
      "id" : "spc_5v6jmIg05xBr3Eotgoo59g",
      "name" : "Wbr1QMkgOc",
      "active" : true,
      "created_at" : "2026-08-18T14:37:39.811058Z",
      "updated_at" : "2026-08-18T14:37:39.811058Z"
    },
    "active" : true,
    "created_at" : "2026-08-18T14:37:39.812436Z",
    "updated_at" : "2026-08-18T14:37:39.812436Z"
  } ],
  "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_5GLowiJ8Et2HEXv6c5kUw0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyOWM3YWFkMS1mNTJhLTRhMzYtODgwYi02M2NmNDE0ZjhjOWEiLCJqdGkiOiIwODIxYzNjZS1hZDVjLTRmZjctYTMxNy0zNWEyYmM1MzZhODciLCJpYXQiOjE3ODcwNjM4NTIsIm5iZiI6MTc4NzA2Mzg1MiwiZXhwIjoxNzg3MTUwMjUyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMzJGN3dQMnl6MTlhWDJvekZWcW9tQSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.apQl32eqGEulNwoqnv3zndeSqKnju_Pk8WGVx9f0zYyq7odMEQmQD8pKmIIedFEk_NYKVfTfQZEhW-XnF6aOQ6I4hpTaKdLxbbvKNBHD-o_toE-PbUYbZgjAH3WYaFNmmSeQJNLRKlS2PoRBoR1NDVPmBQD_j_q8QuPu7AI_9g49LnmtEpjpmxGTX3gPDVQAMyaFOOPJ9_bV7CE_mcBDtFuqq6ZPLXqfOQxFwLJ8DIAMbVlcoqMg-R4i5stT6r_tkgLtmKyZBFHiskwZVaIspJda6BRrdDs3w0mWvT89UJRDxv0CflfWfByz5PPwa4KovSIHJzBCwcUwSdKixfW6nUl53VcLpILlik3FbYDomOMLaYhMTHrCruWSlbF-VFueUtccGnuw67qJp0ngFL6LhzMiFlOPcGbf-QyViRXeDut-cG9tIjKmfVwxxxP2H8s_HNcOFuTCXuAuDobsV5ALtWRst4mVV_vdUSHlHEyPQ3Q4L5ROE31c4k1vX4zcbNoJIKsHIHPEhgp6lAbJUS8jqPE59M7IdFqKWA0XMucclFJi_hEe7tWqr7Qx6C9Py5Zfo8xNryjHb885wGgn8BPhCtRDhUAdpvo52mdpikk7JJVfXO-fmnGIKfpfT9o1vzvAmoSfsqjApigAA6o-8x5YTcC9GvCNp8O9kgTaS1vAimY
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: 162

{
  "id" : "sdc_5GLowiJ8Et2HEXv6c5kUw0",
  "title" : "test code",
  "created_at" : "2026-08-18T14:37:32.608204Z",
  "updated_at" : "2026-08-18T14:37:32.611189Z"
}

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.eyJhdWQiOiJjOTQ1OWE1OC1jNDA1LTRkNmYtOTViYi1jODFmOTVlYTc2MDkiLCJqdGkiOiI5ZmZmZGEwOS01MzRmLTQ1ODAtOTA4OS00NjA1ZDNmNDA3ZTQiLCJpYXQiOjE3ODcwNjM4NTMsIm5iZiI6MTc4NzA2Mzg1MywiZXhwIjoxNzg3MTUwMjUzLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fN2Vwc3drUXpSMUFwMjRzUnRwZFJERiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.fzRXwDoPSxpC-2pLNhGtnZ1RTGqw317CIxnoYWDv-6YQ1RhLRPk9AkBHVnLYCzV15sc3F6Bv-Tjfv72DV2Fw-VcScTa0Y-x-Cb_iVEsk2d-f9OLRDYnxEZ-cU5WU4ZIFKqMaT-mtFqi2MX9ykPPFpGbZm1Vz9BqYoHJSA3mL95E_nKPKin0RGl4E0RdlnnvViVayKop73M8DkEpavewfTkPEWHphDw7HfL0i1v0nontx8yETposR14FCpGAgvgVPXCYExleh29W3xWN17IFbzkFFV624mLi0D7MMo_aZVxmW4iv9R8Z07OTgIEIge7HP7-iKVkaiaeZ4pOIsWzmMZm4TJGdfM5sOdETZ8SQ91vsJDgjDf_wqYIkad-tLfR1ZkZBGi7wYQeCz3aHp-TDrII3sg8xTc_2xn5nn8By7qfashEzsw-MtAdW5_XqhoNLGRfISJ-Q6-uEWCZ6XilNyYKJkatLV7c4TwYcHrSAPHGhXBjOJBuLVS8opFEaUsXtij1uEY_vtI-2vKqoJ10oOkIuArGNlMlvn_Hl9STGn_xbwo9pDlHUHokre6KKoCYi_AHbMRa0LhRsdFKYSwyqvDz-E0ym0t3VeSQ1QjnBuW0oW8K0Z38cpVj_HW-hVKb9SfwlMOfVDXy1Qp1UB-ZgoQCe-WayGc_PfZzLEq_STVio
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: 599

{
  "data" : [ {
    "id" : "sdc_1D1FIL8VxAC4CAQU9hCGkn",
    "title" : "test code",
    "created_at" : "2026-08-18T14:37:33.724909Z",
    "updated_at" : "2026-08-18T14:37:33.728704Z"
  } ],
  "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.eyJhdWQiOiJmOWIyNjdlMy05MjVlLTQxOTYtYTQ0YS04NzAwODljZjhhZjciLCJqdGkiOiI4N2YxNDVlZC1jYWQyLTQxODktYmQ2OS03MzY4NmNiYjQzMWIiLCJpYXQiOjE3ODcwNjM4MDQsIm5iZiI6MTc4NzA2MzgwNCwiZXhwIjoxNzg3MTUwMjA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVxQ2lEb3JmMjdRRDhVc0w5VGs1SHAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.dplpJEeP0MYcbeQjEvXajHxhJDEwL5LcoAKQ2GaEFwDjYePBgBYzvJv1krFZH9MLRHDihNvoULFcpcop0vttAPV3gzT7hXTmKiY8a6BTzSXfKzIq4Kjw2VvKJrFEWmZ6UTHT3KDlNRWsU-TzVNaeNo34dhcK54qaQD6zrkpZnDns4rdSWsGY3aJsmMztLDI8faKgVjVLejPAd0mfCEqdtYp0c9VmI8KZkNXW1opF4IohjmSv1MomYBcM0kKgisZ8QLw_40O-YAesCQc_O-MH91jHDPOzl-hYu5PwPg9J8wKhXAazp-B72NA2JpJS0ax4K_QJRTFByBRQ0sBd4T7wI66iadF1KvUTO50loE5st9K2JcsFOVnJ0fsMMSAqeCQhpPeEanjdgNMlFfGAD9DZ_NHjVDP5NFagUW4p76h_fAS_kwCyvFRX7pNAtQVWxVphcXl7JU2p3uEmMvQPB0t4x0sNvp5GxutCcZ3BSun1cLtgfhtpYAmFFsmjsP0FlEKZ_Iy_1ehMfa4notlncSNizgZ5B-UUmmU5L9JPYIfyknepR3fAMfVM_wZXbHbG7HejFs5tQ4vZqiQMsSK8XkAK4tMZy3nPFsbRjEqBDHj16VtmI54F13oPUX944QSem_MvZG1-N-Mk29g4x8AKxzqK4gWG8hN7s6aYskiUeIlKVvM
Content-Length: 456
Host: localhost:8080

{
  "name" : "gvtS6xsx6z",
  "type" : "internal",
  "study_code_id" : "sdc_ubKYWYFKLT71sUYXTrTz8",
  "started_on" : "2026-08-18",
  "project_id" : "pjt_7LP2hy4IOeeRF5ZkZldEUo",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author_id" : "usr_26looBEvH7yUPgQCM7HqfM",
  "owner_id" : "usr_5z562tcDxR5uYYpBzB5BnG",
  "team" : [ {
    "user_id" : "usr_g9Y71O4Oonn73TcAjwMJn",
    "access" : "read"
  } ],
  "timezone" : "America/Los_Angeles"
}

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: 1271

{
  "id" : "sdy_12GI12eGURCLWn02zBk8tI",
  "name" : "gvtS6xsx6z",
  "code" : "OW-SQ1-26-F",
  "study_code_id" : "sdc_ubKYWYFKLT71sUYXTrTz8",
  "type" : "internal",
  "status" : "in_progress",
  "description" : null,
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_26looBEvH7yUPgQCM7HqfM",
    "name" : "Axoj2AHnsE",
    "email" : "liSIakgm@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_5z562tcDxR5uYYpBzB5BnG",
    "name" : "8QC38Wn44B",
    "email" : "jEgZHhvk@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_7LP2hy4IOeeRF5ZkZldEUo",
    "name" : "8wTeBsZvLX",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:43.538076Z",
    "updated_at" : "2026-08-18T14:36:43.538076Z"
  },
  "timezone" : "America/Los_Angeles",
  "team" : [ {
    "id" : "usr_g9Y71O4Oonn73TcAjwMJn",
    "name" : "WcX1kxuSYt",
    "email" : "ACw9kvh1@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read"
  } ],
  "started_on" : "2026-08-18",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-08-18T14:36:44.297792Z",
  "updated_at" : "2026-08-18T14:36:44.297792Z"
}

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_2tQGUUPWauHWVdlN3bv349 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkNDI2NzFhMy1jNTMzLTQ2YWMtYmY4Yi1mN2UzOWE0ZDZlYjMiLCJqdGkiOiI0YmNlODQ1YS02ZWQzLTRjZDktOTk3Yi0zNGQ0ZDNiMWY5MWYiLCJpYXQiOjE3ODcwNjM4MDEsIm5iZiI6MTc4NzA2MzgwMSwiZXhwIjoxNzg3MTUwMjAxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZDVUEwTGhhZlRJdUpSVHJ2bmpuUlEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.kd1rh2F7szgF77F0Tw5iKev0mWh4iRrSzna9o5_RgbaFB7rmZcHTBENCyCAwZpwe7me2YAB3nJ0XAHvs6l9e8dA5seVAt_1Tw4TBQm_L3QoU9P1uAnsbqOylldg6_tN7HLaPvSNyAbBNe82CvojTAVFkJS6folv3qc0u2P0epc16p1vhrRqNiGifZH1-Hxwqzlf6IPIZfpoSbS5hnO5REaHrN6GxfYIPceaBPyBqXHU-66DRFS7F2c6oVtIWslKugBN1JPuwvf-am3I2rtoAfYv_3Hwd6KkCad2BDYTsMZDAxZjFwXwyjkKn-Rjfia2gE1jupMLI5odjIXwP5hYi84-_DVjnaW8vO9U0eCg9qfcocmQ_RjXdsw-gW4axxZmHGoyqdtVWfs4__U_efr8gZOUcro1pUWoc6lzUSnEHToORigC4oc1RIZ-jr2EGM1MUITRqiIYWH8IKKcvQFKR9VtY-kuQn3j6jBV4kI2nJesvwOyOZa_TmzIK2yuclPq9NXfZok4JYg6HruyKjuaZ6OV0VumlZSatk2ei7PxBT1L6Z_forG3ayDZi3bMSQxz41kMy0vYDlaDi7SQkySOfDr31BAERcsJWjLD5K5pgoyMVBRCFQ7LfxDa797AedG6HSN1MIoFvYUrFG5VqnTyZ3_C1nmer3AlevVh9R2gdIH7I
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: 1082

{
  "id" : "sdy_2tQGUUPWauHWVdlN3bv349",
  "name" : "swD1rA285q",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_6jCen9xJfiX3JRzC0Ocf9e",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "mZmVB3bEST",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_1AT0fyeiSm1hbbor8gMcA5",
    "name" : "D4BfH7uQpA",
    "email" : "er6FaoRg@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_4wjTQWVr5y2ihAev89NoZQ",
    "name" : "9vyXRGFVJ1",
    "email" : "77i7p5In@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_7BLLNHjaEGURhkGENj97kk",
    "name" : "P6oiy31qHe",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:40.616819Z",
    "updated_at" : "2026-08-18T14:36:40.616819Z"
  },
  "started_on" : "2026-08-18",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-08-18T14:36:40.632397Z",
  "updated_at" : "2026-08-18T14:36:40.632397Z"
}

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_49THHmAWrrIczQmo35HZS0 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMTNjYmU1ZS1hYTZjLTQyNTMtYWE5MS1mMGZmZDIzNjQyYmQiLCJqdGkiOiI1MzZmOWRiZi1mMWFkLTQ4NTEtYjJmOS02ZDAyNGIxMjg1NzMiLCJpYXQiOjE3ODcwNjM3ODEsIm5iZiI6MTc4NzA2Mzc4MSwiZXhwIjoxNzg3MTUwMTgxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI5NkRueDZ2VkRGa3RDWnRwWWJLMlUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.E3yEemuNFJNBGO-ordvRiOleqmnhK3rWsdoh0DKvEqI6Rw8bvAdNW_SX-wmrZKhez3ONfLQLWU-JJcml0ldkASjMosJ8lNu97Xjt32KLwT_Dz5a6tC7LSdDOmo3ZiZ2ddO7HsgJB0DbLVVBB0VunAz3jA5odlqbq625SYv091RdzFs2U3sqhRhruvHC-fezn4kmIxrog4X6Y59PHv51I4R-df7QDhTFYqFD3pCdkQTU_EEzwDat5NzB1nACYUc82IJybsZeuVDvkkeP9UEx5galPTDMXJBAo_vBww-EpVweFrKQE1FxXHB9oa9OCfsUj1D0WX1358rxXVj3Qf0izmp1FuhGwjJrr0C2uQyy4GKz3HmhD47f8481lfSoRLfD4TGXxYG1DPBaiONYXNthQUtzAYv5-0SZFbKdmITczgntU6pFhSrmZHuAc040mmAhiBLmt-btBTe5DAz0h3sZLyKPQJfLgALEIP2uoglFMx6p_QmfwwHm2EVH0mgkrnEyUpbB9uJHu_tkRNoyCc1mwTjcZgx-hbDdROFmnqcDkp_hLmWTwMokkoGli8GYKjXmfmGQKfbPVGgKDRjsWbgUKa1FPvD2iIsQXOKYYsSv1aRTFzpGLJytLUf8go2CtHFlDzfhIEBCiDuzzHESzxCH-dwX77WGlpq7aEBIc8JTI8mU
Content-Length: 277
Host: localhost:8080

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

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: 1096

{
  "id" : "sdy_49THHmAWrrIczQmo35HZS0",
  "name" : "Benchling In Vivo",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_3DaxDy631khNZyhLrZKiKZ",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "xlSNRoGHtW",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-4321"
  },
  "author" : {
    "id" : "usr_eqjoZKnSCzsZbBMyeoer4",
    "name" : "CgY25RrSMS",
    "email" : "3UF7h65f@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_4TaiFbdm4rRBaw5xbfzJF5",
    "name" : "7u94SbRjqU",
    "email" : "jS9yscAc@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_2Xnl3mxXJn1Cy5SsQkNAHG",
    "name" : "iUAYsPxjMd",
    "metadata" : {
      "project-internal-identifier" : "PROJ-1234"
    },
    "created_at" : "2026-08-18T14:36:20.868883Z",
    "updated_at" : "2026-08-18T14:36:20.868883Z"
  },
  "started_on" : "2026-08-18",
  "tracking_day_base" : 0,
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-08-18T14:36:18.334289Z",
  "updated_at" : "2026-08-18T14:36:21.529243Z"
}

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.eyJhdWQiOiIyZmNlZGQ4MS0zZmFjLTQ4MjQtYjJjMS0wN2VjYjhhOGEzODIiLCJqdGkiOiIwMTk3OGFkNy0yNGYwLTQ1MWMtYmJjMy1jMjkwMmNjMDNlMjIiLCJpYXQiOjE3ODcwNjM4MDIsIm5iZiI6MTc4NzA2MzgwMiwiZXhwIjoxNzg3MTUwMjAyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzROdTdrQUFtZlBWalc5RVRLMjU0RmciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.OK347zofoXGtw2uYK-n4S2LoffPq4mDzW1mk5hUH42iV81gOaxB-lWZzQDESnZmoPJ9hZ8u77LxXRyBz9GR1_Cvj71f3VeCa_Qd8Ckpw2o0BCtDF0sLxSR4sopDGjIUSeBB8OB1UB6xGzn1Hz5s66L7LH5im9AUtquM6zWut75HRLVRYSLBYORQm2BfXPTVV_s_6CE6UyiA6ekSmKqIxKQ9ge4LadEYA1GXKwxLw2kl8ClhbJjOEfbIOynXOqZnPw23sbtnNGgEhXhUTTGKnqLPeEVGpHimtBzluwBRzcLDK5jPgCe6Qzx24LMzUZ4UUejvPoAp6heApal-IdSX8XrXLZZ4GrAMQDAHeaJ4WR6C1rEGWfTnGtVI14xQQ08xzJX_eBMNG_kj2h9kIV_YDnkXukGVQ5dAy20zossZJts4TwJO3RJKlNprRIVda-XKYQT808IoTRCYKcwj7ZGHchwuHUEcWR1HqPkjLnJ0UhY0UuGGzU32jKMHMU5pdFwgBTJt2uheHIfNq5zHDQSOlhc6dNM-7pXAdEM-C1n4FkJDFa3QmhxfTv4gyiyscDd558Krb-QLipHGtNoX9hL-kcNlkv_L8NLfga6NxbIenPF-ih5-RJXVLwOX1Tv9XBFyQZ7Kq3zyNlLPhpRcli29P2TTtRyZohJKFAsD-XsXJHuU
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: 1559

{
  "data" : [ {
    "id" : "sdy_3JWQSoRctAyq1QscHF3Gu8",
    "name" : "Gb2pOcvr4d",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6fFN0Hn1dmzfgniCwHaagk",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "VkB9diYAu6",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7FlacDfSRopklaMZsNhCeQ",
      "name" : "noSQSASRvY",
      "email" : "ddl8R99r@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_V8MhlhzsosrBKdzF9DTIj",
      "name" : "OgYtCwW7nE",
      "email" : "7yb4iRf6@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_1tihJQ2RPaXBCt0WOj00Th",
      "name" : "jMYnAoxzhC",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:36:41.594259Z",
      "updated_at" : "2026-08-18T14:36:41.594259Z"
    },
    "started_on" : "2026-08-18",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:41.608193Z",
    "updated_at" : "2026-08-18T14:36:41.608193Z"
  } ],
  "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_5IoSDVS1PjwJy3GH7Y7EEe/animals/aml_6XaRcODkv4lzbgW0JhWeA1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyODIwOWI2OS0yYTNhLTQxMTQtYTU2ZS01MzY2MzE2ZDIwYTciLCJqdGkiOiI0NWMxOTllNS01MjY4LTRmMjktODk0MC1iNGUxNDYxMzhmZWQiLCJpYXQiOjE3ODcwNjM4MjQsIm5iZiI6MTc4NzA2MzgyNCwiZXhwIjoxNzg3MTUwMjI0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVUeXFKUHBrUURCZlVpS0dmZktTSUUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.WBs8HSVIxrwZlSl6Q4nT6z0hEdy3MWlfBQMdLxbRVy6HUe_laGqtBaEtZKlidIYHeJqsKtoa7-gdKlN9Q3zAyU4G373giMlD_KoGPvCEUkbm0H6Fua9i2QZWUOQvB0xHnLC29n2xfu4Q60SCRf3nWp_dhiNfim20zS5G8cPHdiWbFynCQCAtH_GrTCQFbEPy3sHELMZUAcQM1mhyagnG8Nev30qqZ_3Hb9qtG3Fz8N9mg-pek9Bj7S30HHyXz1U3M1ZV7Fz0Nxi5UyRJuD5xGrzbp4hGEWpsadonjikmIAlBBvWVLT7pJaCgof6NudwZzGWEd9N0D8sjgD9VSXwafKzFuO0FCNRPReiW7lF-DXFwgxiLe0SEPvNzn6G40NGMftb9qfIiISWRTzMZARVwVm2eTOVH-BdcidP0dCFh95Ln88TUWayJG_HHTsU2pRssvymh9uysoNJCxBGnJvS6fqcU5KxhXkBRp_E9TXKfG3lVFhc30pm81pR81xvZoL2z12R3DP_gZ0LpG1jU0gZ6X0PlP4IcX9xGmKNZTKaBq2ULacR_mV1Z7fHZcaCxGXqHHdIfhYN5XGhbppyCX1Itirdshjj7ebXwY77lp-lkckkVhyI5zjcjI0MEVbYfE0dJxoAUyS0jG3pNW-f4ETy1vc9hhKokMMtJXjJJ-txNrA0
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: 2580

{
  "id" : "aml_6XaRcODkv4lzbgW0JhWeA1",
  "catalog" : "A0000001",
  "name" : "2jfavUpWM2",
  "number" : 1,
  "strain" : "YYVn5U9DA7",
  "species" : "sYUNYWUG7r",
  "sex" : "m",
  "dob" : "2026-08-17",
  "tail" : "G4kYNqtSRk",
  "ear" : "8964LPU4qp",
  "tag" : "7Ym785htYw",
  "donor" : "xvfY1tStM1",
  "tracking_date" : "2026-08-18",
  "disease_induction_date" : "2026-08-18",
  "terminated_at" : "2026-08-18",
  "terminated_by" : {
    "id" : "usr_2rd5Dw3b9uqAIY8IZBct1L",
    "name" : "XucLbIhq4y",
    "email" : "acmxcPL0@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_2UyobJG2Y9e5eaBREbVZA2",
    "title" : "Found dead",
    "comment" : "HJJykiC67z"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_5IoSDVS1PjwJy3GH7Y7EEe",
    "project_id" : "pjt_78TLy5saGuxbiC4Uwr4GoX",
    "name" : "yRIsmldnIT",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5pyscxOiR8xBZWFu3AEuvN",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "wLHWI0h7XX",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1sBnfgr0l5jH1kRmWrkWak",
      "name" : "AiPxVEGwKT",
      "email" : "3XA6omqB@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_79icAqRXy16Z9xuSuniwkk",
      "name" : "F1cJS37eqx",
      "email" : "Vuy1g2In@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:03.444922Z",
    "updated_at" : "2026-08-18T14:37:03.444922Z"
  },
  "study_group" : {
    "id" : "grp_3ZjsZqLYwjtRBZOdWEEa0e",
    "study_id" : "sdy_5IoSDVS1PjwJy3GH7Y7EEe",
    "name" : "Bacw6zDdZ6",
    "no" : 1390240044,
    "color" : "tuzK8Nk63t",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-08-18T14:37:03.976224Z",
    "updated_at" : "2026-08-18T14:37:03.976224Z"
  },
  "cage" : {
    "id" : "cge_mnkxfnL3yINsh175fuWYQ",
    "study_id" : "sdy_5IoSDVS1PjwJy3GH7Y7EEe",
    "name" : "DY64fhgxdJ",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-08-18T14:37:03.940256Z",
    "updated_at" : "2026-08-18T14:37:03.940256Z"
  },
  "created_at" : "2026-08-18T14:37:03.989403Z",
  "updated_at" : "2026-08-18T14:37:03.989403Z"
}

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_2lbSsDKGg1CFDYZHBZnpgs/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3OTMxNzI2MC00Zjc3LTRjZDgtODQ5YS1kMmU3MTMxOTAzMDUiLCJqdGkiOiI2YzRhZWJhYi0zZmVlLTQxNTAtYWE2Ny1kNzU0ZmJlNzI2YjYiLCJpYXQiOjE3ODcwNjM4NDEsIm5iZiI6MTc4NzA2Mzg0MSwiZXhwIjoxNzg3MTUwMjQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNLQW4xZGtXaUdQUVc3eGJZR3FZWGMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.h0h8Krsb-sAZ8U3OTtouhb-UkpcRnFbk8wc_CuyLT7rkDccfTcoXqi_WrwMb67DS9G0B0QS8lGm5_kRcoO07I1v0AqkvDDHeHKPmXzjyRK0-g6SK-302rV-fS528MwxaQTTApmJuNBQz_0Tja4VrxcKswSxzEikk9I7i-coD9uzBBMWq46nUd9ZKjWFaOf7foLqCrqEoNhPrZor-DgFekxdq6D-okulJE4SfUWGhHI-squHyZr3jV802qMDve-weynNzp0_ocmklKfQWe7OMYB5GiXGeAS7HlQeChtT9bxsCogI4kH5P2TMvht7tnW1hEfBwOzcLs7v1FhaqdJYT0-VPUKjk0HJWqvEy0L3m0mF7NuKNQkbmKEilv3KOC9i_rbFrFBAhDG2aHkt2rrMtDeUscr_wbm4E16Qqy3_q1oTmoXhG19QVw975P-X31yIGmvjeZL8fTPXuGyDqyKwEX4qBSkO19YIij8wS00lpSDCCMiuTBkk0V1Q6hXXZtoyRwT4F-taUsXTXUCdC91mdyqHXpj-WuFGJ7NlrEcY-Q1o_YJtQlZaqH0fikFemoUXGUqy3KnSOCWYt9pgVXV7PlWY8PhObB8I5PJ17ukncChArtsAcOBHrTXT28G1j6687nqV0N5eVRJRyVY6dLk8ZlVT-sjysdtDG-IL3o_U4N7o
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: 3264

{
  "data" : [ {
    "id" : "aml_7GOcXG3XdJcQIBjUzMOq3t",
    "catalog" : "A0000001",
    "name" : "EojUk547KN",
    "number" : 1,
    "strain" : "bJzyVAL916",
    "species" : "TWJ9gzt8pR",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "JFHCbLJJJP",
    "ear" : "XOrEix3wZ2",
    "tag" : "7KP1Dn4SM0",
    "donor" : "hvd0wKjh0l",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_7RsRMUka7zeJXUo6PJaltN",
      "name" : "FBAs7fO9hH",
      "email" : "6LzfmGcP@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_46dVBzodRWQQr8tBz7CLB",
      "title" : "Found dead",
      "comment" : "zeDyC3TXSa"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_2lbSsDKGg1CFDYZHBZnpgs",
      "project_id" : "pjt_6XevXzqslUNoEQWrFjgvlV",
      "name" : "FsY1RsdkW2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2zYfJIG4q5mIdFwZyIoGaW",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "Lw1FOaHdEr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_472kBLwl0lx7jCuhyGufBx",
        "name" : "LkZNtubTVF",
        "email" : "IFIiFL4M@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_677Lppu7Btq8aGkMXJMmjV",
        "name" : "gHCDUgJ5aR",
        "email" : "QW0G6E6R@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:20.747331Z",
      "updated_at" : "2026-08-18T14:37:20.747331Z"
    },
    "study_group" : {
      "id" : "grp_5EUEgvQwqTYfx8txsJptwV",
      "study_id" : "sdy_2lbSsDKGg1CFDYZHBZnpgs",
      "name" : "9TfrDJto5f",
      "no" : 931577068,
      "color" : "c8tydVPwWw",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:37:21.077307Z",
      "updated_at" : "2026-08-18T14:37:21.077307Z"
    },
    "cage" : {
      "id" : "cge_78qleRX2A9dpRqZxRDGHOJ",
      "study_id" : "sdy_2lbSsDKGg1CFDYZHBZnpgs",
      "name" : "Biz34XaUYs",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:37:21.056833Z",
      "updated_at" : "2026-08-18T14:37:21.056833Z"
    },
    "created_at" : "2026-08-18T14:37:21.084071Z",
    "updated_at" : "2026-08-18T14:37:21.084071Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2lbSsDKGg1CFDYZHBZnpgs/animals?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2lbSsDKGg1CFDYZHBZnpgs/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_2lbSsDKGg1CFDYZHBZnpgs/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_72YLUsU2VZT9DDe6RECYxu/animals/terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzZTdiMDY5Yi0zNGIxLTRhOTctYjEyMC1lNDc3OTI5OGFjODUiLCJqdGkiOiI0NmQ5NDdhOC04ZWI2LTRlOGUtOWIxOS1kYjEyNzAyMGIzNDEiLCJpYXQiOjE3ODcwNjM4NDAsIm5iZiI6MTc4NzA2Mzg0MCwiZXhwIjoxNzg3MTUwMjQwLCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVIV01iUUhjUDIxamdHTzdudmVKaEQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.QO_xq6NxZbjiVxtJjMhHKX0XrtHC2p3kxwGRO8mbqDYk_DdTP4hF1V-9tHN6n5eEDGgpEFjKbrhH2IwJGPjqcfOjrE-yBMy3CYrhG-jrk_BghOR3DBM9a5XaDm4_Oq00yTLre4JehEb-aAhOYEYAL-qjUEPth9KALSLFdMFAol04Eh9dMcPeklbqSAb5dj58WB3dk9jVlV0VbUklqn6FmtS0dV0bdBftzudcZh8ljeQ1kfqjXw3-5WtuksxYSOmJTq0WBfsjYPuO-XOFij54YjcWLM0FOvHlR1T7jtpqYgZcu5SpEWPghsqYKJJojCVthtVatxu-NLV61g6-3gcrBqytBpalXsHB_wCXiWbtjR_poBRbhKmsp5dyNKGiGozt_m8HadsA92gGVeEmezi2WKx06Ebl1j_79YoGPN1UTnuOn6UPscRnq31np8Otw6hyaMIvBRUfx4YHEMCAtPGn6znPD3h_NVQ_aPD7ZEB0deRLPBIDicX22_6S9UdT9oP02jRcHOCGvM65lUp0i1WfrL34Pyc24gpCkFW4TwVuduiwyekzSY9hPxGfNEgB-VJwDcbyg7WOAm82AMZmI0sGLmPDfqXghJBrtSO9C5UrmddhhxKwGlKQ6w8gstygOUoDEz8SQf4-K8ypPISwDuqaShKKNQyhcKAjWXR0opEEpYk
Content-Length: 210
Host: localhost:8080

{
  "animal_ids" : [ "aml_d8KDaCzK3SkwaX2hkeALw" ],
  "termination_reason" : "tgy_5One81kIM91bERM6QRfNi6",
  "terminated_at" : "2026-08-18",
  "disease_survivor" : false,
  "comment" : "Scheduled termination"
}

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: 2329

{
  "data" : [ {
    "id" : "aml_d8KDaCzK3SkwaX2hkeALw",
    "catalog" : "A0000001",
    "name" : "a3t2B3qw3D",
    "number" : 1,
    "strain" : "oUWajudLSU",
    "species" : "NGytZdCZKd",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "JhvYwcqqIJ",
    "ear" : "EWQcdTKZDD",
    "tag" : "d5YuOrbXW4",
    "donor" : "2qZcQfOnjD",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : null,
    "terminated_reason" : {
      "glossary_id" : "gly_6L9a5ILQawN6nJ2uUO5FMt",
      "title" : "Scheduled Euthanasia",
      "comment" : "Scheduled termination"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_72YLUsU2VZT9DDe6RECYxu",
      "project_id" : "pjt_5VDfkJD75PKBxQ1pwxJhgc",
      "name" : "NfRmWJyM3I",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2BlIjkv2S0XjnoIAt8kNws",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "txOscdWCFH",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4pVKuVn6YxY5QqdBimBqcf",
        "name" : "wjDj3f4XSN",
        "email" : "lotuiOF4@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4n6tjO6uBAsDbhKWAtBP5y",
        "name" : "rrWOmdgY6p",
        "email" : "eNLgylAt@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:19.688467Z",
      "updated_at" : "2026-08-18T14:37:19.688467Z"
    },
    "study_group" : {
      "id" : "grp_5I0A6jch4t97QK9EJ3U5Up",
      "study_id" : "sdy_72YLUsU2VZT9DDe6RECYxu",
      "name" : "i555Da9zGQ",
      "no" : 376551082,
      "color" : "GPgbJ8jXrF",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:37:20.279536Z",
      "updated_at" : "2026-08-18T14:37:20.279536Z"
    },
    "cage" : null,
    "created_at" : "2026-08-18T14:37:20.291158Z",
    "updated_at" : "2026-08-18T14:37:20.467394Z"
  } ]
}

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_3GxQtgxn8NyoXZgtGTXQ2C/animals/undo-terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZDU2YTFhZi1iOGFlLTQ2NmQtYWY5Mi0zOGU5OGMwYjMyMTciLCJqdGkiOiIzNWNkNDhkYi1iYTRlLTRhYTEtYjAxNi0wNDU5NDVhMTA4ODAiLCJpYXQiOjE3ODcwNjM4MTIsIm5iZiI6MTc4NzA2MzgxMiwiZXhwIjoxNzg3MTUwMjEyLCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNSU1hiUzBPSm5vR3F6U3BENkVGOVkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lEwV0S9LPhHnV5NWkICBDUmJwSgCqjLRPmEGC8CpXSjhSP4izclCLYIGvk7M-EZk63nQCH8RJbQDpMnEGyyQqUVD2O2YKN9ms58k3G3BpF5M5zoAg2ELyqRlBcsTXba-_P_oWQE_W3KxJIm-6asus2B0I1ZVvWpAmnQ8Amn1xPZCsqnbeAcZVI_gnhXWRiitAm59aqW6-tWjjGuM0SHQRIge1pIF1TfegcGQCpWz3Er085z5tVhN_ElNDhWTWNVbpnNKnwZk5vpvGvHzl9aSXwu1OWCfgVzHbJrQlPi2Gp8rW5xBw4DT7_u0u325MT5IAnNMlwIwaetVMdhOtwqrMY-nwyw1s5apWyCk4i3_thfF77E1jq8jTI4YC6gc5ESNazIgGKU5uHaDs8FAU22GUTes90hNVROJV9ph32NzgkvZUDbWqKeVukW47eTF0BGeDQU2jBwk9CPDHrZsf2ujRtB2OxoG-WsYXyJXLpx1qn8XLYMpChYKJilmLN58p6pbfV77cU65bpyc29UazFTvCybT6CkB_NvGfJb-wMT0EkuwlQTFYa6clDWIUYjjGOMtj6TsfTcsZC4Dk3EKFhAkJCZH-qt5wuUebxY-5XXhh_GIunztHxbRoMon1Fpf1VtdvEeqy2nqxaUR0DTZGF5pDNgy3dfune_7FIBjfPMMiQM
Content-Length: 96
Host: localhost:8080

{
  "animal_ids" : [ "aml_4jrNch8b8dgjOZKV53Ig0d" ],
  "cage_id" : "cge_kRi0LkpwLLPGgO1Iphkaa"
}

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: 2465

{
  "data" : [ {
    "id" : "aml_4jrNch8b8dgjOZKV53Ig0d",
    "catalog" : "A0000001",
    "name" : "2AZYj3hwnw",
    "number" : 1,
    "strain" : "zNkjyjKRWP",
    "species" : "GkBuT9sdTw",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "OLIOAzWIQp",
    "ear" : "lOIKwxbAdr",
    "tag" : "tmY6DhbyNu",
    "donor" : "DXqGLhRtXM",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3GxQtgxn8NyoXZgtGTXQ2C",
      "project_id" : "pjt_2Ai4TyaCt4NErJcsFFlGMb",
      "name" : "92sRmealc5",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5rmojv8SNH8ogYovjc51jP",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hXOWV1HS1e",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6v3uJkaWvkT2NgYlB2arwF",
        "name" : "iHdRpOpgNA",
        "email" : "FQmkcwSh@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5vz0WtLoFSSo7p23pagXiT",
        "name" : "y4fktf9Uj2",
        "email" : "JwpCCIUn@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:51.436374Z",
      "updated_at" : "2026-08-18T14:36:51.436374Z"
    },
    "study_group" : {
      "id" : "grp_Ni0UkSlPeM7MAB6NCSpUR",
      "study_id" : "sdy_3GxQtgxn8NyoXZgtGTXQ2C",
      "name" : "wAOvTIrGrk",
      "no" : 2116774841,
      "color" : "NTV1a9vAPC",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:36:52.135950Z",
      "updated_at" : "2026-08-18T14:36:52.135950Z"
    },
    "cage" : {
      "id" : "cge_kRi0LkpwLLPGgO1Iphkaa",
      "study_id" : "sdy_3GxQtgxn8NyoXZgtGTXQ2C",
      "name" : "PQx16ILvW4",
      "catalog" : "C0000002",
      "metadata" : null,
      "created_at" : "2026-08-18T14:36:52.179352Z",
      "updated_at" : "2026-08-18T14:36:52.179352Z"
    },
    "created_at" : "2026-08-18T14:36:52.151456Z",
    "updated_at" : "2026-08-18T14:36:52.949816Z"
  } ]
}

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_64Q7rcxGG3LHAV2Pg0jpRt/animals/aml_2eJIlWK7gvGPLeawZDukUp/dosages/dsg_3GYk5Iny7Wl7GVKTzqHSfJ HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5M2Q2NjM4Yy03NWU3LTQ4MmMtOTliMy00Mjg0ZTk2MTUyNjQiLCJqdGkiOiIzYTZjNDhiNS1lNGM5LTQ5NDMtYTBlNi05ZDAwYzhiNjYzMjciLCJpYXQiOjE3ODcwNjM3NTIsIm5iZiI6MTc4NzA2Mzc1MiwiZXhwIjoxNzg3MTUwMTUyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZFWDFERDJNNjRFVmp2M21ud2wxRW4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XazeVV3gjOoDzqOlihtxyN1knPjVMd-KDExVLL90c4CauUnR7TySmBAiyq5Zkmuy3Hp564Apj43p-kQ9_b3xjbiM3IcsbihU5vfKDdqV5k1M2ipgmTY6AiGJhlr2mRtTV4AyZnS_UJFf4yJ4xCaaFBcPPN_wZ6w-TVztJtxHz1aZ-03CZXmnNpSuOpgWVqhZzElP6gQ68KjUEM68EUf2Gq04mUJJfX3iLmwMtOyMgY3N6VlnZU4-pOonBFvOMcHMbzeFNtn5Rds-EQcuLUKE35WuwojJx6BreMoqlDTHcrG4sMSdG6qG6mQbZp2wp2HJDo_462VWJ8K_PxkqBv_5TVrzrJRZMfQqECawEn0ogdFs8Q2qqg5eFsgw8pJSzyy_rClj-TvtGS445IV03bh6_0XGfGuejgHu8txPZdobPltUJG9cmn0xoI2MVqBxPcM3eEgsu5fNFYtRvmW8S_578EkkE-NIzVckhJOY26HA4-mVT0izjGninFKTJ8DNlpXbjayidv2ZZIFWX_QJxS7lWCX0eb7K-S21zk3g3zMGWgxRTccy2rTkhxTJVPWRLOiEN4Ob0zir5u3lbIahlShBz0DP1S-TfV_3qg9cwnXBxRZhMO_PHtv4he15a5QNAgJpO8fLaOFj0PNesmpVakC2-gtyTRHw2WsXOHlvHv6-jWY
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: 4779

{
  "id" : "dsg_3GYk5Iny7Wl7GVKTzqHSfJ",
  "name" : "Example dosage",
  "dosed_at" : "2026-08-18T14:35:52.158957Z",
  "comments" : "fuDr4m1eV9",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "4.69",
    "display_unit" : "mg/kg",
    "display_value" : "4.69"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "13.64",
    "display_unit" : "ml/kg",
    "display_value" : "13.64"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "29.94",
    "display_unit" : "mg/ml",
    "display_value" : "29.94"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "32.48",
    "display_unit" : "µL",
    "display_value" : "32.48"
  },
  "study" : {
    "id" : "sdy_64Q7rcxGG3LHAV2Pg0jpRt",
    "project_id" : "pjt_723cpdblcTXNinxvEwu87f",
    "name" : "dvp23is6yX",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_56lQGctojI8tYpKqVOFq4P",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "dkBRdG6Jcs",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4It6GUbtFsRRzr3H1V4xCA",
      "name" : "8zKfBgjy13",
      "email" : "Dyj7QYfJ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_140tkysmgUTpowyPcXMu7E",
      "name" : "t85MIfAD6l",
      "email" : "VZql2QPn@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:35:51.403073Z",
    "updated_at" : "2026-08-18T14:35:51.403073Z"
  },
  "animal" : {
    "id" : "aml_2eJIlWK7gvGPLeawZDukUp",
    "study_id" : "sdy_64Q7rcxGG3LHAV2Pg0jpRt",
    "study_group_id" : "grp_3WHR64lTI0DoUovsYS320j",
    "cage_id" : "cge_3WuPPrb1WHnwH95TN2lwTc",
    "catalog" : "A0000001",
    "name" : "SL4wPWYF73",
    "number" : 1,
    "strain" : "NSExSwSTEX",
    "species" : "DK2Bypy8Pu",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "NFzOnIfZpz",
    "ear" : "isw7Sx7ZNf",
    "tag" : "JlPf1JyPl1",
    "donor" : "eklk3Gk0QU",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_DsUif2RagmPeBPgSzW3t7",
      "name" : "f7t6Zj2dlr",
      "email" : "9fGsPVQ7@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_6lAvP8eybZ6kYjccJNb0Km",
      "title" : "Found dead",
      "comment" : "aIPkwHsz1I"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:35:51.878373Z",
    "updated_at" : "2026-08-18T14:35:51.878373Z",
    "disease_induction_date" : "2026-08-18"
  },
  "measurement" : {
    "id" : "mst_7bIbxslChA9mvK8z6Yta3H",
    "study_id" : "sdy_64Q7rcxGG3LHAV2Pg0jpRt",
    "animal_id" : "aml_2eJIlWK7gvGPLeawZDukUp",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_4vI3Eyhr7rrTdvmYsJIRSJ",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_4vI3Eyhr7rrTdvmYsJIRSJ",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-08-18T14:35:52.097063Z",
    "updated_at" : "2026-08-18T14:35:52.097063Z"
  },
  "user" : {
    "id" : "usr_7YbmbgKQGC2TEIqNWR2tDO",
    "name" : "RwvZg Overwatch",
    "email" : "1Rnf9xQs@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:35:51.350199Z",
    "updated_at" : "2026-08-18T14:35:51.350199Z"
  },
  "treatment" : {
    "id" : "tmt_33WOwszbO4cBJdDX4I6KDx",
    "study_id" : "sdy_64Q7rcxGG3LHAV2Pg0jpRt",
    "type" : "volume",
    "name" : "T05t3LFf4i",
    "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-08-18T14:35:52.118774Z",
    "updated_at" : "2026-08-18T14:35:52.118774Z",
    "external_entity_id" : "oo4pGDj8t1"
  },
  "created_at" : "2026-08-18T14:35:52.159047Z",
  "updated_at" : "2026-08-18T14:35:52.159047Z"
}

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_DrjD7P5Fw4k38f1CntoAp/animals/aml_7GNISCxgoTLz7kxHrZoDFo/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzN2VmMDJhNC1mNDliLTRlOGItODVmOS1mNGZkNDU5ZWEzNzMiLCJqdGkiOiJmN2Y3ZGQ3Yy00NjU2LTRiMzUtOTkzZS01NGUyMmJhZDYwZTgiLCJpYXQiOjE3ODcwNjM3NTcsIm5iZiI6MTc4NzA2Mzc1NywiZXhwIjoxNzg3MTUwMTU3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0pVbm1XaGZZWmlBekVwNG5QeEpBVCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.QniWdzy7pwGTLRLCmwtrsX1ixrtmQeOGgVixkhL08myh1hAXZ_IjyZ_3XjKlLvA37KcnbDmkDEQ7nI0Cp1uQgBgPfwgM96xcJU6A_Y2EWN5VIEGWhi1ioNhNFvgj6FLkqg1kFiaSkPSVwFlGF4uVuvqD-fZlILPhgtKIzG2mvHZNFK5mZCjEPrAP5KLRq0w8Vym4nNaxvVzufH_uJvfS4hYWkIiDMHDS7MetaB4H-emD5RF_ThX_E2m88T2mHKiFs_A9LDy7JmuWnPitkCpEG2QJ_Fbf7XbAhrVceyjg-FnebIPZHG9CzPgmYCczI12xErr6y0SLALdOg_up-ICazRfa8wKSFjdpNBa8JVUonRT4R9sECVjmNzVYL3KRQULxWnUAqpucTTgJZmnM4zHS51iBddHtMfcY0NCpJZoTxoTsp0mURr3Rhc3o0ADRUKz1vJKWJ0ULTCyUHmXRIWP4ons081QV0X5Iu4srM9_Lw-522ykzh--_e0NmnvZu4UA5PKrA0qAlftx2AvFnIik4QlrNxsVWBmhYPx3IobrGtbPJ3LvWb5an4FQbrwM9_468wuBXrHcQ25KOOl5IBFqrt_oViofiZUEerqmm0yeDcm2YBBO19b7oMP2LYuJNFEp3-lbpMqQkXI6RvMeTgig2hNbGwQBUU78t1s6FT9Mjh6I
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: 5738

{
  "data" : [ {
    "id" : "dsg_3KGqvmDCcL7cPjlHOjpU2A",
    "name" : "Example dosage",
    "dosed_at" : "2026-08-18T14:35:57.953365Z",
    "comments" : "tISvHHW48H",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "3.47",
      "display_unit" : "mg/kg",
      "display_value" : "3.47"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "15.93",
      "display_unit" : "ml/kg",
      "display_value" : "15.93"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "29.64",
      "display_unit" : "mg/ml",
      "display_value" : "29.64"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "35.08",
      "display_unit" : "µL",
      "display_value" : "35.08"
    },
    "study" : {
      "id" : "sdy_DrjD7P5Fw4k38f1CntoAp",
      "project_id" : "pjt_KbsI0SRGHBtVLgv869kwI",
      "name" : "7eNQEhAVAG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6KiVWXLyAiML5mRgp1EXNn",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "uqlkbWnsba",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7Uifpybrfu25tuOnznyeRY",
        "name" : "lZTO0NSJJE",
        "email" : "FO5iZnj7@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6TFcgHD05PW9gVmeAbJvgj",
        "name" : "qBJboguaEU",
        "email" : "G4Vva5bL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:35:57.304667Z",
      "updated_at" : "2026-08-18T14:35:57.304667Z"
    },
    "animal" : {
      "id" : "aml_7GNISCxgoTLz7kxHrZoDFo",
      "study_id" : "sdy_DrjD7P5Fw4k38f1CntoAp",
      "study_group_id" : "grp_8AFStnaypDWJlx2zkZJVh",
      "cage_id" : "cge_3pFAmcWinrT8VkK1ZHhcWs",
      "catalog" : "A0000001",
      "name" : "1PKMmcw38G",
      "number" : 1,
      "strain" : "NKilBERurj",
      "species" : "ObD7xSeTxJ",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "U0aukdqc9v",
      "ear" : "yNbjQmiFBk",
      "tag" : "35X4C2cnZv",
      "donor" : "4KTSZ0N0mT",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_69hDUAedMVyO80hrUqIVGB",
        "name" : "w7FzjnjXIX",
        "email" : "WiPspXqu@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_pGCX3SnIlaK7oL99iZbNC",
        "title" : "Found dead",
        "comment" : "RY7w2plyyb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:35:57.655459Z",
      "updated_at" : "2026-08-18T14:35:57.655459Z",
      "disease_induction_date" : "2026-08-18"
    },
    "measurement" : {
      "id" : "mst_6g1ar503XagAWbLPzDB7xM",
      "study_id" : "sdy_DrjD7P5Fw4k38f1CntoAp",
      "animal_id" : "aml_7GNISCxgoTLz7kxHrZoDFo",
      "measured_at" : "2026-08-18",
      "calculations" : [ {
        "id" : "vbl_2rNssPq9N661Lxok57rngI",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_2rNssPq9N661Lxok57rngI",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-08-18T14:35:57.912578Z",
      "updated_at" : "2026-08-18T14:35:57.912578Z"
    },
    "user" : {
      "id" : "usr_5kvA2q7b2w0YfYbWWMFTsn",
      "name" : "TO2B6 Overwatch",
      "email" : "408MqbB0@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:35:57.248633Z",
      "updated_at" : "2026-08-18T14:35:57.248633Z"
    },
    "treatment" : {
      "id" : "tmt_5rQCavbAKgDZxUxmBpbtOQ",
      "study_id" : "sdy_DrjD7P5Fw4k38f1CntoAp",
      "type" : "concentration_vgkg",
      "name" : "RGXe5o7s0d",
      "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-08-18T14:35:57.930219Z",
      "updated_at" : "2026-08-18T14:35:57.930219Z",
      "external_entity_id" : "YlEZrG24qH"
    },
    "created_at" : "2026-08-18T14:35:57.953415Z",
    "updated_at" : "2026-08-18T14:35:57.953415Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_DrjD7P5Fw4k38f1CntoAp/animals/aml_7GNISCxgoTLz7kxHrZoDFo/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_DrjD7P5Fw4k38f1CntoAp/animals/aml_7GNISCxgoTLz7kxHrZoDFo/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_DrjD7P5Fw4k38f1CntoAp/animals/aml_7GNISCxgoTLz7kxHrZoDFo/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_1p8xHSS9ltdQyDxnVKHLiP/animals/aml_7l7DADRXFJV2sefgUfPb8o/measurements/mst_URjnRlKmeyeHs8jA6oyK8 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMzMwNjViZS0xYmRhLTQ2OTAtYmIzYi1mNDk4MWU1ZjA3NWMiLCJqdGkiOiI3NGEwMmZiNi00YmQ0LTRhYmMtOTY5ZC0zY2M5MzM1YjIwM2MiLCJpYXQiOjE3ODcwNjM3NzksIm5iZiI6MTc4NzA2Mzc3OSwiZXhwIjoxNzg3MTUwMTc5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJUV2ZRRTdOd0o3Y2JQRUJBQ3dvRlQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GbrEhhyCU0DbIHNxYgtuwMoWOURjvEwsII8bCm8ZkGrwhq9ccIQzPVxjA3ZSF6nqhJRsRIXvgl3jaTZXXwYw7tC22svTdsTOAJXk4Wf7t-A2C-tqwLZfty3CR89B5nFbV3GUwAw1nJ_mLUXrZCNbC5mxEN0Ity5C_izm-_sgO94EIW9BMo10MPFL_HeYVZFmUeZQcLmsoxoCXed7OHPdnSSfNOlhsy8T8VnTSWrLQZKJRsylrRrGsdeC1qZsXeeje3pptTB-H848PB0eC6InKUIIGT8n77qr2mjriG0NEs7apQuh0gmk9Rhbqxky8j97x-IryXAN_ImLTb8MvqCBtqtQbHkCxlk-iJH8SP_3ktYsnOSIUqzy7-hnDcFkgi3q-G_RKgHzQGLpPLikpo9I7tu4aBfeXrOF4XM7wJp8cjD-j-eGj3JheOAeevuVm5M4l2hmR3OcLMuLTaPu7YtoPtB-FdzQYrOC5Dh56WPDm6kMz-M-gG6Vqtb9FEil_P0jM7Q8EPBk0Q1Obm-s4DOVQAjBajBMi2s4aK1rp9iiMeIUmq-fCTE9UwVlSmNP9LVMGiLsccQZwirKrYg3Ye5ouVcmA9KlLyQKep4LVHeY0aIeDvSRofqwtC0iRzFfOnoTNbI0eQbr31NoNbQIV6D6qKYCHLCG762CHsdv4NWcAew
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_URjnRlKmeyeHs8jA6oyK8",
  "measured_at" : "2026-08-18",
  "calculations" : [ {
    "id" : "vbl_50spzcazfz2WfeyPOreoCV",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_7aqiZY1pzsqeL0DnzmvjXe",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_1xS5YFC3ZdNADNkSa3qcew",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_6IZBCgDntx2541aGLHxwSY",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_6IZBCgDntx2541aGLHxwSY",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_1p8xHSS9ltdQyDxnVKHLiP",
    "project_id" : "pjt_35nYoSCOG4t8sA8lyqntc5",
    "name" : "3xub9dUhpC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3wIU3bzTfoAsjX6Qpmk9Ey",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "8fvMX3jQxi",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2eI2oKXC27dAYcBqgxeIcE",
      "name" : "1bwNlUihjC",
      "email" : "LbnP09aD@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3qJkGAy4nueV4SoKcgdKuE",
      "name" : "yX6g0dAQjN",
      "email" : "acAMkzva@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:19.031322Z",
    "updated_at" : "2026-08-18T14:36:19.031322Z"
  },
  "animal" : {
    "id" : "aml_7l7DADRXFJV2sefgUfPb8o",
    "study_id" : "sdy_1p8xHSS9ltdQyDxnVKHLiP",
    "study_group_id" : "grp_16gnQVe70AMnV9IHydnjw9",
    "cage_id" : "cge_2Qb7i8SR3oWnLlfblaug3Y",
    "catalog" : "A0000001",
    "name" : "PBkjCCfqKL",
    "number" : 1,
    "strain" : "I3MZTtkON0",
    "species" : "rcrFLh2Thg",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "poAgzwWXFI",
    "ear" : "C0JlsQ2nhT",
    "tag" : "P47LtqE9ip",
    "donor" : "0ENVVRHqyN",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_4guy22KNRHHQxs2ajSC8Uv",
      "name" : "XD2KfBp90W",
      "email" : "pUGF3oyi@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_4n7oscZhI9fwpi2bPqXKKV",
      "title" : "Found dead",
      "comment" : "ip3bpWcGOO"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:19.230338Z",
    "updated_at" : "2026-08-18T14:36:19.230338Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_4s3YJA21ELItGDfkqj78su",
    "name" : "LJw4Z Overwatch",
    "email" : "8aeBuUHz@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:18.979568Z",
    "updated_at" : "2026-08-18T14:36:18.979568Z"
  },
  "created_at" : "2026-08-18T14:36:19.396806Z",
  "updated_at" : "2026-08-18T14:36:19.396806Z"
}

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_6bsYtxOFrIYSi3C50SWrxu/animals/aml_3NBtx9OAcDD6D3mMpWXh9E/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjZTE1NWM3Yy1iZmZjLTQyODktYTJiMy1hZWIxZjhhMWIzYjMiLCJqdGkiOiIxZWZlZmVmYS1jZmI2LTRhOTUtYTc1ZC1jMzdlMGZlYWYwZTQiLCJpYXQiOjE3ODcwNjM3NzAsIm5iZiI6MTc4NzA2Mzc3MCwiZXhwIjoxNzg3MTUwMTcwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE1U0gyanU2Zzl1cXdtOHhxSUJEWnAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.RkYH1uB8IlO6BvlyueydwGKGN7aKijO4WrfW2ptysBE-S4FvgOJEUOsUWr8GBrCgONxRNFqcAvkHt95lYVXfEoq9rs-GC-dhCxtmMPFBRyLLWW5dN24qFohoPyyV3zj56pox1fmeJzs82fJHyWto27K3nZ2DxJ3R6JuOtA8UatKk3fxplg29YnMtNPKCvFTT1ZYQXAk5mi3KphBDoU81x6c46idmVCo1UfzhGo-s4LGNC7rpHSjWq52X1e9rmITWeqbtkUZqZr529auXq7tITrrS_rembyPZvfkxpoMDS7Tx95Dzy7zzoHe3_q4JDdQaDf5X_yAWRmRTkFEbSu5wLg8SfzdMWYmyHJk4krLaebzdjdrQXIgPyEmcCYi5YyW1CVe_TJaOXOvpH_owzPfhCQX8S_RPOoOuY16sb9F-oiFyDyJYE5Dl1CcSi5Gh2srrLp2lB2AELZZxMNApTyVk6CPMwuS0wfMmXB8Lla6WRTXJCbB001qCxHzdu-iTsvVJ5eMq5YuA152v3-hxPy_JolZcCRQ22P80T2KNNVaaBB5FL6JyDOdGPLThVi4sor2-LDveMnF0pwAFfxyQz0-m_PtgovIp8greb4exR1N7WzhSN6tBJfizqNidFic_o6K-s_vldpiC0Kfr86RTrhJO0jJiTz6LmMh1AwgrWit-g7o
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: 7906

{
  "data" : [ {
    "id" : "mst_1GZfFHMIESa43jk8bp9Cu",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_4Sc6TGTuVyXqFyzlWdQl1J",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_7LTEyToom8HsBOUuqfRhMp",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_6wpC1vXKrefboOKGYC2GGd",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_7CJxXkoEGYj7FL1Dwptywu",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_7CJxXkoEGYj7FL1Dwptywu",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6bsYtxOFrIYSi3C50SWrxu",
      "project_id" : "pjt_17qUud6CRsXSj9M2g6bvyL",
      "name" : "JJfZwCJt6R",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5DSGVxgZSNVoRxOeN4OGU4",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hnCbR2vbEJ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1gh2MbXnU9pJ9yC02ei95C",
        "name" : "ZO7kBL72cN",
        "email" : "AwjOhvtb@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_qNSAFXV4l9cSRFMnoOne3",
        "name" : "mgaWnVROMn",
        "email" : "4tnk7toX@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:10.404656Z",
      "updated_at" : "2026-08-18T14:36:10.404656Z"
    },
    "animal" : {
      "id" : "aml_3NBtx9OAcDD6D3mMpWXh9E",
      "study_id" : "sdy_6bsYtxOFrIYSi3C50SWrxu",
      "study_group_id" : "grp_1jDPrOP3AONd2r7ThKnQgi",
      "cage_id" : "cge_2WivSB93SLvBDJ5OkY9lf3",
      "catalog" : "A0000001",
      "name" : "hXEQzBYCfh",
      "number" : 1,
      "strain" : "1Tnuuse0LZ",
      "species" : "fLdr9zOTCe",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "08FhO1bggw",
      "ear" : "qF3CEpJEOI",
      "tag" : "nveF4GPCnR",
      "donor" : "fQavv2ALAv",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_5J380b2yVv4VvSGqctgpAO",
        "name" : "C1dAZ4sTri",
        "email" : "7pE4mP7y@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4ufWQiZJjunVvYR9e3Lt9i",
        "title" : "Found dead",
        "comment" : "cRtHfi3nWj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:10.752285Z",
      "updated_at" : "2026-08-18T14:36:10.752285Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_7O5rir39NG7J2dQRPHeIab",
      "name" : "heyrl Overwatch",
      "email" : "N3GMisyy@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:10.112771Z",
      "updated_at" : "2026-08-18T14:36:10.112771Z"
    },
    "created_at" : "2026-08-18T14:36:10.891809Z",
    "updated_at" : "2026-08-18T14:36:10.891809Z"
  }, {
    "id" : "mst_3GjkipIOWBYbpN5cVpjTjc",
    "measured_at" : "2026-08-17",
    "calculations" : [ {
      "id" : "vbl_5rb9NTKpE1QxoPyzbfUvYc",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_BE9UZbpE54Rds5Ab0PJPN",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_6bXw8KyzVnTOf8ZdfE6uDe",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_4juGTotKrye19RJ4n2lLjq",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_4juGTotKrye19RJ4n2lLjq",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6bsYtxOFrIYSi3C50SWrxu",
      "project_id" : "pjt_17qUud6CRsXSj9M2g6bvyL",
      "name" : "JJfZwCJt6R",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5DSGVxgZSNVoRxOeN4OGU4",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hnCbR2vbEJ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1gh2MbXnU9pJ9yC02ei95C",
        "name" : "ZO7kBL72cN",
        "email" : "AwjOhvtb@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_qNSAFXV4l9cSRFMnoOne3",
        "name" : "mgaWnVROMn",
        "email" : "4tnk7toX@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:10.404656Z",
      "updated_at" : "2026-08-18T14:36:10.404656Z"
    },
    "animal" : {
      "id" : "aml_3NBtx9OAcDD6D3mMpWXh9E",
      "study_id" : "sdy_6bsYtxOFrIYSi3C50SWrxu",
      "study_group_id" : "grp_1jDPrOP3AONd2r7ThKnQgi",
      "cage_id" : "cge_2WivSB93SLvBDJ5OkY9lf3",
      "catalog" : "A0000001",
      "name" : "hXEQzBYCfh",
      "number" : 1,
      "strain" : "1Tnuuse0LZ",
      "species" : "fLdr9zOTCe",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "08FhO1bggw",
      "ear" : "qF3CEpJEOI",
      "tag" : "nveF4GPCnR",
      "donor" : "fQavv2ALAv",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_5J380b2yVv4VvSGqctgpAO",
        "name" : "C1dAZ4sTri",
        "email" : "7pE4mP7y@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4ufWQiZJjunVvYR9e3Lt9i",
        "title" : "Found dead",
        "comment" : "cRtHfi3nWj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:10.752285Z",
      "updated_at" : "2026-08-18T14:36:10.752285Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_7O5rir39NG7J2dQRPHeIab",
      "name" : "heyrl Overwatch",
      "email" : "N3GMisyy@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:10.112771Z",
      "updated_at" : "2026-08-18T14:36:10.112771Z"
    },
    "created_at" : "2026-08-18T14:36:10.961355Z",
    "updated_at" : "2026-08-18T14:36:10.961355Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6bsYtxOFrIYSi3C50SWrxu/animals/aml_3NBtx9OAcDD6D3mMpWXh9E/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6bsYtxOFrIYSi3C50SWrxu/animals/aml_3NBtx9OAcDD6D3mMpWXh9E/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_6bsYtxOFrIYSi3C50SWrxu/animals/aml_3NBtx9OAcDD6D3mMpWXh9E/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_1PaMTEuQtxCFpYlJXEJAwY/animals/aml_3GGwCHapLb73y1yKmI1VIU/observations/obs_15oMFZSefFQvyqophTn8CN HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMjE0N2M4My0zNGQ0LTRlMzgtODkyOS1hNzk5MDI5NjkzNmUiLCJqdGkiOiJmZWVmMzg3OS1jNGM5LTQ4NWYtYjBlNC03OGJlY2I2MTczZTYiLCJpYXQiOjE3ODcwNjM3ODUsIm5iZiI6MTc4NzA2Mzc4NSwiZXhwIjoxNzg3MTUwMTg1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdPRGpSVUFoZkd6eXRCOThESURLWnciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ad3tirlCUFntNJmtCI6a8jcSnzqr01La0qb8xV60zekk-xltr56hhEClZ28KDoaVb6KligICsDylIYaeKX5XerPVRrIBnwMBbmpNxA-n0xIC_e_DeZ4w-DDCLOdRlwjizcGTLTQ4rJ3xU1XgSjDfQvT41NnxT3W6qacjXk7mQBnVgQykzJHUx8f2ufc8naFy56uN_EZYKpl4xpAlJhCxIm6330ZmBIZQJaxekWyFH9yQpeimnwpg3CtQOZF_mO3MBLk6qR9DeMjg9cPvro0i97oQOL2f__lt5LPkL-YV1_TjAoOyBgsVaztWttzNDQYicfOIgv8Ld0c2TO6nYqet-xIpEZwfrwhmt5A1cRZs2LxrNqK0tKWkoZPS2FxqgtXq2CUZvS86KZV7Pl3PVZWbsIjjHC-b6tHXa8MFJy2S6aRvSlO0Lh-D6Do_Gywu-iIzWguaE8D06tztwz2DMNCURL9nbncort1HDfpvtiwpZfaN-WnQl-jzEdskT0yqvqjXfcV2Bli398CsLuBcBhrL_dnT3YCwLyoqWyDXJLDhgYd1biVfCbLG0fwDUchMlD50_XLHt2t0i79m4e6fty7mJ0L1uPsOCkixxwgv5u2poRD2ExhUhXENZxjYSoYPNLrfErBbqkL08rnCdHPpU1esIhEd1FNj8CtkNMnnKPj9R2o
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: 2808

{
  "id" : "obs_15oMFZSefFQvyqophTn8CN",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_340bJiGDa32XRpUELrlsdC",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-08-18T14:36:25.489186Z",
  "study" : {
    "id" : "sdy_1PaMTEuQtxCFpYlJXEJAwY",
    "project_id" : "pjt_5kIKCv4Z1lwM7VaJCKBEoQ",
    "name" : "7YIpOVbUcT",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5lYx2mKU7uV7SJXmRSQkml",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "hRrbJYuKtj",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3nSsxYR0s5utKsJ24AsbE2",
      "name" : "XxHDMFCRXF",
      "email" : "1VIs04OX@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2xwGuL7Q95FYUQfOWdkAin",
      "name" : "t0yPErvc3x",
      "email" : "zcHYQKCw@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:25.121660Z",
    "updated_at" : "2026-08-18T14:36:25.121660Z"
  },
  "animal" : {
    "id" : "aml_3GGwCHapLb73y1yKmI1VIU",
    "study_id" : "sdy_1PaMTEuQtxCFpYlJXEJAwY",
    "study_group_id" : "grp_3ogDWh9Jgfx84iLaTKjCOe",
    "cage_id" : "cge_18NAGi5y1lbfoDwyOxWlg0",
    "catalog" : "A0000001",
    "name" : "FcTx6uFZXE",
    "number" : 1,
    "strain" : "nPKGtVjHgr",
    "species" : "iGBUIx0T3s",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "Hp8pstyw5s",
    "ear" : "dDnvwBboBb",
    "tag" : "dHn2JJQ4EF",
    "donor" : "ZJyPujRUQf",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_20XLCphwtDULK3ewwWxvjK",
      "name" : "6VbwRUg0yR",
      "email" : "5v0TFaEX@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_40xkNE7SwT8vkzzcnXWqo5",
      "title" : "Found dead",
      "comment" : "XiDX0x2s1M"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:25.362228Z",
    "updated_at" : "2026-08-18T14:36:25.362228Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_BbdkcP0Et9ytTmCDSAzHM",
    "name" : "V2ety Overwatch",
    "email" : "2lWaeFcy@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:24.828651Z",
    "updated_at" : "2026-08-18T14:36:24.828651Z"
  },
  "created_at" : "2026-08-18T14:36:25.489288Z",
  "updated_at" : "2026-08-18T14:36:25.489288Z"
}

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_5CWDdAIrSJRtkk8mjc4vQW/animals/aml_Qtaw9R9UyPqEskwgVZV84/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MzQ0NWIwZC01OTk3LTQ5ODAtOTdkZC1iMTRjY2VjOWFhOTEiLCJqdGkiOiI0ZTdkOTNjZC04N2FmLTQwZjgtYTFkNC1iNzU5OWM1YzkyOWMiLCJpYXQiOjE3ODcwNjM3OTMsIm5iZiI6MTc4NzA2Mzc5MywiZXhwIjoxNzg3MTUwMTkzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzlDRXZUR3c4VHVCQjFKbFNwdUVZSiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.R6umwJdTANW_xpIlkl13NhcnKDYaMSqjQjsRAuYQZsg9JfD1c0-nuOrvcC2iZTzgoDBR8nAC1UxvE6tNyHEvhFomlQKDXMUX9nyhn_YIY50fQ6R7NmJkMblFFStnH1bqdt9eoeF3KMA20RQYC2arhx3dZE7_JCilUAWyAp8QCnhwL9bxjoXvjqZEMmYOFWhuTaA72ChRJuplV0pngBvIgXyU8Ov0KQjz_AKlWq0t_5Tj56FAr296W-BZ_DFSB5Acxdl5o-6SDMGYfRNdm3j4ff4PbJX3__V2LY9TQvO0ZwKNUXOUCxJYYM8rDQ5pXzjwWUm9JCnATU5bdTJHpKqqVLSSCInU_UkIaYEJqQxzon5f9jgAmjFY1jix5Yk5l4bGK_QgO_4Plof9p2KKz3XnArhOPWrkdtMRLt6SR7cX8CgwfMWLX3lwnDn-M6G4midAsPF1eSiHVvVPbYkMSRE7-yAul8FJR--JlHJqru0cH-GFSv_fq_WQWSiuCvEvvRmSMyfrwTWzSt1o-Ut758_WlquCwD394RBsbrXZK6O-6pzqVibRXC6d3jTLVSo6Xg52A1E3A8nCBlo2_Ub4bel_p83csDeRTm0p4qBRqnJxwr693LAX4SHTb26JRabR1Ze2aP1ocPKZruHz9S5z3J7WFYOBlDOwfc3MYjlAs7ugyzQ
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: 3616

{
  "data" : [ {
    "id" : "obs_6RPfnh19C3Nvt2bHgYWVhA",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_5rUi2NmN5YRZZlc7d6sgPB",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-08-18T14:36:33.402343Z",
    "study" : {
      "id" : "sdy_5CWDdAIrSJRtkk8mjc4vQW",
      "project_id" : "pjt_18dsM8XLjb8nOQsxbOVamq",
      "name" : "pYZ0OJnSgb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6yGEelJu9Wi5ETyssLQEG5",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "h6foLFQqFo",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2YywPzGb7ZxPcoe5xYAY2n",
        "name" : "XaafwhE6FL",
        "email" : "aMHgpytZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6lO1FULfZYejybxqH7c03N",
        "name" : "TaLttl2M5O",
        "email" : "fH08uqvx@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:32.989883Z",
      "updated_at" : "2026-08-18T14:36:32.989883Z"
    },
    "animal" : {
      "id" : "aml_Qtaw9R9UyPqEskwgVZV84",
      "study_id" : "sdy_5CWDdAIrSJRtkk8mjc4vQW",
      "study_group_id" : "grp_7EVCfCWZbsFd6gU1JQuIpg",
      "cage_id" : "cge_7Lp3g71OAFeGogTwBc49rr",
      "catalog" : "A0000001",
      "name" : "4y5N8dHPfp",
      "number" : 1,
      "strain" : "uOILyjILD0",
      "species" : "awdUg1Clt0",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "eiTH763EnW",
      "ear" : "dV3bFm0rgb",
      "tag" : "FdGp39RtnY",
      "donor" : "tHq2WnMAXx",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_7HbF80Q0kMoJiIKbvZAA19",
        "name" : "LIHLtjsUkg",
        "email" : "05NtlRXi@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1LpMSl7NEPMbvTft0s2xe6",
        "title" : "Found dead",
        "comment" : "AweCGZTSnI"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:33.259863Z",
      "updated_at" : "2026-08-18T14:36:33.259863Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_3d5PDw0r9nOe07RTlXaZVf",
      "name" : "rQEFR Overwatch",
      "email" : "Hiki4TKf@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:32.893651Z",
      "updated_at" : "2026-08-18T14:36:32.893651Z"
    },
    "created_at" : "2026-08-18T14:36:33.402754Z",
    "updated_at" : "2026-08-18T14:36:33.402754Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_5CWDdAIrSJRtkk8mjc4vQW/animals/aml_Qtaw9R9UyPqEskwgVZV84/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_5CWDdAIrSJRtkk8mjc4vQW/animals/aml_Qtaw9R9UyPqEskwgVZV84/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_5CWDdAIrSJRtkk8mjc4vQW/animals/aml_Qtaw9R9UyPqEskwgVZV84/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_1KitIzVmRSWVu1Ui1SGYB6/animals/aml_7SNahN5nF0yoLjoti69k5g/samples/spl_2VRExWIxHY2dYAL3nKafoV HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMmE3YzRkZS1hYzQ1LTRhZTQtODI0Ni1hZThkNzIxMjg2ZmQiLCJqdGkiOiJlOWI4NzBjMy02MjYwLTQ3YjAtYjRhMy03ZDFhNGMzNDJhZWMiLCJpYXQiOjE3ODcwNjM4MzUsIm5iZiI6MTc4NzA2MzgzNSwiZXhwIjoxNzg3MTUwMjM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVEY1JqRkszeTlEZk1kNEVRT3ZyR20iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.jwexEmQS61pROYj8o5w0pvqvoFuCTXi4Lb7h-uEmnwAbAZv3fBGzU8QwOD9iXROJsdRWhyLw9mJefcJ24nvDd06ZYE4J0ltcz4UADEwx6fKjliMdOCWVgCC_MVMs0KVJocF3tokX0eQdR1oHChnQ_L355w9xpVESRRkxlUntQZClUjMbZ5TsxwwPmYafTLIflQKnZkm4tzYjr5IBo4_nd3iVSxGxLGPkEVjYalZL-RLYCVySnFXH6tyjgGLLgwkOPBDoRgDt5DsuQozfR2d1ORKuDdyuCDHOEfoWwGuNQ38-3ZDtjWAFWEdnuju1fU3Qgw3e37vXkUKVSTNiYxkZyPq24xfD04KE5zZqHLpMNjYP3qzX1cwmWpSqmanusVFIM5wl8cWWNPmTYmMCuYkf2hwPLiLmsBjfDMv8r88RRqn3v3YW98mz3nh4WpPQdjwRuu6NwJ4O6BlaxS253ll1bcAW827LMppIdv9P7V_ySVvLSm6EZ0yWNR5XMBDiLORGQkQd5OU_ukNwHvBGcJs1PMJrz-zHMVk6KL5IOYiYeYwXDEmnkuIVQhfXuxzwrIXjhglp9jOWJJ6F0StOMIK0djr15w6JuN0p_60ODOqf01xH6u0YMPdOCBgfEPosky9VHaIF-8kacKgflWeLpjAbawEcVv2TacTxF-aZLB2Ga_I
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: 2960

{
  "id" : "spl_2VRExWIxHY2dYAL3nKafoV",
  "sample_id" : "S1233473107",
  "sample_definition_id" : "sdf_6vtP3XgYgSYXXjs2M0kcJK",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-08-18T16:37:15.141491Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1821060965" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_1KitIzVmRSWVu1Ui1SGYB6",
    "project_id" : "pjt_sGNhXS8rQ2jrjaBsh4Roz",
    "name" : "z0Mfe1Zmvy",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1amY4MRLPfpYvRVecHB6xw",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "nTH2frAwDX",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_hjplPVeYLYD3StTC5TDc1",
      "name" : "aPjvvnZzQc",
      "email" : "5AHB3dAy@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1J5ul8ExjWVDVqhknXepXs",
      "name" : "X4yY67yJRU",
      "email" : "4nI5Sp2f@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:14.381647Z",
    "updated_at" : "2026-08-18T14:37:14.381647Z"
  },
  "animal" : {
    "id" : "aml_7SNahN5nF0yoLjoti69k5g",
    "study_id" : "sdy_1KitIzVmRSWVu1Ui1SGYB6",
    "study_group_id" : "grp_3J59BJaSpQ9T0sY8tuL9RW",
    "cage_id" : "cge_30GrzCeFU2uGFirUfrsUGt",
    "catalog" : "A0000001",
    "name" : "WJNnOFTvGD",
    "number" : 1,
    "strain" : "S9yWTl9ds5",
    "species" : "fjlUovqgHg",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "GXsh57Foos",
    "ear" : "fvhdnMEf3p",
    "tag" : "oZExqarD4b",
    "donor" : "OSkctwtx62",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_6izM7N3J5s79AeSzdQWc62",
      "name" : "9HjODgJkNT",
      "email" : "oOCSnzBL@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1uz6G0svYM7gqfF3c5o4iG",
      "title" : "Found dead",
      "comment" : "rGIXkIcXBd"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:37:14.844170Z",
    "updated_at" : "2026-08-18T14:37:14.844170Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_7gKX2aGa0FORxJa3gLb9Um",
    "name" : "gKszgxpG20",
    "email" : "FGm8tBAp@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "7PpDK1Ml40" : "DTn7HGnr4v"
    },
    "created_at" : "2026-08-18T14:37:15.118105Z",
    "updated_at" : "2026-08-18T14:37:15.118105Z"
  },
  "created_at" : "2026-08-18T14:37:15.141752Z",
  "updated_at" : "2026-08-18T14:37:15.141752Z"
}

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_7RpnYdfira6UI0YLnpGIK8/animals/aml_Bn6jqARmUkj05YmBTvM6C/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NjIzYWQ5ZS02YjZiLTQ2ZmMtYjQ2MC1mMzAzMGFkYTA0MjMiLCJqdGkiOiI1ZTZhZDZkMi01ZmY4LTQ1ZGMtOTg2MS03YzQ4NGUzN2NlZTYiLCJpYXQiOjE3ODcwNjM4NDUsIm5iZiI6MTc4NzA2Mzg0NSwiZXhwIjoxNzg3MTUwMjQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRPMFhqcjF6enJmTXd5MUVQQzBDNVAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.OcDN1-O7A1-fj-MW-FIeYyo3xK71A_vSJAWD7r8xiqhf6i9zzWpESsBnKV6CTeWuSTTkaL2a8vfeyDWVBKwpW2W6-PnsJIbUa7lzSoiB-60gPd6yc6q0qthInpvN1NUN6GAtvMPcPqqvGclM0d9XFpQQ8CLw7a_rfJXYIKXdUrlzk3u2ruf1DFnU-N4dEGZV-M0IptcH-hFczFPCVAvsFksRk-KLy90_dSszPyj0_fSqhyABFf1pU5j6MdtfU5x9z-T2bA3XLMxF8wwVm4-a-9ZLTwtr7OtLuLt5sYuUoTXgJ4B8qerN8LYOhpke9_gk1eDwcn99ngvtGEkEeklrYCknaSG956inO0VbpJtgyDF0s9n-cQycnmSxOrhXvc52i_jsT2mVVz_pCgBSKCGbfZNW-ehQ8U1RhnsEMEJEGEcbZk5aDvs7OFuBCObuIbD6MZRWWtuPx9FceGOJeBNZCTS76yzfF5UTUGhvtRabVCMkiG15lhsJoIgTFi3ZHf6HjNSCRoDGymZt1_QEe247kYTP6aPnuvssz_zEuV9f9es39mCSbnaFAd8B-ISdUdrZm4a-THXYhU2UyvCrUVulxUJXgGoPzMtXgdCQMhz4o2QjdAeX0BGj0zS6D-2A7_MI5H83YUHGJlJDIYtWCoegQ06T8kGLtIEmLfVwJ0CVuL4
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: 3766

{
  "data" : [ {
    "id" : "spl_vJNf2orbxaHSTm5BEnO4v",
    "sample_id" : "S1065875785",
    "sample_definition_id" : "sdf_3n3VdcL3SbUIog8NdLVgSE",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:37:25.760461Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-861818665" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_7RpnYdfira6UI0YLnpGIK8",
      "project_id" : "pjt_3DB4MedBW84o4acynm6Ldv",
      "name" : "wMCSvjbdFx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7CWwFMI8oSpXZc8DC2zGbw",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "nXGzz1TBWZ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2nho1OjlDiYOMi15JRHCbh",
        "name" : "T3PsLbvyuy",
        "email" : "esBkvqPT@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2RYWridrQl66sGiztEA7ol",
        "name" : "k4w2ZaCQEF",
        "email" : "h1uTN2eE@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:24.955327Z",
      "updated_at" : "2026-08-18T14:37:24.955327Z"
    },
    "animal" : {
      "id" : "aml_Bn6jqARmUkj05YmBTvM6C",
      "study_id" : "sdy_7RpnYdfira6UI0YLnpGIK8",
      "study_group_id" : "grp_6681TmbrQ4cS1eChVIGzZo",
      "cage_id" : "cge_2XPfxtWag2LYgLcropvh9g",
      "catalog" : "A0000001",
      "name" : "kq7xvh1GIs",
      "number" : 1,
      "strain" : "JqKlhGsMjP",
      "species" : "GiBXCQ7IEu",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "cGtxtWgXFx",
      "ear" : "1w8pVpxoEt",
      "tag" : "zC7j3cBCkN",
      "donor" : "dGYxzKSdwD",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_31mHmUGQjVHgcUbGUDfWcV",
        "name" : "1uofBysDpd",
        "email" : "J1stRObZ@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_UMW9r8JcBhRkENTfhK6R",
        "title" : "Found dead",
        "comment" : "PDhjVzlHjv"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:37:25.357010Z",
      "updated_at" : "2026-08-18T14:37:25.357010Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_23xPleWRR0Ms9LRKs5Q7Hx",
      "name" : "NnBEBNErTn",
      "email" : "3S9PeYfL@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "vq5RMPAmkk" : "CR5Kuqt7co"
      },
      "created_at" : "2026-08-18T14:37:25.736369Z",
      "updated_at" : "2026-08-18T14:37:25.736369Z"
    },
    "created_at" : "2026-08-18T14:37:25.760644Z",
    "updated_at" : "2026-08-18T14:37:25.760644Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_7RpnYdfira6UI0YLnpGIK8/animals/aml_Bn6jqARmUkj05YmBTvM6C/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_7RpnYdfira6UI0YLnpGIK8/animals/aml_Bn6jqARmUkj05YmBTvM6C/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_7RpnYdfira6UI0YLnpGIK8/animals/aml_Bn6jqARmUkj05YmBTvM6C/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_71In5iIvaxplslXB6D3OtB/groups/grp_4gRf7DcZGGjXQw4Af14Lt7 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMTU4ZDNhNS0yNWZmLTQyMjQtYTEyMS0xOTAxYzBiYmY2NDEiLCJqdGkiOiJlZDgyYWVjYi05NGEyLTQxMTQtYmEwZi0yNzA0OTRhNzA4MDIiLCJpYXQiOjE3ODcwNjM4NTUsIm5iZiI6MTc4NzA2Mzg1NSwiZXhwIjoxNzg3MTUwMjU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZMNTU2UXpVTEZZRnBSekZjMjdVYkgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.G4jJCso5tVaBSO6Q2whDAXkbd5-OmWGQ1VO5mjBQpwmY9Lo2Eryet9RfOhidRmlIId9UfBcow5Nnm0x_5GDAcTKjUbVyXGSjYk_j9Ay2myInymn2eFrLYCguSxWaTcIYiKOj8B4NwFmKkghq8lTA8ffQrnNYvqY3Otuqgd-jNjxxOHRSLHzNw7kOedJcJB8T9ebGSJgDO-PJcyAOpp_J9AWuIN8pwdeYtfEqeXXiMoGm-RpI4z98N44zclr53joIMrAGwahaQVImL9Be5t4DVhNsTm36E3YzXCikIFjd8WOkEAwHGn4MBZE3bbp-P5kNoVcIvz9VGiDhRjLl3KrmhG5d8TIX_lCESXlW9FY2wwiRp78_iWqbHz-W2cwQ3E5gGp5azJocUWiRr1MR3BMRgq8bvyDn8WPf65f8MFpKpPg6wk8p6e_62ZN5mw5UD2aeNe_ZBdYqqzKmryABIWIVUCiQW7s20q6U3dITMOOszR_GY_RInI4J3a2QWKop02hZl5UzuU1z_DRI0vB99HSeIGdnpaqdFQ39wcwjR3FDgwHDaQIWgc6zViB43iPLvwHD9NurIebeLacV3f61NOZ_vGa3I3dFCgXkkWyF2dvLQVZ3yUwckywzFePdqahryMUThItrPEfIFNfU9xaWIINb5iVCmdhFwMQQACpXO9uhXBE
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: 1247

{
  "id" : "grp_4gRf7DcZGGjXQw4Af14Lt7",
  "name" : "A",
  "no" : 1,
  "color" : "#34e8eb",
  "max_animals" : 10,
  "control" : false,
  "metadata" : {
    "study-group-internal-id" : "SYSGROUP-A1"
  },
  "study" : {
    "id" : "sdy_71In5iIvaxplslXB6D3OtB",
    "project_id" : "pjt_YKYPYRLwMgHEnwU0ct8uz",
    "name" : "omBhDrRUW8",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6qH7tBgraRNVXT3nkV4tzy",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "5CD0xm6kiW",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_5XUWlRgkBZNGWGHeDmqM44",
      "name" : "VqtgFaFAyh",
      "email" : "oVDqSzBl@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6llJmM57V790xET0Osa5cm",
      "name" : "pETIneS2y6",
      "email" : "8Ue3uqU1@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:35.089267Z",
    "updated_at" : "2026-08-18T14:37:35.089267Z"
  },
  "created_at" : "2026-08-18T14:37:35.474276Z",
  "updated_at" : "2026-08-18T14:37:35.474276Z"
}

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_eSX1yTnqqBsP2sa8Bahmh/groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMzQwZTY0Yi1hNjQyLTQ4NDEtOGVjOC1lMDgxZDFlYTFmMmEiLCJqdGkiOiI0YzhiNTQxZi1jOGNmLTQ0N2UtOTg3Zi0zMWMxMDI2NGI4ZjgiLCJpYXQiOjE3ODcwNjM4NTcsIm5iZiI6MTc4NzA2Mzg1NywiZXhwIjoxNzg3MTUwMjU3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZPTERyUXVLM0VIdHlHc2RMR3J4OGEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.EUr6ZJt8f9-VY27EdlnuZuLAvzLIpdTymSNUwZBqlvlqtuEPxEwWMyZ_A_IBpNH0z6rRHOF9FOF60c6ovsIRayPapogvLbowaxvZ81PNmT9XaTLw-TdP22sGc4tqHLathjgam_Yalwi2p0OFPrPCF962rZD7MGh7JHu99BoEywBpwjnC-7sscWyZYhVZRBFXQ2OAy22KqiwMkL4AkqhuEq2iNHXDPiZ5ScyZv2A01cT4CqjWkSWjinFWryHp13A-sevJRiD79B8Nijxv5IZv7tykMC-O4EF2GW1RgMLx30sMELB5ehrHrNvmDi4aqPNR0JXwo6buFgwvNUP5_cKNTQHSQwMFcsrEZdV4Aq2uw19QOfK7LPSH21ny1HbC7LB4CJCwCxnI99rt5PvDSh7yO3se8CmVk7C5cbrRPScBnYToPzZeRcXd0vFh4J6EbSjGokOWDdVuTGvykFEDjFiI2nheHIKyLMgJmSR_B1rKAuGH5HiVEEeO4d7Ei6uBgZk966GtND1pK44IsuyP0cialeDE12STO7woFgQ9VOJ0InhD48Sxhlv3WSRb4rZGDsI6RYpC9WO46Zh77VsJ0Uj0N6mDYIQqf9FdKkZ8lkEcx7IOp9odpsEQ0MMk4IN63MVvtwS4lYoUz9eAIyMYibwSOUsEFRM5_Tghmaz9WYJyIZ0
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: 4507

{
  "data" : [ {
    "id" : "grp_qCAJrhB4TUSyPHgPFjvi0",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_eSX1yTnqqBsP2sa8Bahmh",
      "project_id" : "pjt_2m72DU1iytLZwesVWEel94",
      "name" : "Y3xXj8ahVx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48E5tanlRUHf74dq4j4L5B",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qAqiuetFgy",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2LWAoQkU6UmcyGmE71N2EH",
        "name" : "u5vzsqlhoC",
        "email" : "w8f3LaGD@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2BDMjpZ5PfhJEoZO07ny24",
        "name" : "MukAG1Kdyf",
        "email" : "d7tWo4kH@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:36.907751Z",
      "updated_at" : "2026-08-18T14:37:36.907751Z"
    },
    "created_at" : "2026-08-18T14:37:37.391949Z",
    "updated_at" : "2026-08-18T14:37:37.391949Z"
  }, {
    "id" : "grp_1wvmpIyVeDw0mUaxYE8rCU",
    "name" : "B",
    "no" : 2,
    "color" : "#4a7d4b",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-B3"
    },
    "study" : {
      "id" : "sdy_eSX1yTnqqBsP2sa8Bahmh",
      "project_id" : "pjt_2m72DU1iytLZwesVWEel94",
      "name" : "Y3xXj8ahVx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48E5tanlRUHf74dq4j4L5B",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qAqiuetFgy",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2LWAoQkU6UmcyGmE71N2EH",
        "name" : "u5vzsqlhoC",
        "email" : "w8f3LaGD@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2BDMjpZ5PfhJEoZO07ny24",
        "name" : "MukAG1Kdyf",
        "email" : "d7tWo4kH@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:36.907751Z",
      "updated_at" : "2026-08-18T14:37:36.907751Z"
    },
    "created_at" : "2026-08-18T14:37:37.408233Z",
    "updated_at" : "2026-08-18T14:37:37.408233Z"
  }, {
    "id" : "grp_39LxGCQHeCv9jmxIhRjN84",
    "name" : "C",
    "no" : 3,
    "color" : "#ad2f70",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-C2"
    },
    "study" : {
      "id" : "sdy_eSX1yTnqqBsP2sa8Bahmh",
      "project_id" : "pjt_2m72DU1iytLZwesVWEel94",
      "name" : "Y3xXj8ahVx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48E5tanlRUHf74dq4j4L5B",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qAqiuetFgy",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2LWAoQkU6UmcyGmE71N2EH",
        "name" : "u5vzsqlhoC",
        "email" : "w8f3LaGD@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2BDMjpZ5PfhJEoZO07ny24",
        "name" : "MukAG1Kdyf",
        "email" : "d7tWo4kH@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:36.907751Z",
      "updated_at" : "2026-08-18T14:37:36.907751Z"
    },
    "created_at" : "2026-08-18T14:37:37.419762Z",
    "updated_at" : "2026-08-18T14:37:37.419762Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_eSX1yTnqqBsP2sa8Bahmh/groups?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_eSX1yTnqqBsP2sa8Bahmh/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_eSX1yTnqqBsP2sa8Bahmh/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_4NQaWPKs8gqma3UxZfnmKB/groups/grp_6dSso7koF9Wo0Q0nln13aH/treatments/tmt_2WlOU2JgAE57wLxI42AhlU HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwMTVhZGNhZC1jNDhmLTQyZDEtYmEwYy0wMzRmNzI3MGJlZTgiLCJqdGkiOiI2MzdmOTIxZC1kMDVmLTQwNDMtYjkzNy1mZmVmNWE1MjI1ZjgiLCJpYXQiOjE3ODcwNjM4NzYsIm5iZiI6MTc4NzA2Mzg3NiwiZXhwIjoxNzg3MTUwMjc2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFtdm9YaXJENXVHNUJZV3pDM3JQakgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GB4YTIfa83m1gZanzpM6osDS0CtlVKvb8z40BhEc_HYllEpI5Nu2eKhlssBKvirLUGY5goFQO2e_OjiJmj3HJKYVJDzOQWInUwJYDsZ_rGXm3Po4MxzTFcmdGvyFU3LfxWmh6LtiS3tis6RTIqoSqxfjE-57IpJrSCdTciV5FuJcls0IzQaJ4y62HK3aWWBTLo_BIuL78Xta38ciZYxbf8qg8IHRRDHhzdaQNOoVzcsAIKKNoAa6ON8EQykYPJY7uB125mJ3Wtu_CcjmqJ_p5KEDN0rX2l0nmaRHINMS7BCgP9TkpBpRodrzeZmcgv4T1wCQYupLsLR64L4hqRKB8urKX_nhwflhfh1WLdkkvGySfWs2v95dfoBBEdjKdviqt62kG_Dswjgdl91irHadQKmz1yVyFvsp8wblr-XQ0urVRhe5PN6p8zSTohWR7fNX0wPiGLUMUfv95oHgx9WoLkq6fAuoIUavHUO8m79YM7JonLgKf4H61KwFypS89-F5p-m3mP7vcwNDNoCzIHm0ZayjGbaavtre9jP9x4uZK5aobqCepPZabTaeWZWGv5QIeqLLNBS-dM4nLu5Ofo6SfJ9HcF0ZshOpXpNj6OXHNe6pXkSr3HJJqOlAuKT8Ptu0oNFFq3_Th6nXj2J_z_bw7pEA2-uYxswc_EvCaiayrfA
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: 2161

{
  "id" : "tmt_2WlOU2JgAE57wLxI42AhlU",
  "type" : "concentration",
  "name" : "ScderUdeOC",
  "label" : "Test Treatment Label",
  "external_entity_id" : "z1YK8BcxKT",
  "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_4NQaWPKs8gqma3UxZfnmKB",
    "project_id" : "pjt_35s00ZC7YxLM3cfhpZOE3N",
    "name" : "tTgmn5Fnjn",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_ZcKXBHlc9gRh59oKlfgPQ",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "QKq7S9RE5h",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2AGRnOrCYVphYEEBzfmhPG",
      "name" : "mnwGx4f4wR",
      "email" : "hjJMMaq7@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1PH6meAqNkzU0A1RsWmACV",
      "name" : "GXAQCt5Aag",
      "email" : "p2AA3H7F@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:55.438823Z",
    "updated_at" : "2026-08-18T14:37:55.438823Z"
  },
  "study_group" : {
    "id" : "grp_6dSso7koF9Wo0Q0nln13aH",
    "study_id" : "sdy_4NQaWPKs8gqma3UxZfnmKB",
    "name" : "5sibWfNN8Y",
    "no" : 430625478,
    "color" : "OjBXfUD9FM",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-08-18T14:37:55.809536Z",
    "updated_at" : "2026-08-18T14:37:55.809536Z"
  },
  "created_at" : "2026-08-18T14:37:56.013931Z",
  "updated_at" : "2026-08-18T14:37:56.013931Z"
}

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_xrYI5OwjHOgtaSzvo0Trg/groups/grp_1kSoPzyszdfTe0swLXyVJE/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyN2ZlMjA1Yy02OTA5LTQ2YTUtYjIyMS1jNzVmNjU1N2FjNzQiLCJqdGkiOiIzM2ZmYmMzMi01ZGYxLTQ3YTEtOWU5Ny0yNjQ0ZDgyYmVmMDQiLCJpYXQiOjE3ODcwNjM4NzAsIm5iZiI6MTc4NzA2Mzg3MCwiZXhwIjoxNzg3MTUwMjcwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF3dmJiUjh5ZlI1UnZJVE5Qc1lWdGIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FgvGlFPHw_EyOSuRjDWQLAhDuHFA9-8e0iVTCj-u8NFoFOThqL4cEGqqdeca8r7SalZIBJRZxbYla7ENj79Ukn83ct-uzDEMqVzXkQg2vshJF43VWMw6HjuRwR1Q3t-OmlhKaoJ1rG91z5zpYqxIBbE4E2AXRqVwPEYEZXDvBTPH8aS6G55bknMjKisyCVbfy-xpJs180fS8I0jAPCqYd0ti7hoq5LI8YCz_weqn97ZfKcQYioKdwAHDyBaMaoEyj6xBkBVwUnFG65nvQk3jUTMCZzcoPZ2kuSFDf5wvZa1jYeLlcM56uWJf7gpdyI4tb-OXg4HtbMbaIaK4sg7RC9Ztt_EAvMU_2Yu8yYI2Qtn0H4r-hs2V1BZYkC3CKvYVCGEhe4DEctIDWmX9_oQfckA-2xpPqP2q_mDjaTGIKJhDljo1bvtUKcv_KnG62Ychu1iTzm4fX1RbUNwMZzr1Y0T_j71Vd9lj35Lc4AIwKOwcqwm71m-SBRK3i9_7X2UoaKMGUiRD5fL2_1YnoWEoHulD8prSsKLhIG4Mll5kqvrdDSyENuWxe0raYOBL4bXeblEcpal1QFi_Paa862cPM8zYzboshNc48mlZBS7w-rJzigq3nlMsaoai5cMPTlafSgPIiPcVNSjXxQgBTd4YIAMVo9b69YcuBh_qYA3aPJQ
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: 2940

{
  "data" : [ {
    "id" : "tmt_5PElDFzrvTVPjGYTakekJv",
    "type" : "concentration_mlkg",
    "name" : "dg3OlM7HxE",
    "label" : "Test Treatment Label",
    "external_entity_id" : "BCBOSM96zN",
    "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_xrYI5OwjHOgtaSzvo0Trg",
      "project_id" : "pjt_2w0WYfa47LZvTmQxdgOdNq",
      "name" : "lrDzbV8nDI",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_XoqqdaY3ExXm89LGhVQJc",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "lYY5Jy9gBp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4gc3k1eAifJpk8RlJVqUO9",
        "name" : "S2zxHnVba8",
        "email" : "2khokIqK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1Ji7Sh27HATL5qRFPfe7Hb",
        "name" : "vF1U9neR1C",
        "email" : "UOfzyycL@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:49.452193Z",
      "updated_at" : "2026-08-18T14:37:49.452193Z"
    },
    "study_group" : {
      "id" : "grp_1kSoPzyszdfTe0swLXyVJE",
      "study_id" : "sdy_xrYI5OwjHOgtaSzvo0Trg",
      "name" : "e0pMUi71I7",
      "no" : 1580129779,
      "color" : "HqJ7luTX8R",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:37:50.116144Z",
      "updated_at" : "2026-08-18T14:37:50.116144Z"
    },
    "created_at" : "2026-08-18T14:37:50.466191Z",
    "updated_at" : "2026-08-18T14:37:50.466191Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_xrYI5OwjHOgtaSzvo0Trg/groups/grp_1kSoPzyszdfTe0swLXyVJE/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_xrYI5OwjHOgtaSzvo0Trg/groups/grp_1kSoPzyszdfTe0swLXyVJE/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_xrYI5OwjHOgtaSzvo0Trg/groups/grp_1kSoPzyszdfTe0swLXyVJE/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.

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_6inXXJgJ7VZCNQJoe1rlKg/dosages/dsg_4EzO1fKvb7XhNsAxOXmbya HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYmY4ZmE1NC04Y2UxLTQ0MTAtODIxMy00YjA5YTJlNmUzNzIiLCJqdGkiOiIxYjRiZGIwOC03MDUxLTQ5ZDMtYjVlZS05OTRiNzFlZGUyYmUiLCJpYXQiOjE3ODcwNjM3NTYsIm5iZiI6MTc4NzA2Mzc1NiwiZXhwIjoxNzg3MTUwMTU2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRvU3FRYWxtdWk2VGVRa3hxM2JhVDkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZyQj3LMYdqwynO3Rl9FHD3ewlihq-glbOcYXe1G8Rbrc4aedkMBjmRzzKyDzAbsiKWla-0Iz9nMqe3pMe1IJTowbe3V81vOIFXI2X5b6c9HsHHM5pOopdnfkk7QCcRb-zltkqeh9YL5GuNyxmVgFCWGi1YtweBv9_nrIG9YIe5rO4cViEcqn2j7zYlYp5vtSTg7gFxj0gF3lomcGmBXvOCZn8EnAa00JebEClrB941NRA-nVQmMsEg4XyMolONoTn2FT-s09JeK3btVjsvAN4Wetdx6u1udvWW3kwkkODu4QK7jlWjxM1rrnfUUer3t2Nun9EaPFWiA-lJ4waTh3w923dhj_ptUncffQxyzQrf6qrBHAYCv3xARUDPENYGBAk4nxaHiBjUFUoMZrcrKH1uB_WstTSdFTI5ROSd-GzpeWR_gGeroTBkkXaq0UurtliZ_H8rSmO3vZGbRsODDMXjtHSobIkqHFFTGqmaG5Ff8R6qYmBoIizUHBAvAxyKdCq0NqjMXZ2cShqHsSfaS5I4wyvnb6g4fxuLqVnUioir0gu6Wlv66lI-6aPK-3_AG0OU8p3BLGvXp-Mr0szaY0a7NzPnAZbV2xOA_N2wRR-n-OqgZ9i31sGyybkauO1exl1EvSjIeH0rK64vuRn10E0P0tZrofr6pb9glFbOGvdXE
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: 4788

{
  "id" : "dsg_4EzO1fKvb7XhNsAxOXmbya",
  "name" : "Example dosage",
  "dosed_at" : "2026-08-18T14:35:56.542077Z",
  "comments" : "cLr8PRSgXQ",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "5.38",
    "display_unit" : "mg/kg",
    "display_value" : "5.38"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "13.59",
    "display_unit" : "ml/kg",
    "display_value" : "13.59"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "23.67",
    "display_unit" : "mg/ml",
    "display_value" : "23.67"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "39.73",
    "display_unit" : "µL",
    "display_value" : "39.73"
  },
  "study" : {
    "id" : "sdy_6inXXJgJ7VZCNQJoe1rlKg",
    "project_id" : "pjt_3H38koa1gweeYlFEnmqcyk",
    "name" : "oH9lvy1ceT",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_72qCTUDJuQen5TypGLne6t",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "iSZ1ZECIqx",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3vLxkB2zAQ0RXbDZq9v8rN",
      "name" : "qrgpvSha7S",
      "email" : "0BihaEQf@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3dZGwUMk0BQfcPt0vvvGkC",
      "name" : "oFbTnNhQv8",
      "email" : "qzzVzuug@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:35:55.726067Z",
    "updated_at" : "2026-08-18T14:35:55.726067Z"
  },
  "animal" : {
    "id" : "aml_58cP9eYCsAyAtuMPix0Oku",
    "study_id" : "sdy_6inXXJgJ7VZCNQJoe1rlKg",
    "study_group_id" : "grp_3n8R58H99GzXYa9TYUIYGQ",
    "cage_id" : "cge_1C3oQQbdr5e7Lvild1d9Hu",
    "catalog" : "A0000001",
    "name" : "1ledZhEuCE",
    "number" : 1,
    "strain" : "vXyWNArVUd",
    "species" : "B5hSopUG4f",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "Q3A3NbkxUm",
    "ear" : "LsFnc3CGqW",
    "tag" : "UhMzHIi0rf",
    "donor" : "6KDW5MJ31l",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_38HFoRpTfeCGhoEIrgxsj",
      "name" : "XDy0bZkA7W",
      "email" : "hRO3ibM9@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_755KNdArQGtpiy7W8lxi4a",
      "title" : "Found dead",
      "comment" : "FBrhylRnBj"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:35:56.188765Z",
    "updated_at" : "2026-08-18T14:35:56.188765Z",
    "disease_induction_date" : "2026-08-18"
  },
  "measurement" : {
    "id" : "mst_lzw2Mx2MDoFPPFyedmnIg",
    "study_id" : "sdy_6inXXJgJ7VZCNQJoe1rlKg",
    "animal_id" : "aml_58cP9eYCsAyAtuMPix0Oku",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_4x34inwmpA6G9Fq62QDQ48",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_4x34inwmpA6G9Fq62QDQ48",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "created_at" : "2026-08-18T14:35:56.448756Z",
    "updated_at" : "2026-08-18T14:35:56.448756Z"
  },
  "user" : {
    "id" : "usr_uzV5RTicAt6blkCQE8God",
    "name" : "AvYhm Overwatch",
    "email" : "gyjaqus2@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:35:55.602197Z",
    "updated_at" : "2026-08-18T14:35:55.602197Z"
  },
  "treatment" : {
    "id" : "tmt_vbZ3iftNELzmRqJPCpWWN",
    "study_id" : "sdy_6inXXJgJ7VZCNQJoe1rlKg",
    "type" : "concentration_vgkg",
    "name" : "3M5KuULkhI",
    "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-08-18T14:35:56.491931Z",
    "updated_at" : "2026-08-18T14:35:56.491931Z",
    "external_entity_id" : "INfpSauYjE"
  },
  "created_at" : "2026-08-18T14:35:56.542133Z",
  "updated_at" : "2026-08-18T14:35:56.542133Z"
}

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_43XCptkkmPkd4agMPEO8Bz/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNjM1YWZmNC0wN2U3LTQzNTItYThjNS01NTBlNTk1MTcwOGQiLCJqdGkiOiI4YThmZmEwOC1iMjZkLTQyMGEtYmMyYy00ZGUzMTNkZTA2M2QiLCJpYXQiOjE3ODcwNjM3NDIsIm5iZiI6MTc4NzA2Mzc0MiwiZXhwIjoxNzg3MTUwMTQyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVXbnNmaU9yc3VpTURSb1NXVkRQeGkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.P1awE_eJpNxqitqeJU3RY7uIcd8dFjhyn7kvEJCbCpqSVZFP2uB4NmITKOYVFREcTOXv2XQBDsNe270gmfjCfjSTk7nnAVEeaHGyLrYqrB9GhYa_E0wjtNLLytWBY9DB9648vCI-RjAr4_Ga12gTl5OiuEYAt6jY2sCXvwV_TZoDAxZ8MHXIZdXcAnc7le_komZhUVjQTuOwl0-x4ANGgo-vQJz7c1hUdtjNRVKk3B6GBBScxURi9S9uCatO0K7r0KGJ4JzYLMwdKggSqWgrhQ4JJWAY4nEvrcvVvSdq5mNHg5OLuN6uWc-gAcrZfBZWyWdYWCduAD6j19cjZArxwh7xjC0YLVtjPWWoLW3KRElbVQSUCOqmS9C30hxOw39P_454MiG8Bzui6TzqGeU6KGHVYUHC86rKxCC9_UDz3wWDi0xhcgTNqDM6g0tyw2QITzcYLV8wU-CTzkpI1lcdbo-Jon9fxddOR2r9qYNNiWaIJQTlBZMYczBJrqlJvdMPaY44SGwr5GBfpBEwFLvTeRbk3JSgUHaO7ucYqVRzbiQw42ureSpVdYG8FlQd46vC2v1XHCNw9Git38FPBR_A2x1ah4ZfviPDME38xM-8iK5Z9QwLjohLJQIEkP8tYOGnq8pNahTLe9EKmGO1aoDZAE205J65M-sIFwUwlleZh-Q
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: 5637

{
  "data" : [ {
    "id" : "dsg_24AdPVAhRabowjZbuLAMhl",
    "name" : "Example dosage",
    "dosed_at" : "2026-08-18T14:35:42.496031Z",
    "comments" : "1SPSVElD7m",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "4.58",
      "display_unit" : "mg/kg",
      "display_value" : "4.58"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "16.31",
      "display_unit" : "ml/kg",
      "display_value" : "16.31"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "25.56",
      "display_unit" : "mg/ml",
      "display_value" : "25.56"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "31.20",
      "display_unit" : "µL",
      "display_value" : "31.20"
    },
    "study" : {
      "id" : "sdy_43XCptkkmPkd4agMPEO8Bz",
      "project_id" : "pjt_5ypbkjz5wdHLwWZk1dAxRe",
      "name" : "ZsGvhkaEEl",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2f5FJ1QhK3eoMKeZe66iUI",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "508FQuQtaA",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1wDwm11khJRFYOgEVU1tj4",
        "name" : "NVrANXfBkE",
        "email" : "R1kLE1UQ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1NhoX45A9O4sI3uW6Ui9mK",
        "name" : "uLkA6Dje81",
        "email" : "k6ujuJot@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:35:41.211663Z",
      "updated_at" : "2026-08-18T14:35:41.211663Z"
    },
    "animal" : {
      "id" : "aml_3cc1yu8uPsJDR7aHLjzrsN",
      "study_id" : "sdy_43XCptkkmPkd4agMPEO8Bz",
      "study_group_id" : "grp_zVJkSnbmluQrFZ0ZQiKlh",
      "cage_id" : "cge_5jobz19GuFlAdPVJCoy10y",
      "catalog" : "A0000001",
      "name" : "39XQoSWCW6",
      "number" : 1,
      "strain" : "0QyYImTVZm",
      "species" : "Ugu1ZusKqB",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "4G2wddLobz",
      "ear" : "a9mM2G7oJw",
      "tag" : "UANYPFi4bq",
      "donor" : "R8PkbqhlP2",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_60AGX36YfH0UmXWmY1uVgV",
        "name" : "5Z0Na1YkH4",
        "email" : "OIRF4x2j@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2xfdf1tRUfpPkpGQ8Lhv3w",
        "title" : "Found dead",
        "comment" : "tr8fN2Ndtv"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:35:41.917491Z",
      "updated_at" : "2026-08-18T14:35:41.917491Z",
      "disease_induction_date" : "2026-08-18"
    },
    "measurement" : {
      "id" : "mst_4k4LeQkqQVveeMphTDXGR9",
      "study_id" : "sdy_43XCptkkmPkd4agMPEO8Bz",
      "animal_id" : "aml_3cc1yu8uPsJDR7aHLjzrsN",
      "measured_at" : "2026-08-18",
      "calculations" : [ {
        "id" : "vbl_45aPGlVnFjpPEHZf2cyoaa",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_45aPGlVnFjpPEHZf2cyoaa",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-08-18T14:35:42.168205Z",
      "updated_at" : "2026-08-18T14:35:42.168205Z"
    },
    "user" : {
      "id" : "usr_2jOWQm0xeQNs1ujiuib7OM",
      "name" : "54YzW Overwatch",
      "email" : "MOovRDtO@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:35:40.719611Z",
      "updated_at" : "2026-08-18T14:35:40.719611Z"
    },
    "treatment" : {
      "id" : "tmt_5dVYWrwvXRzqc7nhofnhq9",
      "study_id" : "sdy_43XCptkkmPkd4agMPEO8Bz",
      "type" : "concentration",
      "name" : "LOK3xE4P3H",
      "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-08-18T14:35:42.321435Z",
      "updated_at" : "2026-08-18T14:35:42.321435Z",
      "external_entity_id" : "Gfysxlu6K0"
    },
    "created_at" : "2026-08-18T14:35:42.496439Z",
    "updated_at" : "2026-08-18T14:35:42.496439Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_43XCptkkmPkd4agMPEO8Bz/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_43XCptkkmPkd4agMPEO8Bz/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_43XCptkkmPkd4agMPEO8Bz/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

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_6NaVoTdRcZgkA2LLTdtzxr/measurements HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhOGU0ZjBiNC1hNWIxLTQ4OTUtOWJjNy1mNGNkMmRhNzRmYTUiLCJqdGkiOiI2YzE1MWMzMi1mOTNlLTQyYzctYWFiYy0yODI0ZGMzNTFhNjAiLCJpYXQiOjE3ODcwNjM3ODAsIm5iZiI6MTc4NzA2Mzc4MCwiZXhwIjoxNzg3MTUwMTgwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFJNjdkMzlzUjNXT0l6UWtUcW9PUWYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.nQ1NMPx5XnzgLU1yuMzZCZ5en4k8h1XLouvSfEzQCpi34cVWw7dGouKeZm5vZri7g3an6ngxJgiEFxmxtqUVd28qNDjTnrF18jocTscS-SNMR5nlD_abBnLIq_KtRNXJ60OjZaK3GFIdnTU2aHHhq3q-f5DKZz2lxvXoVjjknkTTomh9cbhhKbkrGbiM9QK4KUCPJxLgqs47dy4oiGiSZgxSsgVGGTIV3JUw4E847ZIuHDNRJMM8xnfysugjLUgPHXs2UwA09Jbz9bULq5Iu6hThYbGqZtK7uF2aW4X8mh7RCRPSSSVu9fvnfpDm-iSPMSrfWeBdwS4vhpL5Z_X2QPX8N2Wn5zqnR77kuEN-nUPYVgkkOtN8fFlhzjyBnNGnAmSC1Nzv7282ApAkF3cU9l3d3iNgfdPqNRRi9SPtLoPe8CGqFcW1wYyW4Ram9buyCr5mylQVWPfyQEfWkogCTaNBYBOXJGTTc3Dx4CU4YVfp8rux6j8wtwcxDP21PHZtmvEXBJ1gcogHxwBDEEbR6GkPu31ECnvnHPK0zdUv7sbHNuoDrrbnJC16TXI7JZh7OUnZV_s4LpIaTQZCsf-dWlSNT3vmmJS575Fbjz4fM67VBGFfb6-ev6Mo6EG1fYChb8k7fofOm1ObbTo6UHhJq44alMXE9Mq_jNqMvn_N07Q
Content-Length: 742
Host: localhost:8080

[ {
  "animal_id" : "aml_6gl4ZNdpDevC8HSY09pLNm",
  "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_367vnW6zPwuinA159KhyO9",
  "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: 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: 5227

{
  "data" : [ {
    "id" : "mst_6IEMHYpZxgKzY7dMNZLQex",
    "measured_at" : "2026-03-25",
    "calculations" : [ {
      "id" : "vbl_3NMw6wE1JJMZlVFEDPbhcY",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "6",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6MOM7LuOmWtsJBaRp7vvoy",
        "key" : "width",
        "value" : "2",
        "unit" : "mm"
      }, {
        "id" : "vbl_2kxeMgm6Zg70dkv2LImBmC",
        "key" : "length",
        "value" : "3",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_5oPKb7Bhgc5yg7RmoerNLk",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "5",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_5oPKb7Bhgc5yg7RmoerNLk",
        "key" : "weight",
        "value" : "5",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6NaVoTdRcZgkA2LLTdtzxr",
      "project_id" : "pjt_6IhClD8Ow5uXGR0ixWvuxz",
      "name" : "YRYzrzcftt",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2djk0ik1s9RjgxesckYVAM",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "u7W98NJPu0",
      "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-08-18T14:36:20.724016Z",
      "updated_at" : "2026-08-18T14:36:20.724016Z"
    },
    "animal" : {
      "id" : "aml_6gl4ZNdpDevC8HSY09pLNm",
      "study_id" : "sdy_6NaVoTdRcZgkA2LLTdtzxr",
      "study_group_id" : null,
      "cage_id" : "cge_7hiKprLqEfMSA7qdPPuRQm",
      "catalog" : "A0000001",
      "name" : "XqdOtTa0Th",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "10Cj6XppXd",
      "ear" : "KcIwLYe9Zb",
      "tag" : "RIerpxovBX",
      "donor" : "8YvX93u0rO",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-08-18T14:36:20.767345Z",
      "updated_at" : "2026-08-18T14:36:20.767345Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:20.858230Z",
    "updated_at" : "2026-08-18T14:36:20.858230Z"
  }, {
    "id" : "mst_4lmdDgBuf67oX74euBvDHf",
    "measured_at" : "2026-03-25",
    "calculations" : [ {
      "id" : "vbl_1jU967TqOMO0W5fA3SzFm9",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "18",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_7LwO9M0GM1M8eYHgqVWBdv",
        "key" : "width",
        "value" : "3",
        "unit" : "mm"
      }, {
        "id" : "vbl_KXxt4cRcs5I9Pa7tMRwyc",
        "key" : "length",
        "value" : "4",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_7deGmfb1pJQGvDNFsvD61u",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "3",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_7deGmfb1pJQGvDNFsvD61u",
        "key" : "weight",
        "value" : "3",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_6NaVoTdRcZgkA2LLTdtzxr",
      "project_id" : "pjt_6IhClD8Ow5uXGR0ixWvuxz",
      "name" : "YRYzrzcftt",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2djk0ik1s9RjgxesckYVAM",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "u7W98NJPu0",
      "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-08-18T14:36:20.724016Z",
      "updated_at" : "2026-08-18T14:36:20.724016Z"
    },
    "animal" : {
      "id" : "aml_367vnW6zPwuinA159KhyO9",
      "study_id" : "sdy_6NaVoTdRcZgkA2LLTdtzxr",
      "study_group_id" : null,
      "cage_id" : "cge_2fqbMQrdPwkBoWqRgwnnRB",
      "catalog" : "A0000002",
      "name" : "pE0E0GcG11",
      "number" : 2,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "ifFEDRlGEP",
      "ear" : "wiai4rqeZt",
      "tag" : "V5OMEQ4Xwz",
      "donor" : "PUEhnmvACd",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-08-18T14:36:20.779608Z",
      "updated_at" : "2026-08-18T14:36:20.779608Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:20.858230Z",
    "updated_at" : "2026-08-18T14:36:20.858230Z"
  } ]
}

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_CsPKykLsNZrPLU69jsaVw/measurements/mst_3bhCfJNSNgsXENMAFVDC6Y HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MmZhYTg0OS1hMGFiLTQ2YzItYjdhZC0yNTYzOTRhYzRmMTEiLCJqdGkiOiI1NTliYWUxMy04YTUyLTQxZTQtOTk2NS0wZDAwMjhjZmZjY2YiLCJpYXQiOjE3ODcwNjM3NzcsIm5iZiI6MTc4NzA2Mzc3NywiZXhwIjoxNzg3MTUwMTc3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdESmFDdHBCS28xUnZDVUxscWR5dFQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.YTI5dl32Jaadl-MEwwVd442_i-KLw2sLgmE5-DxPl4ddQyiYGCNK5QZrWyVKmR7JCRROJ6noB0wNCotF-8C3kkBa3cyBaMHCWaA5Ur9dztP9jP_PB8G1gnzo5eReD1HEmTdiLHyZ_FUvRds0DjJnjJrw6MtUVuQk_wjnh1Wsla6iO36xwSKKfMrCrGiC-86jgD7qSZcd4HXj9F-HZwVKEHIlhyApwMK3ZyjbXvrSU9vFF0Hqc4DL9aS6FBg470BEp8FQ_3TZ36yYR0KZwEMHTWj_FveSApgKqIhHwLfsblmbIoULnpIZ4OgL-SLc3i4Vyu8D77b4BkaOdQC6seZJDvxZRRbn5l2lsK4ZqAAb6Jx-tRV7dSj4Lb61zWH8_FOmmIMEOzXNzcfcXmriXuY1TE-wVrRN8Sr0YJLUy7Jh6lf6DZAPSh-Mq2D2qP7dKraSJ54l2tjQ6nqie7xQFuoDdXpokx_Z4QoT8nEA1LJDVJzNzyKxFE5qA9PFnzoGOvfJRec5ek5vdm35Tu5aYL5uHjuDFHpVpbAX3nK9hfz9oR9MbgzYYZlot8Ea7kIwLPF_5wfrB-WxG9vFDGsglpoyc-s7djbRyAg38Zwdt7Z0QtOwnA0en1eWW9aIOYrOOjn1U2AGYODDTO5ioo8SKo52j_JGYJzsHTV1qeCQbseJF1E
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: 3397

{
  "id" : "mst_3bhCfJNSNgsXENMAFVDC6Y",
  "measured_at" : "2026-08-18",
  "calculations" : [ {
    "id" : "vbl_4mPmcz96PYl2cPEIXR38dK",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_57QlgXI6QuLiEOkeI0eLmx",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_7LkamABEMhPujy2EMqEfnx",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_2ByBlTobb7nGrOaGGK1eXZ",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ {
      "id" : "vbl_2ByBlTobb7nGrOaGGK1eXZ",
      "key" : "weight",
      "value" : "55",
      "unit" : "g"
    } ]
  } ],
  "study" : {
    "id" : "sdy_CsPKykLsNZrPLU69jsaVw",
    "project_id" : "pjt_4sj559HkssLalgzegOHd9w",
    "name" : "b89TfQ4Rx8",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6mVkFcwl728MF6m9hqdv8Z",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "AXLpNv1HaU",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4kzsrxBy5DE3SihQhrEM7g",
      "name" : "nowmA2hJOv",
      "email" : "BPWiprbo@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5Ryx9OdzjFKZhRCqH5EF8U",
      "name" : "3MMx2gRl85",
      "email" : "BvxDBepP@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:16.855981Z",
    "updated_at" : "2026-08-18T14:36:16.855981Z"
  },
  "animal" : {
    "id" : "aml_1XeCKRqf1XiytUqGDLPZzT",
    "study_id" : "sdy_CsPKykLsNZrPLU69jsaVw",
    "study_group_id" : "grp_5e1iTra5kPcQe4VmvMkvkj",
    "cage_id" : "cge_4dXsRW9xpmeUzkAZip6CKc",
    "catalog" : "A0000001",
    "name" : "7ueN6gbT1O",
    "number" : 1,
    "strain" : "eiB9ZXteLD",
    "species" : "yf9eR3eKgZ",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "vJEqwqzjBu",
    "ear" : "WGAGndgYUl",
    "tag" : "iIycLvxS0s",
    "donor" : "UrqGtJ1RJ3",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_3SOFVXrf1CEIYaR1tDutLW",
      "name" : "zPZQqL4eQT",
      "email" : "nWvZdOPF@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_JIpQ49U2udn6Gr5X2hsac",
      "title" : "Found dead",
      "comment" : "cjiNpzoTQa"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:17.059767Z",
    "updated_at" : "2026-08-18T14:36:17.059767Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_ZC8u8IdgqC5Hr3x1yjhFU",
    "name" : "kYx5o Overwatch",
    "email" : "dIOVoIU9@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:16.826070Z",
    "updated_at" : "2026-08-18T14:36:16.826070Z"
  },
  "created_at" : "2026-08-18T14:36:17.167282Z",
  "updated_at" : "2026-08-18T14:36:17.167282Z"
}

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_2oabbtXbr9H9V4ij3vPIG3/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYWUwNjAzZC1lZGM2LTQxYzctYmJhOC03OWIxYTkwMDcwZDkiLCJqdGkiOiJmMTk0NGI5MC1kM2YzLTRmNTctYWVlOC1kYjRlYWI4NDEwZGQiLCJpYXQiOjE3ODcwNjM3NzQsIm5iZiI6MTc4NzA2Mzc3NCwiZXhwIjoxNzg3MTUwMTc0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY3MTB4ZVlOWFI1RXVPY2hZbDdiaFkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.gXFl1H1lz2tzQMT2q3Gawkj405Z6BKsdDp4efZZVZMnWNjJn7Yg5ooFYz5jhmcvkUvc8vUk_zM2f77a-4iKtCCmau1ItFb1RwnYbbnoAGcaYr7BJtZ17A4mEDnzHPNl1s9PN1MHMZSPgNVtrQRHL86RlaLwhm2RgMIx8-lbnXf5OAZFVgr0VoD5hjzrJfPH2klV6AiV4Xfq259JJ1213GMUHGBWH3IOsk3bPYlopZAZDkIkhBXedOnNpa0tEOb_9E7r6IZAViTHhRKbla8cDjvFPD-yBCK5qN8twO9OLQTzfzdv901LoRmP0Cm11t3ACF3L80wTX2b_FCDQb0hguks-PZggAR6BlzRoUEFfL23hDeu6esIa004PMAmaxwmifMAWqm9qt1jf3EgiuYHeSx3n295dKlkHpm1ZKiZseJo9xixyo4wGfEcyV3bf9YNSeC2Rn-Wt7Iyi8WKpQWVtbbObR25jwcicSC9FVrlZ85K5TRoiZnY9Xe69yaO24MfhWglinup0-fQ2ozJc0thMnCYGrZVWmqMK_WpLUPu26kgFYAgjGF7LbHk_md5u69imZ7UZgOutUa7yugelxUxkC3u_JGQEFghUEK2lzt4Ms-JX6ioZjVNCZZl4z-WGOZn7ZSAMkh_XVyXR_XoRuhce2K-sC_22Qs2dV75K_6Q2_ix8
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_6R9WlrzwaIkthYFj94LFcL",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_2xoIreZPnL3NS4FdxwLlWU",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_770tEImLX5HqUk2OK8pTIT",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_29sIaKapmpFUBaInBFMBUG",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_28k7xhSgtlmgGfeyzfA4di",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_28k7xhSgtlmgGfeyzfA4di",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2oabbtXbr9H9V4ij3vPIG3",
      "project_id" : "pjt_79S2durhjedpdQiflwDLq7",
      "name" : "Vr21AiPreb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ezyTiYA2ChBCTrK59wM6G",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "4F1lXXiLcd",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2VjNLNNwNZOnSXWuBh0hlD",
        "name" : "uTILD78GBw",
        "email" : "rpL8QnJp@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1iFZr5FaAUynWQwQtHSZ72",
        "name" : "f62uIm9pGe",
        "email" : "AIlFWVaU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:13.035166Z",
      "updated_at" : "2026-08-18T14:36:13.035166Z"
    },
    "animal" : {
      "id" : "aml_1Gb8IIU4LRAOFSRTtk4jrV",
      "study_id" : "sdy_2oabbtXbr9H9V4ij3vPIG3",
      "study_group_id" : "grp_6F2kTCcoHDcHKPTEZuoYvy",
      "cage_id" : "cge_32BEsA7ghXWQvMLWQZP3PF",
      "catalog" : "A0000001",
      "name" : "rWxSTfr7Nq",
      "number" : 1,
      "strain" : "ZYwrPEwowP",
      "species" : "x7uhWoQoSC",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "pw0bD1XEtz",
      "ear" : "g2EHtunojk",
      "tag" : "JwnzwBFusO",
      "donor" : "kNwSMxqcfc",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_7W4ZsS97bFDUQbGId8VshF",
        "name" : "wrDQZgk8oS",
        "email" : "XkkbUUDv@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_38NL4325U1oXfNmXw7kqYo",
        "title" : "Found dead",
        "comment" : "wwmsZceMcn"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:13.973846Z",
      "updated_at" : "2026-08-18T14:36:13.973846Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_6CB0RRMAcL84rNCy2r8vMQ",
      "name" : "bx59Z Overwatch",
      "email" : "NTbzbXXc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:13.004931Z",
      "updated_at" : "2026-08-18T14:36:13.004931Z"
    },
    "created_at" : "2026-08-18T14:36:14.142293Z",
    "updated_at" : "2026-08-18T14:36:14.142293Z"
  }, {
    "id" : "mst_4T0wPOGr7MGgQ54Gio8jef",
    "measured_at" : "2026-08-17",
    "calculations" : [ {
      "id" : "vbl_nSB9DLSX6zoFB6k3e7mg8",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_1SF4yIbuozEgfnqxM9iVAi",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_1QrNmLDhnIOx1sqJBUOB87",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_B51APTpoOdA1sUrXxTgB8",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_B51APTpoOdA1sUrXxTgB8",
        "key" : "weight",
        "value" : "56",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2oabbtXbr9H9V4ij3vPIG3",
      "project_id" : "pjt_79S2durhjedpdQiflwDLq7",
      "name" : "Vr21AiPreb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ezyTiYA2ChBCTrK59wM6G",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "4F1lXXiLcd",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2VjNLNNwNZOnSXWuBh0hlD",
        "name" : "uTILD78GBw",
        "email" : "rpL8QnJp@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1iFZr5FaAUynWQwQtHSZ72",
        "name" : "f62uIm9pGe",
        "email" : "AIlFWVaU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:13.035166Z",
      "updated_at" : "2026-08-18T14:36:13.035166Z"
    },
    "animal" : {
      "id" : "aml_1Gb8IIU4LRAOFSRTtk4jrV",
      "study_id" : "sdy_2oabbtXbr9H9V4ij3vPIG3",
      "study_group_id" : "grp_6F2kTCcoHDcHKPTEZuoYvy",
      "cage_id" : "cge_32BEsA7ghXWQvMLWQZP3PF",
      "catalog" : "A0000001",
      "name" : "rWxSTfr7Nq",
      "number" : 1,
      "strain" : "ZYwrPEwowP",
      "species" : "x7uhWoQoSC",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "pw0bD1XEtz",
      "ear" : "g2EHtunojk",
      "tag" : "JwnzwBFusO",
      "donor" : "kNwSMxqcfc",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_7W4ZsS97bFDUQbGId8VshF",
        "name" : "wrDQZgk8oS",
        "email" : "XkkbUUDv@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_38NL4325U1oXfNmXw7kqYo",
        "title" : "Found dead",
        "comment" : "wwmsZceMcn"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:13.973846Z",
      "updated_at" : "2026-08-18T14:36:13.973846Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_6CB0RRMAcL84rNCy2r8vMQ",
      "name" : "bx59Z Overwatch",
      "email" : "NTbzbXXc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:13.004931Z",
      "updated_at" : "2026-08-18T14:36:13.004931Z"
    },
    "created_at" : "2026-08-18T14:36:14.178180Z",
    "updated_at" : "2026-08-18T14:36:14.178180Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2oabbtXbr9H9V4ij3vPIG3/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2oabbtXbr9H9V4ij3vPIG3/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_2oabbtXbr9H9V4ij3vPIG3/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_12qY6AP3fIgOsokUGyyOeD/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhMDdkOWU1ZS0yNzcyLTRjZjEtYTBkZS0zMzcyOGE3YjZkMTIiLCJqdGkiOiI5YmQ0MTYzZS02Mzk3LTQ2ZWMtYmVlYi04OTBmOThmNDJjNGQiLCJpYXQiOjE3ODcwNjM3ODMsIm5iZiI6MTc4NzA2Mzc4MywiZXhwIjoxNzg3MTUwMTgzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzlHNFFDZFZ4TjliWWNQNHRNRkpnOSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.IOwCikWhle3rONNMV_FSsG6X50kaIN6sJTE2CPvEp5F0tdmJTpshE3-f2bpIY9AqWlenYZ89tfraf_0A7WH1iDPT2S5BWpwmDJ0dqkp1H0lEA8v0CX_b-zvuErlxZgHK7Z5CbvhRdV5HxHME1TD1I2CHXof75YKKZsBPT_rSnL_AMxRQbvaz2C7jNqw6GytQS3UqXgoFqDJqpVGc2lOAcKl1ASlEFFHaegkzpdO8QOnTfzLNMZH4fFaRLxcMxQWmlmTmcvHTKClrl34jfipTj7U3xjlLRxd1TGyZfZS1e40OjdaN2A2nz1MdaqCazSBtRwene_RDwztxbca9VFFWO4_3jL-K8WXAo8zdafhNSMGGxCGX2qdTlFePGTWbyB6JbrS58B0iNAh_C-XPFFS6FiXfhKQbD7u5yxNBEK2nGNtzcrcmWgJl5D_483JnLs1LnxwTd9r6Txsbkt77RYY4Iz6jhmsouTwGgiScza95DI6MYY1W2A24sRlv8a2EMIYFkgF3NNx9lqijNLlLp-89eBq5goKXYKPujd8As_AtZ3cUOHIhhI0awWU4MfVUuqxZRdvZWSQ2xaZCgsUb6cHFa6mpFZLg2wXDCaCEHLD31YHB-LmUvZ-mMHu6F2O_CqzHash6a51RmiLbRhemZ3_QGDHdqlUbbgev36LP-bya4sg
Content-Length: 618
Host: localhost:8080

[ {
  "animal_id" : "aml_V91ebrenLoIrBA1OQKn2G",
  "team_glossary_id" : "tgy_5ZqF0t5XqMrDTnf3cqBEnc",
  "observed_at" : "2026-03-25T10:30:00Z",
  "text" : "Animal appears lethargic.",
  "value" : "Severe"
}, {
  "animal_id" : "aml_V91ebrenLoIrBA1OQKn2G",
  "team_glossary_id" : "tgy_1b0cnwvdr5ddzCH45ZVLRZ",
  "observed_at" : "2026-03-25T10:30:00Z",
  "text" : "Measured with calipers.",
  "value" : "1250.5"
}, {
  "animal_id" : "aml_V91ebrenLoIrBA1OQKn2G",
  "team_glossary_id" : "tgy_3WZ19phPaS2jlXYYa904Iz",
  "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: 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: 7952

{
  "data" : [ {
    "id" : "obs_3maa8MuIq6jRIAFKfLjuJK",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_5ZqF0t5XqMrDTnf3cqBEnc",
    "title" : "Body Condition",
    "label" : null,
    "text" : "Animal appears lethargic.",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-03-25T10:30:00.000000Z",
    "study" : {
      "id" : "sdy_12qY6AP3fIgOsokUGyyOeD",
      "project_id" : "pjt_6KZyxWoKMxRuoTPDu5kiGs",
      "name" : "HxCz9ImGFd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_WSGhAtXb6e079pF5EPhYO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qlHVl3nBW6",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2JguF8OHTOrmLFuXUwoDcp",
        "name" : "kKgSa4r2ij",
        "email" : "py5DCVgw@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5Go6edposesSwThtLt2Dl0",
        "name" : "aH37dfS237",
        "email" : "dNkuuAjZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:23.072447Z",
      "updated_at" : "2026-08-18T14:36:23.072447Z"
    },
    "animal" : {
      "id" : "aml_V91ebrenLoIrBA1OQKn2G",
      "study_id" : "sdy_12qY6AP3fIgOsokUGyyOeD",
      "study_group_id" : "grp_3i88E4qszwKv6hr3ueWHVT",
      "cage_id" : "cge_okcmzpTZZgaErkbyWZ08d",
      "catalog" : "A0000001",
      "name" : "kZoDwjRIaq",
      "number" : 1,
      "strain" : "ulfAeG8iyk",
      "species" : "gnLxq5b5AG",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "4D5CgMDKdf",
      "ear" : "qfFtyuukLY",
      "tag" : "TtvZTe0GKh",
      "donor" : "xDCtrLoQk4",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_1b72Sh9wkKLgRNcriIPbfr",
        "name" : "gJN8N2nj5n",
        "email" : "M6Ye39Bz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7B11Wbm8Wr2Y0uLxns2Org",
        "title" : "Found dead",
        "comment" : "o42mHQFkWq"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:23.397261Z",
      "updated_at" : "2026-08-18T14:36:23.397261Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:23.700729Z",
    "updated_at" : "2026-08-18T14:36:23.700729Z"
  }, {
    "id" : "obs_4NUVA1wYNe7p9Wo97WyCFr",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_1b0cnwvdr5ddzCH45ZVLRZ",
    "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_12qY6AP3fIgOsokUGyyOeD",
      "project_id" : "pjt_6KZyxWoKMxRuoTPDu5kiGs",
      "name" : "HxCz9ImGFd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_WSGhAtXb6e079pF5EPhYO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qlHVl3nBW6",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2JguF8OHTOrmLFuXUwoDcp",
        "name" : "kKgSa4r2ij",
        "email" : "py5DCVgw@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5Go6edposesSwThtLt2Dl0",
        "name" : "aH37dfS237",
        "email" : "dNkuuAjZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:23.072447Z",
      "updated_at" : "2026-08-18T14:36:23.072447Z"
    },
    "animal" : {
      "id" : "aml_V91ebrenLoIrBA1OQKn2G",
      "study_id" : "sdy_12qY6AP3fIgOsokUGyyOeD",
      "study_group_id" : "grp_3i88E4qszwKv6hr3ueWHVT",
      "cage_id" : "cge_okcmzpTZZgaErkbyWZ08d",
      "catalog" : "A0000001",
      "name" : "kZoDwjRIaq",
      "number" : 1,
      "strain" : "ulfAeG8iyk",
      "species" : "gnLxq5b5AG",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "4D5CgMDKdf",
      "ear" : "qfFtyuukLY",
      "tag" : "TtvZTe0GKh",
      "donor" : "xDCtrLoQk4",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_1b72Sh9wkKLgRNcriIPbfr",
        "name" : "gJN8N2nj5n",
        "email" : "M6Ye39Bz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7B11Wbm8Wr2Y0uLxns2Org",
        "title" : "Found dead",
        "comment" : "o42mHQFkWq"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:23.397261Z",
      "updated_at" : "2026-08-18T14:36:23.397261Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:23.700729Z",
    "updated_at" : "2026-08-18T14:36:23.700729Z"
  }, {
    "id" : "obs_FycOKw4rFIXot18RCwc46",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_3WZ19phPaS2jlXYYa904Iz",
    "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_12qY6AP3fIgOsokUGyyOeD",
      "project_id" : "pjt_6KZyxWoKMxRuoTPDu5kiGs",
      "name" : "HxCz9ImGFd",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_WSGhAtXb6e079pF5EPhYO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qlHVl3nBW6",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2JguF8OHTOrmLFuXUwoDcp",
        "name" : "kKgSa4r2ij",
        "email" : "py5DCVgw@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5Go6edposesSwThtLt2Dl0",
        "name" : "aH37dfS237",
        "email" : "dNkuuAjZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:23.072447Z",
      "updated_at" : "2026-08-18T14:36:23.072447Z"
    },
    "animal" : {
      "id" : "aml_V91ebrenLoIrBA1OQKn2G",
      "study_id" : "sdy_12qY6AP3fIgOsokUGyyOeD",
      "study_group_id" : "grp_3i88E4qszwKv6hr3ueWHVT",
      "cage_id" : "cge_okcmzpTZZgaErkbyWZ08d",
      "catalog" : "A0000001",
      "name" : "kZoDwjRIaq",
      "number" : 1,
      "strain" : "ulfAeG8iyk",
      "species" : "gnLxq5b5AG",
      "sex" : "m",
      "dob" : "2025-01-01",
      "tail" : "4D5CgMDKdf",
      "ear" : "qfFtyuukLY",
      "tag" : "TtvZTe0GKh",
      "donor" : "xDCtrLoQk4",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_1b72Sh9wkKLgRNcriIPbfr",
        "name" : "gJN8N2nj5n",
        "email" : "M6Ye39Bz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7B11Wbm8Wr2Y0uLxns2Org",
        "title" : "Found dead",
        "comment" : "o42mHQFkWq"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:23.397261Z",
      "updated_at" : "2026-08-18T14:36:23.397261Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:23.700729Z",
    "updated_at" : "2026-08-18T14:36:23.700729Z"
  } ]
}

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_YaLJ7QZzphvztC3o8Ai1w/observations/obs_2cbO0TyoUsxuuZdapvgS6n HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMjhhMzhkMC02NzZmLTQ4ZjMtYjdlMS02MjQzZDA1OGFiZGUiLCJqdGkiOiI3MjhlZTFiZi0xZTkzLTRmODktOGE2Yi1hMDk5ZWMzMzk4MDYiLCJpYXQiOjE3ODcwNjM3NzgsIm5iZiI6MTc4NzA2Mzc3OCwiZXhwIjoxNzg3MTUwMTc4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzh1NlVnWDdoTHlJajdDNExUTUZQVyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.b0kTVVbw97Bk7lKqmD2OdVsyZIsqo169XtiefF9NB0T-jefCP5xTkeRuDstNOP5bTBCqc2dF56UH8_k2M4m4BX_DYNs6mNkJVstOAV7B-yFWl_-Qg820zPIKqWLhmrtcMYkLeXR28ASsDt726MrHOUzDkoZIK5Mk5eYf6QBTQsvVptrVx4WnTwiBCQATBpisR-tT2YyMHSTik2EKDY8L8D6s4RqAdIT0ev7DPxAtqwhEghwuQQWWd6eWv5hA6eH2siUqEP0EP2mpo6DJ7fp1vKftveDfdHcEAcznJYl9TethJIrFBGBcTjjSN65wa-acdEMOXK8P9jZ_FbXnxbSMGiCZeVm7INSTA35lWRKKU6Z5advLngKTI4C3rWykstLbxtOiranobPNhPnDwgUuBTYN1eLt-IjPizGXZLT3ol0OBnBVCNRLt0dehuFbIE17fCBJNs7cM3yBo6-vhcuMIp8Q4FG3x1f7YbVPQ0Wqm7NhgHYRpVyD7z6ic-e-lXN1xFbzgv1BDk9AptL6n00Cxt4uwm4BPEbPQQp1pk2bVFNxvneujPe7Ag8K5m_94AjwtMum6lvQYtheJ57lkMJ-y90aw5gSnUUULASTVgSp-sbsgA7dTU-912OVUXHtuHmMzvI701IEKvKrrUDQy6SZBN-sZ5fxV-eOoNKV_eY5bjiA
Host: localhost:8080

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: 2806

{
  "id" : "obs_2cbO0TyoUsxuuZdapvgS6n",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_2jcJBvm51aU2FXT6sOow2k",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-08-18T14:36:18.131258Z",
  "study" : {
    "id" : "sdy_YaLJ7QZzphvztC3o8Ai1w",
    "project_id" : "pjt_7B6buFqYCBEEoju2hTqoPD",
    "name" : "GFmT59Bi7Q",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5UO4vLSE6OG88BU9Z5E01n",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "8tTnemNN69",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4ime2nfbXVM6rOK4C67NJO",
      "name" : "VMRmN2PqQ0",
      "email" : "aeWDxwOL@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_507fkcmZH3npfT59XPCtwL",
      "name" : "CG6dAheQ12",
      "email" : "cgPNZkKU@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:17.444039Z",
    "updated_at" : "2026-08-18T14:36:17.444039Z"
  },
  "animal" : {
    "id" : "aml_60isjBXex3RP73FbtTYhfA",
    "study_id" : "sdy_YaLJ7QZzphvztC3o8Ai1w",
    "study_group_id" : "grp_3QiymUpFMRc0eowSZmJYVS",
    "cage_id" : "cge_37QuA1JOVExScWQOHMIppy",
    "catalog" : "A0000001",
    "name" : "Bk7y6iSUzs",
    "number" : 1,
    "strain" : "426NQIrG8a",
    "species" : "rUWODHuyaa",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "HJNxhmhoCy",
    "ear" : "HwQHcZyULd",
    "tag" : "C5ZRIR9ftS",
    "donor" : "6UQqjs1Z0h",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_2e4dD7REPHFi2jMGBFOz9D",
      "name" : "pjllLM8UaE",
      "email" : "7kpzUScR@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_9SbmIOBUrvZDtJ5dCPV40",
      "title" : "Found dead",
      "comment" : "XkJE3ZIJD8"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:36:17.884779Z",
    "updated_at" : "2026-08-18T14:36:17.884779Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_3VzddyagTSZAPTU6v1c3M2",
    "name" : "R6IRo Overwatch",
    "email" : "jRhu96G0@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:17.360019Z",
    "updated_at" : "2026-08-18T14:36:17.360019Z"
  },
  "created_at" : "2026-08-18T14:36:18.131461Z",
  "updated_at" : "2026-08-18T14:36:18.131461Z"
}

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_3emEng72tkekXhRa6TufHt/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZjY2N2RhNy1hM2RlLTQ4ODktYTg3NC1iODliNzgyOWE3NmMiLCJqdGkiOiI4Nzg2NGVkMi1mODhmLTQzYWItYmEzZC02ZTg4YjU1YzFmNzUiLCJpYXQiOjE3ODcwNjM3ODYsIm5iZiI6MTc4NzA2Mzc4NiwiZXhwIjoxNzg3MTUwMTg2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1RWV2pVZGtSUXNlZkZITnVOeE5GRyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.a9Y4FqhB_OhGWDrNR17nxk6c-PsO-XwuKrfX0PScRJZ_oReDfywVqnyGiY6iDS87ePy9QoslFN3S9MLo7yANPyFqL5SF2Pf6Ou3RjZADb7ZqYgLRmtOf9YA2Gv_SZYWEbCQbeXJj6SjOuubidDg84LS7gP9GgjrNPc8EemV1a3eeLrKCc8Ja9oUKjkwToqilLSSoXHbRFhsLVwHHrcTjciuxgoDcZb9EVitR2xTWLzczzua3KdA16L5vrCrr1CewfhGRRmPUc2MzPFldGd_ZKoPWuuhzYsq_Y0wc1LZiMvDjPKNmNemhYtxc4OmjB_hVQRgaHAx65VJVOs-8DlIkE9qRsQrKfPrvJjimFcDiyvsWW_OnIDgq1TfAIS2QkibxoW6PdoCmQDS92uHZvbofRIXoPY5OzKnfK_rFY48eSeWf4hNUav9QgTzoVbVzf_DeyVMuik2nacA_G5NmGKhgGDJZmZbgvzR2VEcp0h7122Evo9qOoabjYHLimboG47ZNYuLMkl1m0TMuC1VQ4ZyYw9V5Dge5jfYQWzk5k9POjUWeBhrNU1tKR0CXB83gE4dgrCtQ1nCTqWpck4K_5Wam_QMJn1jewqBajs_-L__8NQeMYinVAV8m7lzWB6I_RW0V9LaXqqvMS94H8wGbdmPF5h_6uvc2hlXnlgL2KDX5_5s
Content-Length: 411
Host: localhost:8080

[ {
  "id" : "obs_1Z9k4k5gj3ZNlqkdZlSdOq",
  "observed_at" : "2026-03-26T09:00:00Z",
  "value" : "Moderate",
  "text" : "Condition improving."
}, {
  "id" : "obs_1XsNO8aexDfT2peV5SSVpq",
  "observed_at" : "2026-03-26T09:15:00Z",
  "value" : "1300",
  "text" : "Re-measured with calipers."
}, {
  "id" : "obs_5bgiEsDfsjgTtixhgVN7mU",
  "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: 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: 8994

{
  "data" : [ {
    "id" : "obs_1Z9k4k5gj3ZNlqkdZlSdOq",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_3nd4m3qHFNyb8YaSyaAluV",
    "title" : "Body Condition",
    "label" : null,
    "text" : "Condition improving.",
    "type" : "severity",
    "value" : "Moderate",
    "observed_at" : "2026-03-26T09:00:00.000000Z",
    "study" : {
      "id" : "sdy_3emEng72tkekXhRa6TufHt",
      "project_id" : "pjt_6tY1XyVvOya8DafOfrmxMp",
      "name" : "wzajMxJqCi",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3WfWjfNwGIewNki61VW333",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "xQJbU6AOaK",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6lp8tIfiPIFsvi3j9ajeam",
        "name" : "SQlqUAjvQ9",
        "email" : "EitvtsXL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2Y24Kvc727cOS82TGLofk",
        "name" : "CXnd3JGnyp",
        "email" : "lOyIcWc1@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:26.255533Z",
      "updated_at" : "2026-08-18T14:36:26.255533Z"
    },
    "animal" : {
      "id" : "aml_6v7WhLlb8wrZbdLT5fs7ko",
      "study_id" : "sdy_3emEng72tkekXhRa6TufHt",
      "study_group_id" : "grp_7JtesKsO1Jjz1xMCDlulQa",
      "cage_id" : "cge_79iVoEzlU0tvA8sjURYMmh",
      "catalog" : "A0000001",
      "name" : "D9WDk4REdj",
      "number" : 1,
      "strain" : "z9DNqQgVCy",
      "species" : "fO6XarbZh3",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "hPX7jvuRfM",
      "ear" : "tlV7c9DAgQ",
      "tag" : "nL4f6lYhoO",
      "donor" : "yd8W8s6L8b",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_2hC8taFWJ8kkmw3JhaPhr8",
        "name" : "YgxoQJ9HFN",
        "email" : "XL5wbB0d@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6LYSXEamr5c0xcgz2FMwE6",
        "title" : "Found dead",
        "comment" : "hiL085RmFj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:26.525406Z",
      "updated_at" : "2026-08-18T14:36:26.644379Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_33OFv5VvU6SB8JVot5AgMC",
      "name" : "VnwRr Overwatch",
      "email" : "29Yo95vr@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:26.236254Z",
      "updated_at" : "2026-08-18T14:36:26.236254Z"
    },
    "created_at" : "2026-08-18T14:36:26.838669Z",
    "updated_at" : "2026-08-18T14:36:26.923128Z"
  }, {
    "id" : "obs_1XsNO8aexDfT2peV5SSVpq",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_2bJ6rHiIxrj1UR4GVOzdye",
    "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_3emEng72tkekXhRa6TufHt",
      "project_id" : "pjt_6tY1XyVvOya8DafOfrmxMp",
      "name" : "wzajMxJqCi",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3WfWjfNwGIewNki61VW333",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "xQJbU6AOaK",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6lp8tIfiPIFsvi3j9ajeam",
        "name" : "SQlqUAjvQ9",
        "email" : "EitvtsXL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2Y24Kvc727cOS82TGLofk",
        "name" : "CXnd3JGnyp",
        "email" : "lOyIcWc1@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:26.255533Z",
      "updated_at" : "2026-08-18T14:36:26.255533Z"
    },
    "animal" : {
      "id" : "aml_6v7WhLlb8wrZbdLT5fs7ko",
      "study_id" : "sdy_3emEng72tkekXhRa6TufHt",
      "study_group_id" : "grp_7JtesKsO1Jjz1xMCDlulQa",
      "cage_id" : "cge_79iVoEzlU0tvA8sjURYMmh",
      "catalog" : "A0000001",
      "name" : "D9WDk4REdj",
      "number" : 1,
      "strain" : "z9DNqQgVCy",
      "species" : "fO6XarbZh3",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "hPX7jvuRfM",
      "ear" : "tlV7c9DAgQ",
      "tag" : "nL4f6lYhoO",
      "donor" : "yd8W8s6L8b",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_2hC8taFWJ8kkmw3JhaPhr8",
        "name" : "YgxoQJ9HFN",
        "email" : "XL5wbB0d@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6LYSXEamr5c0xcgz2FMwE6",
        "title" : "Found dead",
        "comment" : "hiL085RmFj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:26.525406Z",
      "updated_at" : "2026-08-18T14:36:26.644379Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_33OFv5VvU6SB8JVot5AgMC",
      "name" : "VnwRr Overwatch",
      "email" : "29Yo95vr@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:26.236254Z",
      "updated_at" : "2026-08-18T14:36:26.236254Z"
    },
    "created_at" : "2026-08-18T14:36:26.847592Z",
    "updated_at" : "2026-08-18T14:36:26.923128Z"
  }, {
    "id" : "obs_5bgiEsDfsjgTtixhgVN7mU",
    "glossary_id" : null,
    "team_glossary_id" : "tgy_4SpaYSUiW5Np3CyyB1TL5b",
    "title" : "Clinical Notes",
    "label" : null,
    "text" : "Coat still healthy.",
    "type" : "none",
    "value" : null,
    "observed_at" : "2026-03-26T08:00:00.000000Z",
    "study" : {
      "id" : "sdy_3emEng72tkekXhRa6TufHt",
      "project_id" : "pjt_6tY1XyVvOya8DafOfrmxMp",
      "name" : "wzajMxJqCi",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3WfWjfNwGIewNki61VW333",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "xQJbU6AOaK",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_6lp8tIfiPIFsvi3j9ajeam",
        "name" : "SQlqUAjvQ9",
        "email" : "EitvtsXL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2Y24Kvc727cOS82TGLofk",
        "name" : "CXnd3JGnyp",
        "email" : "lOyIcWc1@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:26.255533Z",
      "updated_at" : "2026-08-18T14:36:26.255533Z"
    },
    "animal" : {
      "id" : "aml_6v7WhLlb8wrZbdLT5fs7ko",
      "study_id" : "sdy_3emEng72tkekXhRa6TufHt",
      "study_group_id" : "grp_7JtesKsO1Jjz1xMCDlulQa",
      "cage_id" : "cge_79iVoEzlU0tvA8sjURYMmh",
      "catalog" : "A0000001",
      "name" : "D9WDk4REdj",
      "number" : 1,
      "strain" : "z9DNqQgVCy",
      "species" : "fO6XarbZh3",
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "hPX7jvuRfM",
      "ear" : "tlV7c9DAgQ",
      "tag" : "nL4f6lYhoO",
      "donor" : "yd8W8s6L8b",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_2hC8taFWJ8kkmw3JhaPhr8",
        "name" : "YgxoQJ9HFN",
        "email" : "XL5wbB0d@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6LYSXEamr5c0xcgz2FMwE6",
        "title" : "Found dead",
        "comment" : "hiL085RmFj"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:26.525406Z",
      "updated_at" : "2026-08-18T14:36:26.644379Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_33OFv5VvU6SB8JVot5AgMC",
      "name" : "VnwRr Overwatch",
      "email" : "29Yo95vr@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:26.236254Z",
      "updated_at" : "2026-08-18T14:36:26.236254Z"
    },
    "created_at" : "2026-08-18T14:36:26.849513Z",
    "updated_at" : "2026-08-18T14:36:26.923128Z"
  } ]
}

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_6X6oi0sS7C6PyoCKOrzAQm/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNGIwYjU1Yi1hNTg2LTQ2NzktYTAwZi1iM2ZhYjE0ZjllMTMiLCJqdGkiOiJkYzY3MDRjNC1lOGQzLTRjZmEtYmM2NC05OGE5ZTBmODcxZTUiLCJpYXQiOjE3ODcwNjM3OTUsIm5iZiI6MTc4NzA2Mzc5NSwiZXhwIjoxNzg3MTUwMTk1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE1TEszT1RjNUhrcmdIOVVYeTlnQ0siLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.HZgWd2V3t-wHoI0iXZMNVuyIFsxLBCmHXL1F7fW0-bcCNRrd7Km4yoYkuPLqE79eTMPCiczk6MkR0khg-dxqaVH5Zwri2GeTKibfQMbpr7qXcMDWqkA4BU8cFE7NvnlvfpXZT3hB_Y1Lnh0WZsx6IJP8GcrM5HzLT4L6Mu-DgEn_jZCG4O02ie5i8ZmZ_jSJuIZ56q2s2s-j-nfxNwA5YZxTVhwbJZEmG21wOqqt_zHR4xQo5DcbYcNrXa8Z4In2FL1YAc6gImgXeHAXiiTT_zBhMUhT9jqcYb_6F_IG6i256MKatnbQ7QzmEYalPCjNcTS1P6gJqQwyzY_4_hmlNeeAjfmBGl6454-CIVp5bE_oKWrX_GTZnfqmYnWJQ0hxcORqKrK5t98UhOvVj6EJ19HZCsRpC_g1-HwbMp2iybrlDPxpSx4tHxREBnRwg0Id6DiZUoMI6QGa5obzGUbG-Ot3KtQrIinLEiM-h9oaQ5t10lmqmr5aTWwcnvd4X-Pu8GIOsA1_LjtcWy9qDcL81nHyB61ZSwLhpMYVXqeHMXvWoGOZZPUY0MUTSGY6jHxEpAJqRcJ9cXj5U-T2Tf1ts7-c0g6qYPHIDJ3WOTSfo1412hw2EzH71Af5K3D4dze4HGEj2Ux6fY0D3mpUC6REnepx1tQajhyj1WBOYNbKKV0
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: 3513

{
  "data" : [ {
    "id" : "obs_z3iQzVjtvDxoqofixUYmy",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_Aa8lQE70yGisbvR8WtHtN",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-08-18T14:36:35.406082Z",
    "study" : {
      "id" : "sdy_6X6oi0sS7C6PyoCKOrzAQm",
      "project_id" : "pjt_4tro56y22TVBcz8Xq2kIaN",
      "name" : "yB4zZMGiCp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1gXjniFG2iLUFHRj96Fe6p",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hHGboHDdIH",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2MCDkzVUS8ahsoFOZJfMNj",
        "name" : "pHCbwvz9Lp",
        "email" : "nxk5y6Ri@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1FvobI07eDPdHv9pHuMSgl",
        "name" : "2UeHXvkhKW",
        "email" : "qNf7Wl9Y@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:34.727274Z",
      "updated_at" : "2026-08-18T14:36:34.727274Z"
    },
    "animal" : {
      "id" : "aml_4EuxWrkWIarxMLxuRtYzHK",
      "study_id" : "sdy_6X6oi0sS7C6PyoCKOrzAQm",
      "study_group_id" : "grp_5zI9tZ7yioknkcG1xc7ltI",
      "cage_id" : "cge_6TrMUt43CyAWPFDkH1C2tN",
      "catalog" : "A0000001",
      "name" : "OKzfSZ90Tm",
      "number" : 1,
      "strain" : "e6l4dgbcSR",
      "species" : "ChfvBisCZu",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "04NSBf5oOe",
      "ear" : "KELy1FUjld",
      "tag" : "tvybIJNCQL",
      "donor" : "hMOXddLpbK",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_5PEBjDtBCrHFaW6HsCR4Wr",
        "name" : "iR7zvKoz1p",
        "email" : "sYbCmeD8@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6ouiO8C4tjDhrejoe2DhcN",
        "title" : "Found dead",
        "comment" : "EMiSORx5GW"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:35.184914Z",
      "updated_at" : "2026-08-18T14:36:35.184914Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_3G53844gBNBcY77m2Z7wf7",
      "name" : "012Le Overwatch",
      "email" : "kqCL2JyO@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:36:34.697589Z",
      "updated_at" : "2026-08-18T14:36:34.697589Z"
    },
    "created_at" : "2026-08-18T14:36:35.406196Z",
    "updated_at" : "2026-08-18T14:36:35.406196Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6X6oi0sS7C6PyoCKOrzAQm/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6X6oi0sS7C6PyoCKOrzAQm/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_6X6oi0sS7C6PyoCKOrzAQm/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_Vy9vwOcZi1Rwp8RO5R3Uo/observations HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYmM4YzY0Yy1hNTk3LTQ1NmQtYThlZC1hZjAyMDU1OTg0MDEiLCJqdGkiOiJjMGY2NTI4MS0zOGMwLTRjYjctYmJlMS02ZjFlZGNmMjc2OWEiLCJpYXQiOjE3ODcwNjM3ODQsIm5iZiI6MTc4NzA2Mzc4NCwiZXhwIjoxNzg3MTUwMTg0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1VYdmh0dG9FZGQzOVJZNnM0ZHRBbiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.FGiX5GrlJpcjeaL_AMMdyhvZDuNtE4jQcpb8IPRgB0taDJL8lfQZDsuuOOoSQO4ve8dS5eRyzxoZAHENeb507ibzWT59z57DWBdC-SuS6DO9gwbcNaBpZ9zmCV-32CmJSrNYF1xDfkcPJ_s4dnQKoj2sDpDweqfrHPWI34DcK7Jc01sA3kT44gcGZb3Ubt-MS9Fx9LabAI7S-OpaShNfYx4uDjz2YUTdifBsuobhpNWBs2gDEp6N_9PyNrpMvm20IoQ9goLR1Z5FTgkF7aXgf-9s5giE3FC96hDfLIqNPBjf1oWB7Qd2YIABOAFMxr-3Gaa_aUvt7TjGoFbg7ay4sHAjX5o8qXnXe3hSikzFIHsLiiaqZ2ydiGkcNV8jIii3zyMEAdAxz2w8ziXFYDdbbApjHhmpbHJmgsJ0ARGK-YNBmqBATzkw2Wuk_1h7Fb4uKhmAdykVwVXBY0SB3iVy9UFVKQhsK6zjRkFvNLK8XC__Tnenlfmw2P_aJhzmsMOAo8RvG98DEml7gcP7Ji9ecembugLxGkNkP20hkH38PueMpIaVcY6jpLjGoO99l5Nd71hVWRJg5jWpLKi8SFVuERrNlvXlmW3mCzAIxvHkurrBrt5D_NcUxS4Vn9CowHZQPtIdNrtehHJ5PJdmEQYPHUNHiTCewxKY0IOU0BG8eQk
Content-Length: 85
Host: localhost:8080

{
  "observations" : [ "obs_1QXHTiYYqascsETJB17nbK", "obs_7MJum2J6xc270dxDQqtod4" ]
}

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: 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_56XNMZLJ6GSl4cxlR2Q6B/planned-animals/adf_6xrWRu9FHSOfMsbG3HT2Mz HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlY2FhMDE3Yi0zYzBhLTRhODUtODk1Zi0yZTFjZmVlNGY3MjYiLCJqdGkiOiJiN2RmZThkYy0yYjVlLTQ2NTAtOWFlYy1hNWFlZWU3NjhlZGEiLCJpYXQiOjE3ODcwNjM3ODcsIm5iZiI6MTc4NzA2Mzc4NywiZXhwIjoxNzg3MTUwMTg3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY5SVVuVjhxenlJS1JtVTVIMG9ydWIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lm9h9PBmMNXj9Czad-2cCcFbTczLjw9uuNpvY1unRftmayuJ-UiYzD_t86bRZaNwnWp9eM2ubKm1e1VQBH-s8_Dq1n4nD071qVBeoZHWW34p7z-bMaYgF2MZT2HIPscKaU2ycSfGziPsntBh_T0YasiuO_1IIqf_QoRT0yeEBIFJxOK0Ao3hZ92y9erk4NITDUbn9lZfaZTokaNpOMEp8T18Xvdnu3GCfBJsXKdNtaBub1PSSs63ECJ3PYiuFkY3j7roTkYMIm-Vj2iljygA8f7JpMRonCrmI9wW-b-3M_pyR3RrFgsuGuBdrtAxeuRy9v9FglZO4Uk-WMBWsdNAXIv44TYk3Qf5vuWnTaVlujNkGQNUtw1EgnxlWF0KqXQ_CL0Q-pX8nEC9qiTkxVDOepb5SvE-tW5CfPFEsi9IrBDX5HsGUlnipPYYTQ0lDtIodHv8mSG1t6mDEvdunSK7YSRHXEpB-0rnBUKnbEG2Q59l7q49kaGcrLUOXCr05caocD5dY1m3ijLCnDTGYvNewIuTlvaMbs_EmRo8IlqDShTbPBJxpvV3DvsP5sqSmh4mUaC4uHAP7tDlSu7T4Sd4cSxOaCaO2R01w7Wu8r7YziPxLOPEbA0ofmddoO73J1Oc9oaf4wJdJ63Vc6lWqU0emDw58bcZ1FnmMCby-fseyUs
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: 1681

{
  "id" : "adf_6xrWRu9FHSOfMsbG3HT2Mz",
  "planned_id" : "1_1",
  "strain" : "6RyREPYXd0",
  "species" : "pvAf4V5YTu",
  "sex" : "f",
  "metadata" : {
    "zdP4Cl2nEo" : "ABC-123"
  },
  "animal_id" : "aml_6cJM9ITIxB9lUnH17glr83",
  "study" : {
    "id" : "sdy_56XNMZLJ6GSl4cxlR2Q6B",
    "project_id" : "pjt_K3TM0SxSCYaPwqwSDmqom",
    "name" : "JKhWkeR2G8",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7YixgyM93E0kymt2jkR6SM",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "1wnf7cdNo8",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1zX6QnMRQQritFzHVtGlss",
      "name" : "twlwj8PcVP",
      "email" : "YfAa4BuO@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4BR2CDNxC0PLDrQwLdT4j8",
      "name" : "00SK8Qv8h3",
      "email" : "srbun0Do@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:27.209642Z",
    "updated_at" : "2026-08-18T14:36:27.209642Z"
  },
  "study_group" : {
    "id" : "grp_4mqlWmoFQi1dUUOSUEetP6",
    "study_id" : "sdy_56XNMZLJ6GSl4cxlR2Q6B",
    "name" : "AZddi4OjhT",
    "no" : 1450476947,
    "color" : "#a997da",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-external-id" : "GROUP-1234"
    },
    "created_at" : "2026-08-18T14:36:27.403327Z",
    "updated_at" : "2026-08-18T14:36:27.403327Z"
  },
  "created_at" : "2026-08-18T14:36:27.415309Z",
  "updated_at" : "2026-08-18T14:36:27.415309Z"
}

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_5csPzg6byHIAEqIgFJQCap/planned-animals?perPage=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNWNlYzIwNy1mNzY4LTQxY2YtOGFmZi03YTFlMTJlYWY4ZmUiLCJqdGkiOiI4NTBmMWNlZi01NWZjLTQ2NzUtYWY4Ni04OGQyYWMzMjA5YmEiLCJpYXQiOjE3ODcwNjM3ODcsIm5iZiI6MTc4NzA2Mzc4NywiZXhwIjoxNzg3MTUwMTg3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRPMXpxSnhRaVNkdkVMTlY3S2dWamMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.b3diwTV1nRXWQL-6-e77labypfb9j_A0gEZyoCxSn9TlvzW-vvpjWk_orr0BUPgTj_ZAHPZYgMJ3ltFV5qnNJK7VbV7P4jpA8viWZ8h4VmT7W2e1qh_fI6QLdpgFAw2OJNTGzm8xpS5G7MMBzBX4Uq7RGSDkX4ILc1F3-y3Qve42T90AYBbEnsYktS5qW81vqU8CaGpMIJQdf1VWaCi4b9z6aiY9fz997Z9LGMrxM9GviHqmlcl0Ug08rBPCy2mvsO2vl1Buw_A0m0jp_tr7qckJS8YrA7S3IOFl_y7Pcf1k2s2kgddcyzTXkZqsRBhjxVpzK1da7jeTZgviwHwt_XifM6e69tqEZoVhwqLC11DtNVoLf4akH_rvtpKE9tAq8_aUWHw8bjRpbAZhcUKP9z02SoLGyI7kmOwCk8toLmBd2BT_6eTrSKCHMPk_TFp7C-cj-AMCzbaXCD2_R1RQ0DYVZB8SdZeOgh1cgvhgQtLqkiEPgyynLQn-YhuWfGB2woVhnWqMIgiZHiqG0ihniX2kGC06i_dPiG_uWpNn9Tkca2WdKxYdCE9POmeXbew6sG9MfeOd-wCa2dwRyVmlGC2VHCKZOZ-oki1tExLZdBknTQJSPUuU0fiha4qfWFU_skQ-i1e2l0-50lIzoEW5AeP4m1liSs5o2v0PaInD5yA
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: 2341

{
  "data" : [ {
    "id" : "adf_4JA7qfTGXbfFDZYRD5A3rN",
    "planned_id" : "1_1",
    "strain" : "iLkdRaMGqw",
    "species" : "IM6sbqpPiG",
    "sex" : "f",
    "metadata" : {
      "lVy0kOe6yU" : "ABC-123"
    },
    "animal_id" : "aml_Zj9CeztlwrcwFAsDxIPy0",
    "study" : {
      "id" : "sdy_5csPzg6byHIAEqIgFJQCap",
      "project_id" : "pjt_4FJMCizWm3g6nOsWA0ygHx",
      "name" : "eoOWzUUvyK",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3UBlJ3vmO36NIsZ8h3OpnX",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "1BABZnFufW",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_33j88BDq06BIH9rGgoLnXS",
        "name" : "e6bSTQSE8S",
        "email" : "6tRO2dVS@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1ErrwV0iBSL4k8vRmPrjJi",
        "name" : "nScxrbsH0d",
        "email" : "WdGLcPsD@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:26.115354Z",
      "updated_at" : "2026-08-18T14:36:26.115354Z"
    },
    "study_group" : {
      "id" : "grp_5vQ3mcmM5weJ7av5Vsof8W",
      "study_id" : "sdy_5csPzg6byHIAEqIgFJQCap",
      "name" : "Tw0LvOXPgZ",
      "no" : 41599282,
      "color" : "#5d1fc4",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:36:26.552707Z",
      "updated_at" : "2026-08-18T14:36:26.552707Z"
    },
    "created_at" : "2026-08-18T14:36:26.788783Z",
    "updated_at" : "2026-08-18T14:36:26.788783Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_5csPzg6byHIAEqIgFJQCap/planned-animals?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_5csPzg6byHIAEqIgFJQCap/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_5csPzg6byHIAEqIgFJQCap/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_285MAlhPh2vqeeHx8dt0TV/preset HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZDg3NmNlZS0wN2FkLTQ1YTYtOGIzZi0xYmY5MjY1OWJiNjYiLCJqdGkiOiIyNTYwMWVlYi01ZWM2LTQwNmQtOWM3Ny1hMzhkMzg0NWRmMWQiLCJpYXQiOjE3ODcwNjM4NjAsIm5iZiI6MTc4NzA2Mzg2MCwiZXhwIjoxNzg3MTUwMjYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzV1WUV4V1JoMTJFcjFqVnhqMnRaWmMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.X5azrVig0TVEsMAggCG7p45uUFZRI91YLVon-7wmIeEC9b5KyYUZiDoIMkbOO-EofMQw7dnrdRibtyTrqD3QBWkoZUP3_5w1-kW8gFYgHgp-m5mebKS6m0aXByEpwTPYJ6mdPkmEp2C5X-VKlvgnd0FwC5A-qIQGmbhUZKT09XLD_TBYPaXr4kXg54QgDiCf39f0F2vqYF_pA1b2chkwQuNKcwv2jjeik2t6tWa-vZhh9ha47bq7_c0YWs0pZjaJ142Y9xJZg5OOTY1OCuGSGNEOA5LUuCDAfXWxaRVfRjQPQ4ZhbcAK0KJpplT3b4KCby0o0j_-iAJL2lMsb-vYfnXljcABkG-oJSUHopNixC5nD4IWebNH68ZU6apViKxQHN4-E_VBaAT9IrF-PGUAo2LX5LxsN37IH9Q7R1KalmwvZjhX1essHMBXONynkvpIpevJGKZ_SCkx78rUJuBZjaSL4hv-zYfMX2FzpDqxcR-mMQUyc-Ll52IZm9RRbd36MPwPfYbqcJ5Fcht0ZKpL15PmBBIT8VOy4YGF0z2Rqg_gqacEOOguaXg4EmwLtGxWtDeIGt5tMp_WPDNFEZnnGuPtKBLQvV_srXkbRJkVeQCEHjhRSSap-rtXzVLlCXf3N6RbdXPDwtiyRTgnDNuXTaRzhzwSKNFYCUo42_RFznM
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: 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_285MAlhPh2vqeeHx8dt0TV",
    "project_id" : "pjt_2XHqaput7Q4lgUcwoH66TJ",
    "name" : "wiMIDDL72k",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_61VSfpYXlbil9VLibHcmgl",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "RHXivgZNgI",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_2HjtdffVxw0Od4hs5Hwhw",
      "name" : "LUuhDVAPpj",
      "email" : "TAhfb9Jz@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5m1bIMARYXNNCq2v5X8hZT",
      "name" : "uaIPvtzg49",
      "email" : "Sjdqk7Xo@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:40.572367Z",
    "updated_at" : "2026-08-18T14:37:40.572367Z"
  }
}

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_2cFFPrwyLtqF9LG78iUY7A/requests/req_PMok4y5Ca4B06ioEks6Pz HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2Zjk1YzQ1YS1mMWFkLTQ4YTgtYWNjOC01Zjc4ZjhiNmM5YjgiLCJqdGkiOiIwYzNmZTBiMC02MTI2LTQyMWYtYjhjNC02ZjVjYmY0YjMwZDMiLCJpYXQiOjE3ODcwNjM3OTIsIm5iZiI6MTc4NzA2Mzc5MiwiZXhwIjoxNzg3MTUwMTkyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRSRk4ydDV3c1pTTEZidHFuUmNSSnAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.Xpd5i3IRaN2JGZA_lMOrKLINIRdaHogmgwHb6Q32UoighmqufnXIG62E8dq-UDFnDuXsRvXAff6rPpOqFGegM3a4SfzTezH-vhrX3trFATE5RAxLO1PSLZUcSK2Da6W8-hXVtKBwmquTnLIANhaGoz-TvTHFMdnRoNEU-RyxjcCqmHnla3dFunHyfXjyD-AenANOGu3OSmu_Hrw4slaw3EETnc7DvQNH0DbHUlaDrXRKBrmsF5OKh0vtiVJdkKz13pfnZ3nkyK3jGqdWKoCKHfHg4otY9CsT_SBGzjDfEXp5cDB-JCaVKXHTxPRWlUepxtrBX11RHH0wrc0ZzhoUNLsFDkZEF-jGMpq0BEUVzEFgSIPUz_8VtdTSJKL1CVCcUow5Ot2wRj5INOD4lPDkIhINlgyP-KzF_aDhH4QEyH5RHGnF6L7VWzr1oIxZ0beDPAGryJeoHEOM5NIVB1_Gu5v-dNVvHoTQszO8EaC1s_5bNCbFsQinL7A9sx9a6KLloLv7SmqpxfQtaOWLpOlz0sf9iOZ2Q27LbbXznyX4mwVlG50QSXYJlBIvxmsfNaKc0mWcpg3ouKGU2Vh9r_DRhZ-xo_HxNNZD1XdilMc2SIbcZQlK_0Pb5iJGbYkdd6HiOzWOKbDoLimkrYoWAWX7kqPI9sEypiMswGSP9akf1Wg
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: 1449

{
  "id" : "req_PMok4y5Ca4B06ioEks6Pz",
  "user_id" : "usr_2qwnstgPDdSr4R9iMWyYN4",
  "assigned_user_id" : "usr_2qwnstgPDdSr4R9iMWyYN4",
  "status" : "pending",
  "due_date" : "2026-08-18",
  "groups" : [ {
    "ref" : "gDrtaoleYk",
    "label" : "oBU27CVgxq"
  } ],
  "fields" : [ {
    "group_ref" : "gDrtaoleYk",
    "label" : "e0anwN5g5U",
    "value" : "lOesjROQMT",
    "options" : [ null ]
  } ],
  "study" : {
    "id" : "sdy_2cFFPrwyLtqF9LG78iUY7A",
    "project_id" : "pjt_3rJkdVPyl6kzf0Omv46f2F",
    "name" : "q9TBcNbzKb",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5X0SkylXHifZ1yuBCtyynt",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "o6kHGSyKC9",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3YP3PbXGTaVOlE31KZI9j1",
      "name" : "p7WJpL4VZW",
      "email" : "T7088NHo@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3NWrXR98fO3MqYkuwXvSA8",
      "name" : "c5OZQW03Sg",
      "email" : "7qZRuLpr@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:36:32.398396Z",
    "updated_at" : "2026-08-18T14:36:32.398396Z"
  },
  "created_at" : "2026-08-18T14:36:32.541405Z",
  "updated_at" : "2026-08-18T14:36:32.541405Z"
}

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_6g6PLwWsXLJTTL4OpRn9YH/requests HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2YTJlNzA5MC03MmZhLTQ1YWEtODk5My0wMzk3NjJlYjZkNDYiLCJqdGkiOiIyMzFjODAxNC1kMDAyLTRkNjAtYjgwMC1hZDhiOTZlN2U1YTMiLCJpYXQiOjE3ODcwNjM3OTIsIm5iZiI6MTc4NzA2Mzc5MiwiZXhwIjoxNzg3MTUwMTkyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFZcmxYUnZadGo1eXRkT2s3aWVWS2siLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZYhqwkP6GVwZhXd-TBmStBNtt2-Hpg4sTSn0gUlduPo9bEipRRohycR5I9l5dZbHEgLSg7ArfGy3qQL_PSgnKYUNxDw0DAAXnUhMtN_bOHHvmSWmDADlSuXu-ImM7q2QznbyPPgJd2IeeBUMkQ5VPa_6MvyunGds6voIH69Psyj2yqJ9c1pB99KWkD9z5DIsMSQzfa1AqvHljiduU62N0VLuIs8dLtWREkoR3Qd_6O7kao6f5oc_qXNJ-qQQNBkDxyU0XcrOtYz9W7OT2keT7a48m49oRi4VzcZ2_-qH_75ucUY0yRL0n1V7y0Rq_dWGuTz3epGDbcrpRi93XmWtEyVB4UysJ_bxu7Yje9lAQRsXMAWoupjLIQHnp5CllRQJ4eVZ5TcoD7sbE8tAUDi257BTxGsKsqz8m9vITy7l84SKpW6RpN7NsofSBhdh6JvLtMM7SLOBWYRd0oMmq7ydjio31HW4NnNcNT-53rNnmB1fu-qmlYvQ9JY6KqmDAw7V7GmmxA2-rIsS7ia-ou-_s4idARI62ymX2OvRrBak8xUoYfk1SP3S0jj2urIDz2JcoMCjamChmZV7rYLkxC2YHwi3FxBfjXcSvx6PZPH6bwPPGNPWyHdXi_C0oh3bGq-GEX35kz4gKClruy-CcTxZKjgSCcpfw54q2AH6FCxYA8I
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: 2058

{
  "data" : [ {
    "id" : "req_6MdeqYbbyQ90L3aOfEGLya",
    "user_id" : "usr_2eEGNl0O5khiA3MN6vmQqX",
    "assigned_user_id" : "usr_2eEGNl0O5khiA3MN6vmQqX",
    "status" : "pending",
    "due_date" : "2026-08-18",
    "groups" : [ {
      "ref" : "S3OPOz1H5j",
      "label" : "jNNgyQKZeu"
    } ],
    "fields" : [ {
      "group_ref" : "S3OPOz1H5j",
      "label" : "EYsdHjBqpE",
      "value" : "uRHhX33khg",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_6g6PLwWsXLJTTL4OpRn9YH",
      "project_id" : "pjt_66pYq5mEprSgVqnf1iAJRN",
      "name" : "FFAar6Wq6L",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_30VVoL0HhzQo2J4g4Giosl",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "kdZCFlrWhO",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5jULMMyTfkF7pp3mLxOtm3",
        "name" : "YeaJgKI6Ll",
        "email" : "Th4fCl3K@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6XYS8AYB0QmMs7kky9KqBz",
        "name" : "IECYCBQw60",
        "email" : "Yu64oH2z@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:32.084395Z",
      "updated_at" : "2026-08-18T14:36:32.084395Z"
    },
    "created_at" : "2026-08-18T14:36:32.248489Z",
    "updated_at" : "2026-08-18T14:36:32.248489Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6g6PLwWsXLJTTL4OpRn9YH/requests?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6g6PLwWsXLJTTL4OpRn9YH/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_6g6PLwWsXLJTTL4OpRn9YH/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_6KMNrVZDNrU6IBkl70ipMk/requests/req_dVlkNrLqn3piZPiuVm81i/samples/spl_4OXMQKmBaZZyFzxiPfTt7P HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYWM0ZDMyNC1kOTg2LTRiYzctYjViOS1hZmNlMDgyMDUzOTYiLCJqdGkiOiIyZDdmYWIxMy1lNDU4LTRiMWItOTgwZC1hMzIxNzFjZDU1M2YiLCJpYXQiOjE3ODcwNjM4MzEsIm5iZiI6MTc4NzA2MzgzMSwiZXhwIjoxNzg3MTUwMjMxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdiZHcyVHRHMkFXN3EwV2tqMjJ2cGwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.lfroLXIqRFii4e8vrrJOdsEOahhBDCXdkI9O6adgNYji__TvgoY8YQgcBup3a11J_Ix2Shnuab-ODScoms_vGjaN1Gzvzx19QX9GOK7NrFKrin8K2oYSUxwH_NJoDxlqXThsxQcbB3XiwxIpdRQZjgv64V2jIBHcRaqS_wrQoehXekjNJTsfn_r6b_IarksSR565k-s2wBknHxKL91Zay7TGfxMathrDe7z68mdUkS6QrFRF_1Fu_PocWQ6iwRwQTtojESxAYYHhJMqlDvMREyT7kXBJ3yhUcD-nxa-ocVk5qlzpxOjruQiqYTfK89syNL_sYHTCl7F81JDIoITniH6UP-iiJcFeef8f7NrXHU7YZnak59SrM1Z4uwpUCIDX0EUn-T_5-fopJUhdtwKtcvnr8-QfxNPqqMR0pm0ctEAIRMCE8fOeFO-pzqVvMYrLVmiDPGPTa0Ihbh0vEzBeHLdavrfBkcrBN7zXNENbnWFr6ZxljT5jHedIcejQo60HRvaZ9hXua36EDU-sWZmSxRlLeWgFUAxDJqqXuh6AQi04mbvIUy6WRhg52HEwEbKS-K6ZB9_KslX89a2Bc0dXxBiGDaXRS0pKndPXZZmK9tjkorrzCUlAm29m8Ifrd1PSRXBBcgLwhk2RCgIhak-8m7UQJCyI-9blikqHCQUYn0U
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: 2959

{
  "id" : "spl_4OXMQKmBaZZyFzxiPfTt7P",
  "sample_id" : "S1823450784",
  "sample_definition_id" : "sdf_3gKvCQ45RUn218TxmIwYeu",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-08-18T16:37:11.216602Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-72984919" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_6KMNrVZDNrU6IBkl70ipMk",
    "project_id" : "pjt_1rMpI2tN4tpEjEySQNWiej",
    "name" : "p7f3X8p0JL",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5maKHJMx7xwMkHAl2W05vW",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "dFWD5APOaw",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_1BV2kd7fKzuOYbPtT346vE",
      "name" : "x4hka67pEi",
      "email" : "xCgu9Ja0@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_758KQeG13B3JIJT2uQuUd4",
      "name" : "S0Ap8sLYQz",
      "email" : "wLL5wrsG@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:09.827416Z",
    "updated_at" : "2026-08-18T14:37:09.827416Z"
  },
  "animal" : {
    "id" : "aml_heDm9CcxWOlMCR79WEc4r",
    "study_id" : "sdy_6KMNrVZDNrU6IBkl70ipMk",
    "study_group_id" : "grp_2lQ7QZ1kLVrmEPBykB2cyu",
    "cage_id" : "cge_3IrjEgJWq9xFUph2NVBE1w",
    "catalog" : "A0000001",
    "name" : "M8Vb5l8F4Z",
    "number" : 1,
    "strain" : "ir2sJcCItr",
    "species" : "N50slc3UAU",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "Yh4WSDXS4G",
    "ear" : "ZJT8Z0R94k",
    "tag" : "Cs0fr0GVWv",
    "donor" : "VDVgY6kjnr",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_6SXo3Q727PGh0FvyxaGS4Y",
      "name" : "2Rbdkr0jaP",
      "email" : "NmbgOmpe@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_6lnsuyEx0FQc6Zzq8STvM9",
      "title" : "Found dead",
      "comment" : "oA2SePr4cB"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:37:10.352280Z",
    "updated_at" : "2026-08-18T14:37:10.352280Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_5MoV0jQpVvCk9w7RVCNsLU",
    "name" : "kFEQ5exMxB",
    "email" : "IvsUDufl@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "YemTeZ0mxE" : "PMDqQQu2Wq"
    },
    "created_at" : "2026-08-18T14:37:11.195328Z",
    "updated_at" : "2026-08-18T14:37:11.195328Z"
  },
  "created_at" : "2026-08-18T14:37:11.216812Z",
  "updated_at" : "2026-08-18T14:37:11.216812Z"
}

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_682ucp97Y0Afydj4R9vZQY/requests/req_1ooRzWVAPiUacY3X6iffTc/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZDhkY2IxMC00YTE0LTRiZTMtYjY2OS1kYzk1Yzk3YjYyMzAiLCJqdGkiOiJhOGIyNzdiNy00NTg3LTRkYzAtYTgzOC0xODAwMWQ5MjVhYzMiLCJpYXQiOjE3ODcwNjM4MjksIm5iZiI6MTc4NzA2MzgyOSwiZXhwIjoxNzg3MTUwMjI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFhS3RaTWFJdW1MVDVvYU1OMnNKaWsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.BtlIKddmDcnIzoVIlMOeZGv2pwiZBuNP1zSu2h2qjIvJAEzpuuzuBOJjAyRd179_lyE-o2mSrCrXpNgoV-JBBTLnfioHDizaXWt8Suq4KCzHWNfkv4PUlpPM7DODfiF2wF5dRLZxCZQ3IndoeeCA_l3a92v3l8gOEpTKyahNgN8ys_Duo1DnmXH9z0B0kHHZ-MKD3vKh6PkooyMMQMVDCYv1Jx_ztRtwj_YTeYUP0FsEUFzS9Xx7B1X6aP3ReYIS9CscdbsZFzw_ZMLxKgrrgXFXDDgZLebWesP-r_VE8mb3j_mT1YdzK9ou3Uk3_vU8yiVKiql8-CnlK-QcbEqbjhvI962hhLuTfXB6nF7uJFX990hD7B_oCEOnI7NtpG8L1p08-bPbQo55jdC1rZoYVHcinhu9GKQB2blymG0OoMB133qBCdlwzo3L1nfxSXIdOpaOyO0bpms7pyY24mFz4zax0VmzyUKxVBgst6ygAmTvoPstlLy-hGA46SQQ5QoW117lMeW2jaaxhKAqCNiW_9FAFt9NEJSdTayycYH2_YcEcZ8_Nik3rFj8bN7S4xxfbL_2gw8f1AGb0xZ137E6lfjTJxOs8G3mLQuJback2xwdz14KGmRpXivLayfacN8Wbo-VIsgEHlOOfLj4wNIQSEtZ1XmTMXVDW7hPtDR3pgw
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: 3776

{
  "data" : [ {
    "id" : "spl_6ObLXx6Dlph1SnLE31ItQ7",
    "sample_id" : "S1407915691",
    "sample_definition_id" : "sdf_3HuQlIyiwImypjFvKRrSia",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:37:09.358500Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1807789665" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_682ucp97Y0Afydj4R9vZQY",
      "project_id" : "pjt_7EfCFA3FGvhLtI92v7b7Si",
      "name" : "b8SLqo0WDG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_m1qLjqSiiTYhMGP6C4mpq",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "YQlAP6LFvn",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_29lxxfKcGEEjUmGAWzK56Z",
        "name" : "ghvG3AjcmI",
        "email" : "YugOZLcz@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3ogZ1NZDYIo8dRdEMX8VzK",
        "name" : "UaOSdPk8pz",
        "email" : "ep5KUJXT@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:07.983374Z",
      "updated_at" : "2026-08-18T14:37:07.983374Z"
    },
    "animal" : {
      "id" : "aml_2iLosDLFq4jQ01zqMqD9AK",
      "study_id" : "sdy_682ucp97Y0Afydj4R9vZQY",
      "study_group_id" : "grp_6cUE9q4FZLJeHlbX3nhaC3",
      "cage_id" : "cge_3MnYlcnKVLQkih8OCN9P5P",
      "catalog" : "A0000001",
      "name" : "An45qFwaSO",
      "number" : 1,
      "strain" : "GRmMpTnHiL",
      "species" : "KNtJioASD0",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "Y4SRVGz2ch",
      "ear" : "JH4dMQ4hBV",
      "tag" : "1KU40tVQNx",
      "donor" : "DFtleaUneu",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_47a5fKXCi8YRLosRqrSTPh",
        "name" : "ejxj2vn60G",
        "email" : "zl5ZceVh@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_5K8CbDTfdq9B3JZBr2AIPf",
        "title" : "Found dead",
        "comment" : "p8BfO97GKS"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:37:08.960055Z",
      "updated_at" : "2026-08-18T14:37:08.960055Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_2lVTjCh1GA8vLO8B7YHuMO",
      "name" : "q1xh0eryhj",
      "email" : "FMTeRlJr@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "WOCtqR38SL" : "EgBlRtWjOt"
      },
      "created_at" : "2026-08-18T14:37:09.335706Z",
      "updated_at" : "2026-08-18T14:37:09.335706Z"
    },
    "created_at" : "2026-08-18T14:37:09.358704Z",
    "updated_at" : "2026-08-18T14:37:09.358704Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_682ucp97Y0Afydj4R9vZQY/requests/req_1ooRzWVAPiUacY3X6iffTc/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_682ucp97Y0Afydj4R9vZQY/requests/req_1ooRzWVAPiUacY3X6iffTc/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_682ucp97Y0Afydj4R9vZQY/requests/req_1ooRzWVAPiUacY3X6iffTc/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_3oE43pBrZOlpi4hUqdB7IW/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MzNmZmZjNC0zNzM2LTRhZDEtYjE0Yy04NTA1N2IyMTA3NGIiLCJqdGkiOiJkNDRlODI2MC1hNmU5LTRkYzMtYTIwOC1kNDAyODEyZDQ2OGIiLCJpYXQiOjE3ODcwNjM4MTEsIm5iZiI6MTc4NzA2MzgxMSwiZXhwIjoxNzg3MTUwMjExLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNtV3M2bWI5UDN6S0U1VFI5UnVzcDYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.PGyFajA4IMob5g34T_CuW04dmRRqOtOsoKr-0HiuvOgfoNowjBGcjxv4eQ33nTH1B81swXTbrjTR58sHrueHGldvdLP1Yp-02p-sgLlk8rCoJyfopIi3MHe4StWYdVj1uBNbrUhQdbvSOS9Zmc72aS0-ltHYKFchMal85YkAzsDHig3WSBTSXir5krxdD_xmkOn_0LLY9_5phQafXFb77VPUkXCfuUeXbjWltR7rNQFhjQbR74sERPGxte6vc5CxHMA6Z-gq_Pg2oxdaqSgsKtL2jbscDN8TyHTVGNaNKMFHblDFu1cux3rwUqBIArNh-fg_6uTJ27wbwjmrR49WcIUasvdUOrA2kblez4aFPlx2Cu5YyfiqAg0bz2F7JJUNbxw2sF74aY-MM_HFt4uy5uO9pa01hZxeKxOiLKBvpa_bKvf_Rv7zq6Id5NE0smREImBJenqlk4bUFsT0vdoIrvOtBTWYReKs9imJ4Ke76mZPPInwLj1RqIH3enDlubgw536mYXs_y0UEghgKS9w97CFbKA2BKar3jiPT74OZwmb5OP5k3AqI4wf0CUzpYIVRICdvoDKlIuPW9x5b8Nzzm1T8myFQle1eGz0Xx6zICLTQ3szhpcvGM_s_4pYNi7Tc_jaT2pBH2fP3slcvUeBBlY9O3KM70ziLdQdr0UXOOPc
Content-Length: 386
Host: localhost:8080

[ {
  "animal_id" : "aml_1jmDvZ2MweM0Puv36KEnWW",
  "team_glossary_id" : "tgy_41skkQ37M0lnVcVQeclVqO",
  "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: 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: 2128

{
  "data" : [ {
    "id" : "spl_5WqsDDjg3o9PWm8lIwn0qI",
    "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_3oE43pBrZOlpi4hUqdB7IW",
      "project_id" : "pjt_7jHXjgDrJmZIt72Pe9LLVg",
      "name" : "mM9pv800YM",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1dJRUgeXnrMFNcgkj2HlBL",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "7BDLDFo9SI",
      "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-08-18T14:36:51.482199Z",
      "updated_at" : "2026-08-18T14:36:51.482199Z"
    },
    "animal" : {
      "id" : "aml_1jmDvZ2MweM0Puv36KEnWW",
      "study_id" : "sdy_3oE43pBrZOlpi4hUqdB7IW",
      "study_group_id" : null,
      "cage_id" : "cge_72F3Io7JBfPHkqg919XCrF",
      "catalog" : "A0000001",
      "name" : "odVTsY1mGs",
      "number" : 1,
      "strain" : null,
      "species" : null,
      "sex" : "m",
      "dob" : "2026-01-01",
      "tail" : "oGl72vcIAb",
      "ear" : "dKbA5wF065",
      "tag" : "BTqMdURsU9",
      "donor" : "0TresJPGc7",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : null,
      "created_at" : "2026-08-18T14:36:51.531452Z",
      "updated_at" : "2026-08-18T14:36:51.545774Z",
      "disease_induction_date" : null
    },
    "user" : null,
    "created_at" : "2026-08-18T14:36:51.691654Z",
    "updated_at" : "2026-08-18T14:36:51.691654Z"
  } ]
}

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_4ZD5lEikYHMYIl4ana7ILI/samples/spl_73fWDKuhSZaC93cGC1wCMM HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMTNhNjI5YS0zMTAwLTQyZDUtOTZmOC0xYzBlNmZkM2I2YjEiLCJqdGkiOiI3OGFlNjViMC0yNmQwLTRiMjMtOGIxYy1hNDllNzVkMTllZjgiLCJpYXQiOjE3ODcwNjM4NDEsIm5iZiI6MTc4NzA2Mzg0MSwiZXhwIjoxNzg3MTUwMjQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJoZ01WVHB4TGtJMjZzaTVoUDBwVXQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.SO1L5lkncWo8I3wbw8RZP9P9YCRxiLrmNrUuH6N4P6uyguc_vE4yM3V6skFgpUCGdTJGTnMmHpgsSEiLm_1xYvF8GKE2UjLPyHHnT4ETmKi4w3bW7-BkT6hyrsDtqmNQK1HaPlmaFCGI2-xR0O1WWe_gRcYkwCrdiKOFq9corV6GDQZxZaQ4TcqQM_xcCqVBcp3jf5HdaVNtMilHPm5UG6FZ6CRyeCT0FRY1mpO2l89dpJhBdh5EK1VSa_HgsJ42Uk86rkmYmG5pKk8FPEOb7aNKs3UA-vowxP6RSzF-BfbXfvGxrdQ4cQ61ytKnXldGkgMG6LbKduaoNUbh_q8qUHIwLS0iBCqnEjfwY-rQd_GG0RuN5UopBq9KGgFScftqxMIJTsVkLYr22mb2bmL4AVis618nwNUdNy8qCFRhfgwgCHW0wYfrdbL7eOfttyApc0Wjsf56Sj45kSiquMaYlzlTEWGeFQTtBcAHC1nZbACnrNvXJfy7kc0_7rYpvFhM7Kr3ENoR1mbSSUoDtkz0fzipvc6OBEFx2NjSTMGGEVpRXo5adsPSwQi8S1wMIaPU6HIDIJ2UHNnej199-MBFPLalHdaemqzqjuuoFE0ItS5fQ74Q7F17e9bhAk_mqViBT3cREzSEQOvNODtziuUca2odIbzBaO6cwBo-o2m7Alk
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: 2958

{
  "id" : "spl_73fWDKuhSZaC93cGC1wCMM",
  "sample_id" : "S120062841",
  "sample_definition_id" : "sdf_3wcWLpCbcYU0rQ9P8UYecd",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-08-18T16:37:21.721062Z",
  "details" : [ {
    "key" : "volume",
    "value" : "5",
    "unit" : "ml"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1607103424" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_4ZD5lEikYHMYIl4ana7ILI",
    "project_id" : "pjt_2StJdvUbJ2n3k6i69WOHrQ",
    "name" : "PvpAodnm5E",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5tk15dsH2qfbnxyauYq4Ik",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "QEBwICtY6r",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3vOhxS6cgzVsNmcMF011HC",
      "name" : "KQ7HJbCuw9",
      "email" : "GydyxSFn@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_PAou87M9yumsQkhCvaDlf",
      "name" : "1AhkF1EvB3",
      "email" : "eIFNj28M@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:20.993068Z",
    "updated_at" : "2026-08-18T14:37:20.993068Z"
  },
  "animal" : {
    "id" : "aml_dci2b8FBuGtf4qBBUojbl",
    "study_id" : "sdy_4ZD5lEikYHMYIl4ana7ILI",
    "study_group_id" : "grp_c8KZLTmldRYA5nH5zktkB",
    "cage_id" : "cge_3gEdzHEz9AqSqEHCNEnRi4",
    "catalog" : "A0000001",
    "name" : "uX2TSe8bVA",
    "number" : 1,
    "strain" : "ZhAKAwH2mh",
    "species" : "eUhDVkWhBt",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "2l7RI6vB8A",
    "ear" : "rueumZBvz9",
    "tag" : "5bG04TIpai",
    "donor" : "2kvx6HaxyT",
    "tracking_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_4otHG5GxoLswcTy0A8CPVG",
      "name" : "qUbZyKWspY",
      "email" : "JOwaSdsO@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7bpvjXNzRuzXJk5lgnjfIf",
      "title" : "Found dead",
      "comment" : "ijTikY4FQ6"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-08-18T14:37:21.386517Z",
    "updated_at" : "2026-08-18T14:37:21.386517Z",
    "disease_induction_date" : "2026-08-18"
  },
  "user" : {
    "id" : "usr_1JXtsyYAz2getMI3OkVAk6",
    "name" : "VhaUDTdyZu",
    "email" : "ht3qyTFc@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "DKNEudxRvv" : "KCLMrdtUVq"
    },
    "created_at" : "2026-08-18T14:37:21.699747Z",
    "updated_at" : "2026-08-18T14:37:21.699747Z"
  },
  "created_at" : "2026-08-18T14:37:21.721264Z",
  "updated_at" : "2026-08-18T14:37:21.721264Z"
}

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_5SqcHNwUmlMn6oyb7lH2rE/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMTg2MzZmOC0xODU5LTQ0MTctYmUzZC04YmIzZTUwYjUyOGIiLCJqdGkiOiIzNTJhN2FjYy05NGEzLTQyNjMtODY1Mi03NTZkMjdkMjgxMmQiLCJpYXQiOjE3ODcwNjM4MTUsIm5iZiI6MTc4NzA2MzgxNSwiZXhwIjoxNzg3MTUwMjE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNMOTFjVGtaU1FNTDF5VEJUVGVlVjciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.UUQ2ASqWCSUQy3yQOfwpiOiAb-XFxIryGuhGDDnQoU9XC0vnrPbOoPUQNQHP3gi_Ysn55onNzBRBuDzy3EDc_kkSbhUDJ7bz0rD-6uij990BAKo3Po2M4XLpklEnKKwD-hByKXa9gFVtDVjQ6zB_BX86Ymj4uBt0CkygWwcYVL-T-TbtRMPxC7Jh2bH81VaIj6t1yZNenLqJaROaHwHdj_K5iAEcUVEDnIp1HzuoGuFsffO5biskh4XEQTRz_8cwi0OaiwRZ3CjpKean7NW-kd6MUaGNnb9dSptTV2PjFhFdMWTLpVMiyqI48REu33i19SsS4ZPcRpQ9qFe9-YrQAGJFwvQZiD5BHFtqXG7BBXRqpMOouLuw3i5W2BJRKQ1yUILfFtW0QsMN_xbxeJx1DoHp_izSgRbl1TI_2rQhCUauoNEHROFvgLjZ2HwkNZQkopXqRGDO3tl9PoQq02tY7aZLnxK6aumCBnrto9tpbyJr0qmkXMLDH4fEMolzsFXJWQL_wH3Sx7WHRqEEhwRhhZ9H29H6-KU3mCQKqsnd5yDNyJPaY1TFS0_uW_q1N-a6tSiOc5vRKl0_bNjvrt8v1iZZMOJOsyC6yLwR7DUmmVLswXWqvgoItj-ZSbXQLAOZIijzuRgIC0hH5aruGSXgWw0uffB2Qkia6E0wjGqZ10c
Content-Length: 335
Host: localhost:8080

[ {
  "id" : "spl_1ct0wokvegRx1Ql3cmUEGa",
  "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-648642981" : "QA-approved"
  }
} ]

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: 3238

{
  "data" : [ {
    "id" : "spl_1ct0wokvegRx1Ql3cmUEGa",
    "sample_id" : "SMPL-9001",
    "sample_definition_id" : "sdf_3hZ03xXVBfJ6B2NolkGg3c",
    "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-meta-648642981" : "QA-approved",
      "sample-internal-id-1678060250" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_5SqcHNwUmlMn6oyb7lH2rE",
      "project_id" : "pjt_2cMPKdnE3KDAJphvIjAIEB",
      "name" : "eyt3vjmKAo",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4ya1ePOYWFBigUa1l2XVU4",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "OrEwFzjGYB",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3qL5AuWkgbFEpxbkozLeDH",
        "name" : "EQQTTEM1s0",
        "email" : "zmpYzg2F@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5ErhkstOHB8pBogUSs3hRp",
        "name" : "Mz8FJozi3d",
        "email" : "mG26hSD6@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:54.790781Z",
      "updated_at" : "2026-08-18T14:36:54.790781Z"
    },
    "animal" : {
      "id" : "aml_4XwUqBv7ruzerXXrb8VgBk",
      "study_id" : "sdy_5SqcHNwUmlMn6oyb7lH2rE",
      "study_group_id" : "grp_4SulKdi8A2Bo5fWzX9XaUW",
      "cage_id" : "cge_1T8zpbTw848kd5bB7FDqEm",
      "catalog" : "A0000001",
      "name" : "gIvG5rslm2",
      "number" : 1,
      "strain" : "lRF8d9jhMD",
      "species" : "snms6zFiVd",
      "sex" : "m",
      "dob" : "2020-01-01",
      "tail" : "FEUGgefeah",
      "ear" : "jAEJh2oexf",
      "tag" : "yrwFGTwC6I",
      "donor" : "otPAUhaH3t",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_2NwpIgXPvYlx2050HZ9EEz",
        "name" : "OJjhJnnzf7",
        "email" : "6H3tRs24@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_7VYJXc1HEXePfbMLonmJGf",
        "title" : "Found dead",
        "comment" : "41BclsgvAb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:36:55.170365Z",
      "updated_at" : "2026-08-18T14:36:55.719264Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4onmMCFVbOpGHqd9GQoqDW",
      "name" : "gLsxhh9Zia",
      "email" : "HHdKsptR@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "DGUVHXHQiF" : "IP1ZoGCAua"
      },
      "created_at" : "2026-08-18T14:36:55.666312Z",
      "updated_at" : "2026-08-18T14:36:55.666312Z"
    },
    "created_at" : "2026-08-18T14:36:55.701850Z",
    "updated_at" : "2026-08-18T14:36:55.821574Z"
  } ]
}

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_Wc9GZ1fmZ98TLxnnPT2UN/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ODNkOTVmMi02Y2JiLTQyMTMtOTY0My0yYzU0YjBjYjlkNDgiLCJqdGkiOiI0ZWJiMDUxZi1iNmVhLTRkOTMtYjNkOS1kNjQ4OWZlOGE0OTEiLCJpYXQiOjE3ODcwNjM4NTUsIm5iZiI6MTc4NzA2Mzg1NSwiZXhwIjoxNzg3MTUwMjU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN1NDlZNHl5MnczcVVxcUgwUmpvcnUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FuP4priv36ViIyEWIZhCNePq-BbJXlkfXeSnlEQyz4lqO52472OhImkqno8CGvaCr27gqpGFD0b5pK_B6xJUBuaizm9w1St05hG7Uwpxa2wBD8qBebfCk1IKMwO8npeqlpLol0C3qixf99vXRuSbtcDg11FnIsC5UV9GkGXdkRZzVl1lWR6jKzUtsIJ9OfCIF1sI0E3m1EbWoZouWu982rwViN0S3SnBTiX69DRHuZhFPwfZoOoBIlubNyjz3SumFlmnbGhGZ7NyLVvkrLSm1Jm5cuX9jSLS81EAe5bXjsNtC4tdJLWlASiOO8cNbKT4hOx_v4Hwm7D0vC18NQi1Jigj_QMUayfk7KKkSXaPY6NJA6ZyoYsVdhnbV9WvJ38j2NPxoDju1afZTtG-pnQovSihfF4IhnRfCpSO4Qks1qBpnZoqwA-Ylwaq6t91_anJmIBdgq47YhdcjWZB9L7y8-TWkyW0Vo1ldPwQ3sIrrgn91jFmZJMhl_IDGxnbgn7QTQjI-mO_4a8SrlHvODcLx6fK0r4pPvlWl93mByOVns1vnvcN_JbIz82Imj3OwRG3bpI2qYc-8Jp6XwlxAV3_a3bf7gl4BMUG3Z-7Vcjywg08FDQveuNfADihFeQobVVTC3F34xQ7MADHTB_KiIu4L1uTsNW06szt1qBziWqc-Fc
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: 3661

{
  "data" : [ {
    "id" : "spl_1jL6qHkMyIFCvvxoToA7Pt",
    "sample_id" : "S2023248361",
    "sample_definition_id" : "sdf_2mHssAj8iXVDpwKH9qaU9T",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:37:35.168067Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1730235885" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_Wc9GZ1fmZ98TLxnnPT2UN",
      "project_id" : "pjt_tf8YfyKuHRKPd1Yu2O3OF",
      "name" : "oF0QI1aHzi",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6j0AlQrE9LrM1og4Yp9y2k",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "RakgXngDx0",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2s9h0X68KNZ8gaLVRTmp8b",
        "name" : "Kgb5O9zrdL",
        "email" : "9oXjLLGr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_reGHowYUcBq7zrSqASmwm",
        "name" : "19Lkf44VNP",
        "email" : "2sRl1H49@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:34.350455Z",
      "updated_at" : "2026-08-18T14:37:34.350455Z"
    },
    "animal" : {
      "id" : "aml_xTeQHyp6Oj4hKgEeZVvDl",
      "study_id" : "sdy_Wc9GZ1fmZ98TLxnnPT2UN",
      "study_group_id" : "grp_2jP4OPFVMI6uLlVl9WQOqd",
      "cage_id" : "cge_4321l3kRlWBO2v52mhtypW",
      "catalog" : "A0000001",
      "name" : "7kRL459bUb",
      "number" : 1,
      "strain" : "3DTRHaXl7Z",
      "species" : "tXYQ8YlnyZ",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "PxMCHwIMUf",
      "ear" : "G8JD6WJSem",
      "tag" : "LMLJc1jPsM",
      "donor" : "snBTzGi4jx",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_4eJc5ddUpVGd51s7DK8FoK",
        "name" : "zZczeXfv7w",
        "email" : "P0f0lMis@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4bxKObuKvKaVZkXiJzn6mF",
        "title" : "Found dead",
        "comment" : "vjJ6JurcKM"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:37:34.838585Z",
      "updated_at" : "2026-08-18T14:37:34.838585Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_5f0OyTj4WQDAgVtlzkwxaE",
      "name" : "PWNcITQRmv",
      "email" : "e77VwWmM@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "MOhsqMdX7B" : "k3fiNFZuls"
      },
      "created_at" : "2026-08-18T14:37:35.149674Z",
      "updated_at" : "2026-08-18T14:37:35.149674Z"
    },
    "created_at" : "2026-08-18T14:37:35.168240Z",
    "updated_at" : "2026-08-18T14:37:35.168240Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_Wc9GZ1fmZ98TLxnnPT2UN/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_Wc9GZ1fmZ98TLxnnPT2UN/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_Wc9GZ1fmZ98TLxnnPT2UN/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_5BM6rlHQuYO9ytkru8ENt5/samples HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNTBiOGEwNC1mNjFjLTRiMWEtOTg3Yi1jN2ExNzkyYTE2NDAiLCJqdGkiOiIwNWIzMGZlNC1hODY1LTQzOTktOTU4ZS0yODg4YTA1OWY0MDYiLCJpYXQiOjE3ODcwNjM4MTAsIm5iZiI6MTc4NzA2MzgxMCwiZXhwIjoxNzg3MTUwMjEwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3RTWGl4Zk9GMkdxUWhjQ2lkSGtXNSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.XBFY_VCXBCCzL1MOLm54UmFOF2IxOQ7_Rp5uFgcED0XF5H4vcgTYIKEQLAda_5AlM2Wm4Nqp1Qm4WL2ysvztD0-9kVtmNDS5N75bnMprVcNld-WaZvJcgSBoh9-oqDOVfZZz4J8SdIhxVtAX8q_Qid2s32tBoLb9OOP-Sh18h-BJDeHg747hH2YejZ-EqxRced1Q2a1jwfFZagUNVntBUYZ3IQTEYCOq6u9avD9LHK6GwHyca5Dao1UMWpKi_NDniFhh_5GGZG1rY_jClNpt_pye286SYksbbZCOUVsi2FUJlouO-p7w8gYFVJgixgutYX3msY4TGcbeQtgmff-MXdlQcsF4OTzHGfFU5eXKR6u8rgECBYeUlAPUnE_g4QIB0MakrUKM6HDFW8YYVGo2OgywnpSqgyfHNmmLt0czOcWtQ2Mz8II8puTgvv9YK2vQSBiQ1S8AQtrXn21mtvz7j1Vq-TebPaJuZ_fYVxtjcQdfW8Ebg6ILyxPItLES602_9vpyq-g7JX6aTibnpDem6TFmA3lsKnaZniKLnuQuBBe3-MTRVl7ckugk_ZiggEzkoQBxnZiVQPs9Ds5ZcyZgiA-pOYd9jWRzU-DBaqObl-H51rgPoc1x78P-8qP8jKj22f4BqlBPIQ9ygBZ3jSSnp1ZgFu_vwm040lybrb3Qgn0
Content-Length: 80
Host: localhost:8080

{
  "samples" : [ "spl_5EZWKhXCFiEOknLXXf5lCK", "spl_5rUqw4bH5DVmNdoUJR6NOw" ]
}

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: 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_2crQ7GDiAmr7x0Nv91JUzz/sample-plans/definitions/sdf_4zjhdsPSEfPjsQGcGUofq7 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjZjNlODNjNS0yOGI0LTRlM2EtOWJkOC0wOWMyODdjMzdiODIiLCJqdGkiOiJlNjNjNjA4Ni03ZDEwLTRmN2YtYWU5My03N2EwYmE4NTE1NzQiLCJpYXQiOjE3ODcwNjM3NTUsIm5iZiI6MTc4NzA2Mzc1NSwiZXhwIjoxNzg3MTUwMTU1LCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl8yRDhKZ1J1ZEh3YWFqRkhhUGJDVjA4IiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.Kfqp9UV2ys3Me-0lpHfO_GRErkcsaKZniwiYQCQOcK55ZY_ahGMF0oPLc_akmTj7cnQ4iBFI2uIIOfqf0_otwSvEjGvSNgootSPTNVXa0Xei_kODqhP9Wz6ELUTlYx9Nij1lH3bnE99BiE0U9FLfuyjPsaQe7DWK7N_wt5q55wHwN8kW58Ea6JPYEzeIGjvM_3nyoL0t5A7jM9q6Jnf5z84zokfxTOzbB4e-IEdaM8JZig3ZY0nrd0VN_-5tU-gUNLbXfY0QFyiR0LQjPShvk4oA7U6w3ynK0EzKaMt4d6zcAuQrkvcmzbJRQLKriNBFNBFlDWBiFqaeRyIe5_deYYw5tlVTTZirLnzYD6Cvv1S4H1yHUwqSpF8hO3iJnv8YPBklxjQaihKgnj550PPr-xq_oBmlyjNlk356UFDFK3IegRQ4gOi0ACv3oLdobDBgPVsm2v1N5MWv7Lt92qyMV6-mmTjOzTRpMt2GSX4oFVADcDOUQ79-T3yig0FCVSTsAI-eFV0Y9JFU1UhY8JVHZE2a3bcj5k62_x-1IT7DxMw31NtTDYBPQrQMEFz_CjAoi2eHfuPpuNbd9ou0BXbIhAFClZ7mpFdPXf1YDseaLoi9sSzUrsmLNw1wgXzeArP1FpqR79LZpWPz7RFzFEznPb5o8yWUOcdRXq9xdQCJN2U
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: 1507

{
  "id" : "sdf_4zjhdsPSEfPjsQGcGUofq7",
  "sample_type" : {
    "team_glossary_id" : "tgy_6oC34dYvl6HDwCEsCKN7cj",
    "title" : "Blood Sample"
  },
  "name" : "Blood Collection Protocol",
  "timepoints" : [ "PT4H", "PT0S", "PT1H", "PT24H" ],
  "details" : [ {
    "key" : "volume",
    "value" : "3",
    "unit" : "ml"
  }, {
    "key" : "weight",
    "value" : "50",
    "unit" : "mg"
  } ],
  "metadata" : {
    "storage-temperature" : "-80°C Freezer"
  },
  "study" : {
    "id" : "sdy_2crQ7GDiAmr7x0Nv91JUzz",
    "project_id" : "pjt_5d4MpWdbScSOVYrBUYAaWn",
    "name" : "S0zzUFivVc",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_39fujyAyt7tCpdj3YkQy4s",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "RhG7S48R8B",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3YXlxSBvvEJOshSg3Vy3Fz",
      "name" : "J7ne5l2fIv",
      "email" : "tgAXwJrO@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6C9RKY30VaRWoo5N8HgnGM",
      "name" : "VmQqiXUfoG",
      "email" : "zS1l876L@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:35:54.721629Z",
    "updated_at" : "2026-08-18T14:35:54.721629Z"
  },
  "created_at" : "2026-08-18T14:35:55.499965Z",
  "updated_at" : "2026-08-18T14:35:55.499965Z"
}

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_3sutBlnMZvhy6vVt3sPykU/sample-plans/definitions?perPage=1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNWNiNzJkOS1kZGYyLTRlMmItYjIxNS03M2Y5ZjQxY2VmY2YiLCJqdGkiOiJmZWFlMmYwNC1iNmZjLTQyZjktODNlZi1lZjgxN2QwMjFlMDciLCJpYXQiOjE3ODcwNjM3NjgsIm5iZiI6MTc4NzA2Mzc2OCwiZXhwIjoxNzg3MTUwMTY4LCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl81endiUVE2b0V3cloybWtQZUVRWk9aIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.npOLq_bP-86TIKiuwo6QOjDrL3VP_SDyPlbuXcJMGeTDex51K96r-y6xlCHzGGA2-l6ZyFzff0bw2C5C44Kq0Ww-LXiPN_g_utdEKh6SEDDGnHCcNCmH-HV62UJg0c3A35FHdX5mHU3ThLu2tNDqfTIRFsflp-1CAR6XPBJyxptm71mlkl8jND7qNSz2yIzGeCaqXTCff4a7wt8tcMUJBxULH5e9I7O7jW0mJz7khfjkD3Kh3NSUXYZNuVd_VvZnC3V1clPUGwStGeG6RYwq8yyfeGolI4wNtY4JG8zDgH4I_BFbZc1zI7XxMpiiIStee1r5CvHQbCWI06s9GFcym6KzmVrTyDuzaeHq2A-Y58UWwOz9X4-VkQmaa9_oHPyMHiPdUXmrPSCRvHO_V_qDkcML_sc5HPvUxonKIsM6lciAlJRjgOsn6t6iESJ4onTUktQUt6Z1y8STm2X7c-8fBbRozAEPpb30bdFfDeNMCIuvc6fbgrnujkjzeGKswnzcREo0ONuuaT1e-3616dJQiwXBjWUs3VR2kPewEy4QJFTGhhq-jR0WiaVDewht8P3soi5q8vOMAkwagPaf5FyNnHEvvHYyiMb_sH1igIjFfzx9hIw5PQcxeLOz3WO-PZOm9QCcakLTf2JsFwK8NRpUlrmgahsLwwFYbQWtVXXs-sM
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: 2279

{
  "data" : [ {
    "id" : "sdf_5K2FfGXNP513MwXk1PwqJA",
    "sample_type" : {
      "team_glossary_id" : "tgy_4ezNHBQ4Y4VJF8H5Knf5FR",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT1H", "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    }, {
      "key" : "weight",
      "value" : "50",
      "unit" : "mg"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_3sutBlnMZvhy6vVt3sPykU",
      "project_id" : "pjt_6Uiv8S3yKJalEl4gCe3MZX",
      "name" : "AAORq7Le2y",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7j1rbO51jioXzglysSgOOX",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "VyXrmYCgS0",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_TNqrdAiUySQ64ssIu8wGk",
        "name" : "oBQPDPbkDr",
        "email" : "uaeRumoa@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4TPT5OBwjZmfdSKkPeC42M",
        "name" : "pZQvpmLWlP",
        "email" : "7HfQPhxD@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:06.839817Z",
      "updated_at" : "2026-08-18T14:36:06.839817Z"
    },
    "created_at" : "2026-08-18T14:36:08.000461Z",
    "updated_at" : "2026-08-18T14:36:08.000461Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3sutBlnMZvhy6vVt3sPykU/sample-plans/definitions?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3sutBlnMZvhy6vVt3sPykU/sample-plans/definitions?page=24",
    "prev" : null,
    "next" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3sutBlnMZvhy6vVt3sPykU/sample-plans/definitions?page=2"
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 24,
    "path" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3sutBlnMZvhy6vVt3sPykU/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_UaKdAnZqlCFfOPEMGzNHM/sample-plans/definitions/sdf_1OsA4wQdVqVhNMn8Tj76VS/targets?perPage=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NzIxMDEwNi1mNGZlLTRiMWEtYmU3My02Y2IyYzcwNzNjYjAiLCJqdGkiOiJhODRmNDA4NC0yMjdhLTQ0NTQtOGMzNi02OGZmZGFlYjNmYzMiLCJpYXQiOjE3ODcwNjM3NjMsIm5iZiI6MTc4NzA2Mzc2MywiZXhwIjoxNzg3MTUwMTYzLCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl9QNzRZU2NMaWlMYWtSN0hUa29qNzAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.LDbZyaESB7RBpy9hPPISga_7i4QQzktzgrK-yGe7aKHamNeduXT-NaPk-gczhBJ7j6aWmUP4jRibRfN2QOstm8k2nJ2ipaFVr4xf3xb0piJsDW9VwUyk8guxwbqoUk7xZkW3nCOhpylL33ixq-P1UhUkIr-yNrh9VCrY0e5edm593s6SA0bMXgDlaolBOJd74WHI-Tn_jgAsqJBfA02k1ZjVxT9ouQFEM2mQ4Xl-epbzFU4W8yI_RI7VyIRrW2e2s4BrKIx7hBUMIthk4p5dQeGmKgoOmGf6snXSWE2aRN63D3OW7TC3T4ZoOv3LvRXQYPtOn8cT1DLtcu4bNYvMQbMAjgLfZUqvxg1x3N17SH_yXJ5rHFEZ_j0eLF4-lRyTyRDjtdhwL5U_20uKl6wfGHWdEiTDuu71UC-Rc9Dxzon9Vxw6p6zdBmF_OB9TWHnPshnZg5qCj2ni_bT3eD91il5fqJswS3n3tawNfsiX2IyXLMzoHdCLUKdFJJpgU_0l3-FUCQL3BbLBnzOxO9pCLSRaXv6GYMWiOpEBDA0g0E0tTOEim6rL7KWr_cNjVz7M0d8wUInHvOrHsWdqMFkgN1p_gRQa_pAxcfrEW7WNtNOJwvCRjQa9rf92fMIPlQq5RW2_3nJnOpli5XlOKKSOZeEShpdaMoQzoF-B18R-ZjA
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: 2738

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_3JPSLPo2nG5VgN3mW9h2Fr",
      "name" : "Control"
    },
    "sample_plan_definition" : {
      "id" : "sdf_1OsA4wQdVqVhNMn8Tj76VS",
      "sample_type" : {
        "team_glossary_id" : "tgy_1f5WWnfg8sfB9WhmIsF4Gs",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-08-18T14:36:03.614357Z",
      "updated_at" : "2026-08-18T14:36:03.614357Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_BGhzftuZe9NaFoZvqZy3q",
      "name" : "Treatment A"
    },
    "sample_plan_definition" : {
      "id" : "sdf_1OsA4wQdVqVhNMn8Tj76VS",
      "sample_type" : {
        "team_glossary_id" : "tgy_1f5WWnfg8sfB9WhmIsF4Gs",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-08-18T14:36:03.614357Z",
      "updated_at" : "2026-08-18T14:36:03.614357Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_5WyyIjXH5oxKuowH34bIp",
      "name" : "Treatment B"
    },
    "sample_plan_definition" : {
      "id" : "sdf_1OsA4wQdVqVhNMn8Tj76VS",
      "sample_type" : {
        "team_glossary_id" : "tgy_1f5WWnfg8sfB9WhmIsF4Gs",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "value" : "5",
        "unit" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-08-18T14:36:03.614357Z",
      "updated_at" : "2026-08-18T14:36:03.614357Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_UaKdAnZqlCFfOPEMGzNHM/sample-plans/definitions/sdf_1OsA4wQdVqVhNMn8Tj76VS/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_UaKdAnZqlCFfOPEMGzNHM/sample-plans/definitions/sdf_1OsA4wQdVqVhNMn8Tj76VS/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_UaKdAnZqlCFfOPEMGzNHM/sample-plans/definitions/sdf_1OsA4wQdVqVhNMn8Tj76VS/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_2wNiCbX5DnFgUd9TuKug2l/treatments/tmt_1g7ZSyG4EpD6q05DIwVMk3 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhZTA4Y2FmOS0xNDUwLTQ5MmUtOTliNi1kNjliMGI3MjFjNDEiLCJqdGkiOiIxZDA4MmE2ZC0yMmM0LTQzMjctOTdmZS0yYjJiZGQ0MzNmNGEiLCJpYXQiOjE3ODcwNjM4NzUsIm5iZiI6MTc4NzA2Mzg3NSwiZXhwIjoxNzg3MTUwMjc1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFzMDluSXVTeUdnR3picVJKcG1UQlAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.l4awJ2aIAQf_SBfu65lzLy-CkRou9U6Jv9tBEEvBpzSpyRKRUXEOX4XwHRU0Ibpn-bDRkQXte9voT-Pb5m8QcBUAEFZTOFhW_N0pzt_-NyCQk9VoI5EWqjD9yHOTdc20txJt3zQKiJWqYtRY84zMOYprveqclHFUNUYIRjH2ca4QoqkyJgfsu1hdvpFKWfvnfDaVnY-HgSf4eW8RZRTaThWkPLS6bUMkBn8GlnFcLaIF0lKstcbqEROOoAZwUR1angCGFNwKbIJZloxFV64eMUt3wKpsWynZJ2iI0XaoEuPRv2XqHrZ61kNtbbBGNDQAecRFtWLOY7R3j-FGBp4GY-DQLgNTuU4Fd3sxC4smA8GozzIQZcUKz74n1MllV0qNs4BMbk03i5I13iTbkZoYHoQXSdfMYfgulLA2yfPjs0kv6hUj5aLhpa1JL_i1Tp9M5KjYdobCmDh7iQstAH1JaWu8C2wuvM_lHgOojzEw-SKn29EkIytfZyhYhI5GhAxz1QPnyGB3MqI6rBvN7t93CuITvG9ZISUbeklGauPovg2OMWyC8Dti9bXHZvo1_4pyzkUf0h0dVUSFp7ww6DwAK3DFP-Lm_k3_h5nv56rICfQJjCMvzn_F2lch3P6_rLrsQicYccHOhISALCBNBBj73qWKvT5VtT-sSeSSZse7FJE
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: 1750

{
  "id" : "tmt_1g7ZSyG4EpD6q05DIwVMk3",
  "type" : "dose_volume",
  "name" : "UmziFwIRPw",
  "label" : "Test Treatment Label",
  "external_entity_id" : "yLHZOixhWE",
  "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_2wNiCbX5DnFgUd9TuKug2l",
    "project_id" : "pjt_JJ6jDAs3QlwGzks19ncz8",
    "name" : "y1mDzpoPPp",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_7EFgcj0SfESKCyw1EfxdTD",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "4LV6RgQDCd",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_6tTJT6seZBm5QmuVdtJC8a",
      "name" : "KZqFOblQSx",
      "email" : "OQI8oBpw@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5DkUupkq4HJhzrOVuikdjo",
      "name" : "HKf51TQNF9",
      "email" : "qjNq7j5H@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:54.509269Z",
    "updated_at" : "2026-08-18T14:37:54.509269Z"
  },
  "created_at" : "2026-08-18T14:37:55.193856Z",
  "updated_at" : "2026-08-18T14:37:55.193856Z"
}

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_23fR921ysCrPBzsRfuYSFI/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmYjk0ZWZiNS01Y2YwLTQ0NTAtYjQwOC03MjRlYzVhNWY1NzAiLCJqdGkiOiI0MDI1ODQ5My0yYTYzLTQwNWUtYTY0YS1hYTc2MzkzOWQzM2UiLCJpYXQiOjE3ODcwNjM4NzQsIm5iZiI6MTc4NzA2Mzg3NCwiZXhwIjoxNzg3MTUwMjc0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJIV2JzWDdGZjZrZ01Yek9pdUJGbGYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.RZ7tmMOA02x7zIBscA70bZvg5nxwIsUOKgqgC25_wuh08WFUgCg7KhKIsTcFzOu1Q55KXYYwS2EOLMWL8_FbWcokU9vZ7hoJ3Zmnf-S-iaeywU8xoOabfnQF9jIsuL5ttDGC7UnpJ4WTEGG9USaxrqUeuHVLU2iHMjFoyyMBhv6mRvQYbbK_heuSC6W_9IyXXiugNUbYpEbHIYN45Fmva7gESi9UPWE4p8A47NbbTk9MqMPMmuYn1ZsdZ8khCD0_zJ6DIBtS8bDyqIXzRz5lbwCL8oaCJmyHCKXDkHX5pa67dTGmTP80FTBhZy-sVpBb-iuJlfFMDCSioVRjlzihE-scbvi1LF7k9abNATBsuU797MOJ2CFm2c8_RTJc94kPGNQYVzvxkufm_MSmYuJZqTJgjc5c6ue0-UJMvc9ZH2Zek7VV5lgBCk_qB9FSO5bSTnp6Jw8EP6dPuHVBUsyeMKmfJz6TnJWm7LEyYxcMY_E6_IDf_bjWRfoYyTdcaEArnSfG2MpwxYaNrajxcyYvbAIhV-Pjsks4N_a8vp4GRM4fE07Id8rae5LCYsQDDpfB7Rm8PgqJiH4cz-uAL4vnvBdv8hHSM2dqhnuG_yZRMRFT79E0pLUxmWwr88b_zSJiBwCvaknfEuaRGeK1LiYXzzNkHiGD69K6b7dhcpfZhrA
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: 2393

{
  "data" : [ {
    "id" : "tmt_5mZ34F9o0iASyJnHYAfjjQ",
    "type" : "volume",
    "name" : "4U4JF31BYa",
    "label" : "Test Treatment Label",
    "external_entity_id" : "nywIN79hgT",
    "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_23fR921ysCrPBzsRfuYSFI",
      "project_id" : "pjt_6VedeRgxV1k3DiAtok2Rnl",
      "name" : "xuAbxtsAFX",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_r1oFe7UsKvBdHlOk5grwg",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "Lu8IE6aJmT",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_3fC8UPCAiUbFflXgcTRLvF",
        "name" : "Tb27FUBqkL",
        "email" : "oTN4xA2T@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2l1XVcRXz6rsaQePwWHhoX",
        "name" : "JCA18TY092",
        "email" : "PYLrvLG5@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:53.598379Z",
      "updated_at" : "2026-08-18T14:37:53.598379Z"
    },
    "created_at" : "2026-08-18T14:37:54.224963Z",
    "updated_at" : "2026-08-18T14:37:54.224963Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_23fR921ysCrPBzsRfuYSFI/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_23fR921ysCrPBzsRfuYSFI/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_23fR921ysCrPBzsRfuYSFI/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_3TIXB82TJDX3HQhVwRKnwM/task-specs HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjA5NmM5Mi1iNDk5LTQ0YjctODFjNC03YmMyNzhlNjVjNjAiLCJqdGkiOiJjNjkxMzZmMi0xYjdhLTQ3ZjItODRjZi0wZjg1ZDRhZmZiOTUiLCJpYXQiOjE3ODcwNjM4MzksIm5iZiI6MTc4NzA2MzgzOSwiZXhwIjoxNzg3MTUwMjM5LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNGVlZWNwSUI1aTBZbVpRZ0I1bkRwTSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.NXBnp8_YqcgLxqA3d9RMOuUZq4va_QwWgEVzGc5pWo8r8FtRe44GRtb8Dzfbz_pGNhBnktctLj8R49oPBidtavvpQKeVhc91FQr5x7mJmPk0hDuxpDX5PKThPYmzQhDzVZWXaCQnttjah1Cm9lhoElWpERK5H59PH3PT8A8D6k_ox_DdREJgT2HPh4305arwdRlVqVKUbf8H6ph6yMViJS-OPFFxXMm2EZVa092mAwnLqnc7IPYTj4VWfag6o2RDG_iLz9tg9p8gr2KjieQy5O_4WXtNbL9xsFmDLZWp8540c-HqAP9BOFRmDD7gBTObWjUBsES8p1ZSLbWez9L7jMxFTwPhz5bCWL5mfFF8W43QP1QGMXbDEq78D_u-GFsxptUlJZb6RhrdorGiDUgHZxd_fCIurW7HLc1lT7XaGut_40cqcCXRHQ4XWj7DhQjKGX9bMMcVzj_kur6KbBFcdP0tHFhagJ_pwqdvG3ZIuK-4ddZIWIj0prl6qqw-nTsT2Y3gnk-sJpduyxdb7o343LdftAhID_trklRQhd6B7QLluM8R9Mvi5noZlLnr4ZiObv7nM-PL-WLYzZF5XPVrUTg7kqqMltrq9jMnMQI5BzmB5_V-0ca3IZJGddW55wSH_emQpXi0pn945A8LddRIlm-UPGZNVNIOLknJmVbD5bY
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: 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: 1973

{
  "id" : "tsp_5H4qyxaAyb3qWdIxLKw9n0",
  "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_3TIXB82TJDX3HQhVwRKnwM",
    "project_id" : "pjt_4D9bheJtersXztj5lJuxTH",
    "name" : "PKkE65W5wv",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4PowkFtZCiuH7CoI1h1Be7",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "dlOYbhp1pK",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4rG30GaphbaY92xVrxJBLU",
      "name" : "XoycNatOr1",
      "email" : "pQffYKdz@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6Xr4mJc7AKABvLxXPOhsSE",
      "name" : "kMl2chvoBG",
      "email" : "h6N2Ik1x@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:19.642103Z",
    "updated_at" : "2026-08-18T14:37:19.642103Z"
  },
  "created_at" : "2026-08-18T14:37:20.025820Z",
  "updated_at" : "2026-08-18T14:37:20.025820Z"
}

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_3Bz02fwW0sWh2MkdJxTK37/task-specs/tsp_4icPmGSPMe3kegMeQOKgEV HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2OThmODZlMy0xOGEzLTQ4NmMtYWNlMS0wYzU2NWYyMTU1YWMiLCJqdGkiOiI0ZDQ5NzkzYS05MDFhLTQ3NjItOGExNS1kMjU5MTIwN2UzOWIiLCJpYXQiOjE3ODcwNjM4MjQsIm5iZiI6MTc4NzA2MzgyNCwiZXhwIjoxNzg3MTUwMjI0LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJyVmpiamJ4TEFVMkpjTG0wNEN0NFAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.AKJoK78yvvLNQlqnetGhqpD3iIKjZd9cez3nPWXOHrPZVHu3FZxkgHNVRq9DcYsph18ywOi7ldLxUfwDcAHVxMJSdZddCj_HzrsbB16kuWnWmoAHoH8bu9Z9l67kGwFagMdqUQi6NGsT1Q-0ct37IeZKDa_GzyX-SeDDIdv6MDGGPUqA87j2YgJi_Fst4qEFx_fDo_01sNzu-tioIvbjAOtOZWZygGCtZgT_v2VG0WXTCsE1yaV-bJqegZeAjXua6LoWnouEQEp8XSbt2S5YKwXwZMzDWO2AwCYwth8nECGEpSdVxi1BWr6BzGwg88JMHcTg0qsMwWAEk8F71rCU5DPTfPYBJaax3WXP-D41k3o78uNc3HTlf29NQfieTU_zcGFjFKfk9dcej6GexAOwMhVhRvS6yUVG8OCF4nlLfba2_oIq-0J3LDzS9xWZlUyYUbm2uku9hI3xtUtRD8upqgh8mfZTFYjRZuWG7xt9lmJ3rzIYwkqCJdHqQ2XzUZ_5h53TEtFb0LjTu6w5m3CA0jtoxVAN67pK3ccV_wv0JkAS6Ol3YBe3PfHdO-n8FzBv70pXLSm3tZFxRW5CeNKc5zgvT8Kfi0RMOiV5CI4GoaCXKZM9oZiwktlqNLRllZHP9kUY6OiHQvz8MGckQHi50P8TPWOERWgb6MOKhVQjTmU
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: 1701

{
  "id" : "tsp_4icPmGSPMe3kegMeQOKgEV",
  "title" : "9RXnHhnhob Task",
  "description" : "yxQpyfUGuC Description",
  "type" : "dosing",
  "execution" : {
    "type" : "dosing_workflow",
    "dosing_workflow" : {
      "treatments" : [ "tmt_3sVCPfS64siKbh7STJuDOC" ],
      "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-08-18",
        "end" : "2026-08-19"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_3Bz02fwW0sWh2MkdJxTK37",
    "project_id" : "pjt_7ElrZe2JHkwfjlq6X9rF2Z",
    "name" : "iry9ltbR9R",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1TzbPxrQXt8zwVULbsvYmt",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "9fYoFU5yIh",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_4xfzAUI6MlmbMVmznaUlnQ",
      "name" : "RxxEgasw2r",
      "email" : "bf42CLyQ@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4HHn2vzS5s6YkznQkBPNFf",
      "name" : "gI5XaYV6Uc",
      "email" : "8cZ9gvdU@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:03.581435Z",
    "updated_at" : "2026-08-18T14:37:03.581435Z"
  },
  "created_at" : "2026-08-18T14:37:04.216881Z",
  "updated_at" : "2026-08-18T14:37:04.216881Z"
}

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_Cifinw1b7tXIC5XZn349v/task-specs/tsp_1coW8nfPqCfhzpNpD9Nldt HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYTQ2NThkOC02ODFlLTRhZTgtOGY3Mi0xNTRkNTI3ZjcwYzgiLCJqdGkiOiJhMDQ0MzIxMS0wMDQyLTQ2NzMtODViZC1iYjQ0OWUwNzNjMGQiLCJpYXQiOjE3ODcwNjM4NjIsIm5iZiI6MTc4NzA2Mzg2MiwiZXhwIjoxNzg3MTUwMjYyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fM3RNUU9vUEtpWFdzdHJOVlBvaE5FeCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.W55lSSW0J31k77UTvGR7yFDTD92zaoKcyPd-43jOON73OYtVMn2gHHYzid8GDVzxy1iH4pXO77r71_XTNjjQTDT7fe5j45GfeP-dPK7TWHy0VPbia_TH_-k9xViC1V_yiFkLagu_pmWHaig2F8t5x2RSbiIpMtlN47VhI078WUGxvf3o5Jza3hWbEs1tIH4cgmBhihgyESaazl4J_2feJoGXTY6UwEpgTAjai_x_u8N25lIXHhBZ671TK6xtf9uSry8to5gzys-74uMNPFexuew8hVOymzudQrNUXQ_8W2yFGgRrfHshYZd0p39-XmE5WQSf7v-JqHWloCt72uhyxj1e2U5kiIuNGybiKBEHV0ic2G8LYn0CrcqTmzJdBMvRobIjuoIVFisHTQdoE-UaTZEyjioAWu2IsfO1vYTvrynQziJr6GBXUOMvUg7XWewvYCUETQ3dS8N70fYIWZJc1lSv7_6_NYjrkl_Lqo2nee-h0o3ji76z0oLz6Y6O4_dfNVWWrCEwRQIXlnWPZO9TmCY7w8KmnICLe7pdP_iVzG-iJYGRIyINjPbJ3idpVN7UdJzTZbv1M486StyqyrSa2UFGH53Z_BEDCS4E2Rx5Q2qBQFws2zryxwMgW5hbeT9U1ap59wp37C9rIlkSYwbD65RwIOCuRQEAur4gVMk3UZM
Content-Length: 260
Host: localhost:8080

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

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: 1653

{
  "id" : "tsp_1coW8nfPqCfhzpNpD9Nldt",
  "title" : "Updated Task Title",
  "description" : "Updated task description",
  "type" : "sample",
  "execution" : {
    "type" : "sample_workflow",
    "sample_workflow" : {
      "samples" : [ "tgy_3gCBmD9Z2bRNUFtusdcuzL" ],
      "auto_generate_sample_id" : true
    }
  },
  "schedule" : {
    "time" : {
      "type" : "all_day"
    },
    "timezone" : "America/Los_Angeles",
    "type" : "one_off",
    "one_off" : {
      "duration" : {
        "start" : "2026-08-18",
        "end" : "2026-08-19"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_Cifinw1b7tXIC5XZn349v",
    "project_id" : "pjt_65ekkZ44ISk8FquY27C6D1",
    "name" : "13DueAc9r3",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_560QkSk4rIHNbIlzXstgCw",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "dJcKaMrt1G",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_6TviIx9PCCtFAv0BcIw4L8",
      "name" : "zvmPzTkVM8",
      "email" : "Bb9MaaEG@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2uyQPT5jsjKHEOPWaMACvk",
      "name" : "jzKxmPK4d7",
      "email" : "sIKXtej8@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:41.588140Z",
    "updated_at" : "2026-08-18T14:37:41.588140Z"
  },
  "created_at" : "2026-08-18T14:37:42.164256Z",
  "updated_at" : "2026-08-18T14:37:42.266829Z"
}

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_66SZPW5l9HRL93A0JAI54C/task-specs HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjODAxMzQ0OC00Yzk4LTQ5M2ItODNhYS1hYTFkY2RlMWE4MzUiLCJqdGkiOiJjMTZiNjYyYS1lOWNiLTQ4ODgtYWRiMy02ZTJhY2RjYzUzYTYiLCJpYXQiOjE3ODcwNjM4MTUsIm5iZiI6MTc4NzA2MzgxNSwiZXhwIjoxNzg3MTUwMjE1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVlSlY4OVBlQ3BvdnNVV0E0aVZIMyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.lb0qVO4v3fFWPfIFrKimq-Vmd8La9OeUPYbsof2zbF0vV9rir24GC8xa5LxDpRh0gOXIQ3kGF80uno5YDcc4Jp2_r2KyzVESVSv-ywmHVtXnZb4uEDClTY_OqdqNUJwAXDQjsguWSjKQYp5jHda-DfJcJZQ63IPuq2H0RJbsG-lT8VhS-H1HD4Z2ZciWRqhxjrHgAuB7dii7IMXmBx2wS4UtwMtmHgYBEMcCu6u8eqxrnbQ5bfrHc79OaosohYkYvTs2gMW3X6abdbxYuoxAjCmnXdPZz5d7yZsR8dIH7ZHZgoccW5oNPWfL1zGtTVrkr48Xc9AtYr0CU6z6x1AAPvg-pNXowf4HdQUCyZKu6PvWqAfZA9K40Y3xAFa55Kb4bA5AkSLNzrBITJWYV67QQYM2T_xi9mdDv7OTo1qN_A8DKezqNlRn2qjPtj5zQpuCLEr7ThOGYp0v00_xcJCVRKDnp8fnRWhcnR-P9xJo8F_xfhlf8EZuWYMNAd27bnyIaAv2xKnsv6MA6gweB1S_oDWT2hBIN_f7uWMH16h4hwUO8gE_rC9Cl279zfpYKTE1PbepRZrWmOpNx03-j2DEopc5p52WpShGSyjaNLbjqhzJhj3aXu6KtQI4eNRHzsxqgzE4-XzKrkT867nv_RigrBUeF40PRl4yPKawxvyOp4A
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: 3951

{
  "data" : [ {
    "id" : "tsp_4aTQphZ1KHwtTZFxpzb2xN",
    "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-08-18",
          "end" : "2026-08-25"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_66SZPW5l9HRL93A0JAI54C",
      "project_id" : "pjt_5JknYKaSvOQwSAm3cuNo5o",
      "name" : "pq5fPXwaXX",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3WdFAMagWzeQIlgi4V2w9s",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "PlYhNIsdwr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_77PCXr9qTkx0pt34GchZa6",
        "name" : "IjkbeJzlYe",
        "email" : "aSrp3g0c@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5ZaRTfBhYhJOZfhVZ2RWtH",
        "name" : "h1Ydt3G1bV",
        "email" : "bpuZAgGB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:54.402022Z",
      "updated_at" : "2026-08-18T14:36:54.402022Z"
    },
    "created_at" : "2026-08-18T14:36:54.994208Z",
    "updated_at" : "2026-08-18T14:36:54.994208Z"
  }, {
    "id" : "tsp_428ZCmKR4o2oElgiQ79tQE",
    "title" : "Q8EiFrHcRH Task",
    "description" : "POfkN2m2xi Description",
    "type" : "observation",
    "execution" : {
      "type" : "observation_workflow",
      "observation_workflow" : {
        "observations" : [ "tgy_40nqPyMGxiXUsj3Fo9vMFL" ]
      }
    },
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-08-18",
          "end" : "2026-08-19"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_66SZPW5l9HRL93A0JAI54C",
      "project_id" : "pjt_5JknYKaSvOQwSAm3cuNo5o",
      "name" : "pq5fPXwaXX",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3WdFAMagWzeQIlgi4V2w9s",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "PlYhNIsdwr",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_77PCXr9qTkx0pt34GchZa6",
        "name" : "IjkbeJzlYe",
        "email" : "aSrp3g0c@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5ZaRTfBhYhJOZfhVZ2RWtH",
        "name" : "h1Ydt3G1bV",
        "email" : "bpuZAgGB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:36:54.402022Z",
      "updated_at" : "2026-08-18T14:36:54.402022Z"
    },
    "created_at" : "2026-08-18T14:36:55.009222Z",
    "updated_at" : "2026-08-18T14:36:55.009222Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_66SZPW5l9HRL93A0JAI54C/task-specs?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_66SZPW5l9HRL93A0JAI54C/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_66SZPW5l9HRL93A0JAI54C/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_58sQXUUFtray1Ea4PNJGvz/task-specs/tsp_5dNHxZzbRqeENZLpFr3npF HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjZjY4M2JhYS0zYzI5LTRhZGMtOWNjNi00OTIxZmRjYTFmY2YiLCJqdGkiOiI5NmE2OTY1YS0zMDEzLTRlZGItODA0MS02NmRjOGZiMDI4Y2YiLCJpYXQiOjE3ODcwNjM4MjUsIm5iZiI6MTc4NzA2MzgyNSwiZXhwIjoxNzg3MTUwMjI1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fM213RVJxUEZ6RGhSekFJZGJIWGVLTiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.ZUYItKvICzE_6GwXxYzqJyvr-MyWleGLXPPgO83raV5uifwqevgJ8Ulu5Ke4yYjpm1u5byt7URVsElWB1SNmVEJtbwZSUCITMg73ChhmBdeOqjHZX5lGLU354leJbqwAJXJmvYRV5Y0Ibvk5IXeRknLVl7xii55MxiYFl0rDo_yeLOta-wP_d76uCat4fAUi1fVz2xraH074tGF5wV2iiBhqKBQBZ3KhvlZvnvoUQZL6cU8xzdN5uUf_ICbyp8pAF5yWKrOyfIqxni1tEZJoL_QQiTZ4YfyIbxk0UcOKVuNsIUcVvgdC6_SNswl__SCEYsnp7BmxlQgm_-991vXgoVy0eKG92J8wcDmjBhfKf12ic36eUUnS4wVGbQLXbnvMcaK4lKIdlj7c1LAPlrEhk9rxRmrPsz_PwjLJ5jkihw2Lip4pkdxKPKyL_HAQH2ziTMDib-_AMnk-go7XfiXOPCWTFLebA2tiu7hs8UusOHpZTM0NtVhFwCb5pQwnpid9JmAuNX9D6Zb5_XKSsBb1DolYt7Ai1kvv7rFzNwLOTSdjUxFb2SCv_SFnlMpE6kI9H8BJE31lQTrqvVMhUgn_-PTeUxQIvwGv5rktk_oarJavAiPrjhv-3UYq22wcv4V7wpWPRgZRdL4Ushg1OP9t6RWRSO6eYuIJi7pD7YhgKAs
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: 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_66sRAIDRfhYQpicUN8RK4k/task-specs/tsp_6dRndlBJHlm7w5uHwiwjo1/assignees/add HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZGRjM2NmNi1mYzBmLTQzOWEtOTM0ZS1kOTg3ZWFmNWIyYjgiLCJqdGkiOiJlNTk4ZTc1Ni1mYjg5LTRmZTgtOTczYy02MjZiYTBkMzY3Y2QiLCJpYXQiOjE3ODcwNjM4OTAsIm5iZiI6MTc4NzA2Mzg5MCwiZXhwIjoxNzg3MTUwMjkwLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMWRCWmk1WFhKeWhFWHBvVXM4eFRFZSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.QB6Z4xVjl-chYf_RBPCmi1L3sviluvOq-l0uqZAek3FwJnygE_9NDAwKySlPE3ITAndCfN-HtPwSN5Do4MeBVdMmiiFmSnIIyQpX_BYo-m-Me9p0TKXiU_cK5REpbupIV8tma77JfNPrziIfS6nFWFDhigkHRqEyVLXt1ZP7z1IOnQgkJW4Djiml7ihvUyMfcjvnbvFf5ECstUSfvGuubIHLLwR5cXL1lYQbRMmuwfyl2iIFfDRjXu5u7_TFo88YGuQR4bfZiXiAcbGdhdWuFNZqMEa712sT82LxcedV9AZPuTndK8F8aB7DhFg3Li224yM_je2OswiGLCZMjXIXJ6MVJsySsHIrJWsvEV0V51DTjAD4WryvECEhT_XTXpZ_IACavz7INfdt2g9iN0KVbEEhTYFpcM4eJO2dPZ7eWWjufuV01RRPbiIZ6v205lbhgk7EJ6btHWmacUo1LkoYe_IRryUninrpekuYZegiTnJVoiz3t-DECxTEI5FbIs8OyMcQ7CQf-U0O3v5yzD0OTwCSm47TdMuBVhXhpmQ1iasvd7IfJVzqLAALeAV48edus73dlajF_yhO6iHP7vHAE1heiG5cpPOcADe2cZI4LX--z94f9FBi8G93gSLqA93l66qPh5Lp6x4oOBQoipHUqRUHDb1aZeFiI1YuLhSd0u0
Content-Length: 96
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_46YervwMkB9i60yA7Nhzh3", "usr_4rqPSTZ1GIeHbeqkhdvoAX" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 20
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_47zkM1PhwNFyEzGL3PbS0B/task-specs/tsp_3VSvtJ2YDxaux7ZeGKEVre/assignees HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjM2Y5ZGU2My03N2EzLTQ5NmMtYTE1Ny0zYzJlYzBmNjE2ZTgiLCJqdGkiOiJkN2ViZmJkNy0zMGI1LTRhYjktYjc4NC1lOTkxZWU0MmEwMjgiLCJpYXQiOjE3ODcwNjM4NDksIm5iZiI6MTc4NzA2Mzg0OSwiZXhwIjoxNzg3MTUwMjQ5LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY5Yk5yQUtZdEFncWRsV3FQNkpyMDEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.mtkVShUouhwiucCl9S6-PGnvqkceNIWI1c2lMktvxbKYhol1BswCICBpZHN1Wjcbq2VN_vWbwFxOSM5ZU9q7GdoSMvaG1lfm7Jmt3mHFx4tF29Ud-X-A0GmTByUltpFj6C8ByJIh49_jrKa9WGh8lu8G5KT2v4r6QU5BbigZXI81SUwyaarDhfq3ECnNKbuEgfaEWo08ZpyLQ8siM8HC_PNb8-UcO5qKUpGDwP3OFe1QC6dO7Ma_iMVWhmz5o_7UAXKpZGZiOmzXMcpPvQb5lYxtABukxNDIbbE2k5Jz6P7kIfEwBXnrgGW5gjd0uaSceCjV1piSFigh_0Mu6_umT4QVZAsuRipTgw01wFO6CEhlL22vLvoDO7_bj4LqLlVkzA53VOMywPTrQlPP5tLCtzB5VinZyvpFh8IpI6cv_5W-hqMvq8oV7KTm0YruedWnSCNUBlwyPWTOzoFVarY23BJ7NCuj8vZ1hvDX6Dtg98SXm8pJT7f3grsAQ__RUG6EVpdv5kFzkbK2iMVd-tpSt3XiA0y7rnV2MEPCdijFH-dFx8AARyPO0p5xnwIodFOWNDgXST6qT4-OTaq5t1Z4oIl204wjToMxtkkCq-wdl4B7zEmK0_DsU-2krA4EkQ-m4XJu4XSSyVWNx0J9gEejEFW8EQ6W8AFQ6nEYiplyK7Y
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: 1308

{
  "data" : [ {
    "type" : "user",
    "user" : {
      "id" : "usr_aVwYOkDuQeINGY7AcIoRN",
      "name" : "4V1fIzVPnu",
      "email" : "1YM3YLmp@benchling.com",
      "assigned_at" : "2026-08-18T14:37:29.385843Z"
    },
    "task_spec" : {
      "id" : "tsp_3VSvtJ2YDxaux7ZeGKEVre",
      "type" : "other",
      "title" : "cXvTJinNSF Task"
    }
  }, {
    "type" : "user",
    "user" : {
      "id" : "usr_7DOs71w9NVpQTHOedB69dr",
      "name" : "KbbodPmHcI",
      "email" : "oHmNUmeA@benchling.com",
      "assigned_at" : "2026-08-18T14:37:29.393055Z"
    },
    "task_spec" : {
      "id" : "tsp_3VSvtJ2YDxaux7ZeGKEVre",
      "type" : "other",
      "title" : "cXvTJinNSF Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_47zkM1PhwNFyEzGL3PbS0B/task-specs/tsp_3VSvtJ2YDxaux7ZeGKEVre/assignees?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_47zkM1PhwNFyEzGL3PbS0B/task-specs/tsp_3VSvtJ2YDxaux7ZeGKEVre/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_47zkM1PhwNFyEzGL3PbS0B/task-specs/tsp_3VSvtJ2YDxaux7ZeGKEVre/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_2CKoP0a9LVtqPctBeNRRMz/task-specs/tsp_3ZX06dCOVc28HX5IlHNRln/assignees/remove HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MDY3ZGVhMC04MDc4LTRmZWYtYTM0ZC0wMjEwNTIzMTEwOWQiLCJqdGkiOiIzYmQwYTM0ZC02OGY5LTQ1ZjctODk5ZS01YTk0MjQ1YzY1NWYiLCJpYXQiOjE3ODcwNjM4NTUsIm5iZiI6MTc4NzA2Mzg1NSwiZXhwIjoxNzg3MTUwMjU1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fN1lCcmFka3NVUlk1NG9Ld2NUVHVtRCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.SWu6Pl7ydCfVQxrcyCgUpzhmyMbxN-W2lzu7B17Yv79tMQKGGQX1xVEHceDXVuWbQ01s9y3bSK8RM6ailhTWetDuNQy3ORIfpOYvIz1hmD3p4doarPs74nWoMSMN4XQbULfGshS9ociE8sFyM58cN79fkTPmd1NGJFbwVOcpjZkKQCK26vZngmbw2giskzAXv0lq1LUnZ90DZztvyJjZze9Am2oly1GK8Y4lwEw0sxv_G5bxf7DrRw1_zDSvP_7FjWhrO_EMdwX9YWQdPoSKoGrn3QGYt48_Gwu27TdZrstasdIZ_H6tYJB3GUDM27IPmkOHkiq_20i1N-MBu10QsNDJEEhoKV3EbH8p3BGoDDMMKc4uhT4-QuZfaFhyKNDV4fdSCGVWOYD-hMhG_2JvNVn6w6eXR8T4kI_R34d4iLDJa4wdDaYG8PJWOCSLBHR0u-QJHv-iqLsdLFMtzD9rpAZ3Ai0vuxmgkIx4KzTrnAdQ-ZvY1GbRvKMUS5XliGLs13w03Nfi6xSzp7y47RyoCanPnnvclCwBzxgv0JPohQ88YD5UgyRpfFQMWeTtyyIaAdiVhMei7IDHG-e5PuXNzci772DApsskz_gQIB77xsGn5PcWeNTc5KpssDadWHqlghENRgpOYmtkNvRx-BQrW36M1ap1ZgltyTRjRqs_ep0
Content-Length: 96
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_3TdM0V1FNfGU9GuGQw1Wwh", "usr_2qKPfYgI2sN9QJsxvTBG84" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 25
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_7fZREmyOoDfA8dfy5W5lcA/task-specs/tsp_38eH6Den8Fs3x2XR67TXhi/targets/set HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3N2M5YjUzNS1hYzljLTRkMWYtODQ4Ni1kYjAyYzhhMzdjZWQiLCJqdGkiOiIxOGI0ZTUwZi1iYWM3LTQyZjItYWMwMS01NDdmMzQ0ODE3YWIiLCJpYXQiOjE3ODcwNjM4MTAsIm5iZiI6MTc4NzA2MzgxMCwiZXhwIjoxNzg3MTUwMjEwLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMUI4N2RUTmREcEpmMGRHSWNPd2VISCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.S4CPM8d67HEcpXKQ1WnB7oM55D0YTFxUdkfe9dJM1IBfDynD4nMuYGfRebJ5gdg3TNEWijWFcvM8mJS020qJ0XGcvdH5F5Tt2cJM_uJFItAl9H979Xkvux9IYP5j-1uCVPQUmafouYh_uMHkrHIFpARqo7HFS9b8NSjfTBTPRnkgKnY62isFwjvZxCCJlm_qmVX9CZGwr7qU1TKKOVu_fHnHCwiyTyVXXEArL0AGPQ5NHsz8dkmT_f50nDNw5lqKLLyGDLIXhYqRh1DYcdYnRCek1oegQQwtXx9YDyq32ze_Piz7V-HU8E8cwxjbA4UehemxNg4qyJRZscmdDL9iJ0Q2SVpYP85Wj8ud9A2RmoDWQ_wv1-Tnmr5KAcD6GIirO51NX1KsdsIW0lnUbBhqRfqk2PWXV1JIo31oa2HuyD_uiiQ5XpnjqBKI2tpcd0vUs2punc-8vK9GLkiRP0BV56meYWcrd-QZpJqPtT9_7v9veYw-z1POqU9lIRHy8Mfh5oQY-IC81qaTzSXoeGmDPJROIMu63ZR4OUf-pIYRXPTaBhyQOgR8LpqLb4ovxFRNKd9HSH2MCNTtHZVXzMprqURlDR-c-vF5DSxSLcT5spSHqnyyuJUnT_WLOOhNeMVDty3R7k_oP9lsnT8jA6fHmyxSZCU35mU9P-p7xLDjPFc
Content-Length: 98
Host: localhost:8080

{
  "type" : "group",
  "group" : [ "grp_5DgmD9QB0pJ1NZ663RCeJU", "grp_3IBBjQsbqNps0k9S8PvRtm" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 10
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_2vpVy0w4dDZRXu6Apgowlk/task-specs/tsp_5DCssyWicdT8mULpw8t3RS/targets HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiODVjMWE1Yy00YTEwLTQ4YzYtYTk0Yy04YWNmN2IxN2RlMWQiLCJqdGkiOiI0MjcxYzc5NS00YjAzLTRkZDUtYWQ2MC01MGQ3MmI0MTA5OTgiLCJpYXQiOjE3ODcwNjM4MDUsIm5iZiI6MTc4NzA2MzgwNSwiZXhwIjoxNzg3MTUwMjA1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdGbXhQV09SaTRmdm9oN3V5YmNzU1EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.eYX4A_YaEsxzdVLb7OC8xwEEHoxmCChx8Vy-S7a-PuPBTUg-obdo_V7qBTJdhezk6cnDoD7_ixH-1nqpDRral-uB4sk_PmA-wAJqMam-DqYrEdxA9r5_kRp5aoNJfyIBayGuhBzcDOLCr7Xse8ZBr3jWCoAYhUo9jiulqUhnk2iZty5kjUShzMod36HbmQk77ksVrfP5i7rJSH5MTOO8FkRrZ9v0OW_kFv7CcOsso7FASOf_cO4nzxSfYpRYBkKczT_Kwg_hSTDK8VCfrG7yyL2spCPv3QOE_t-MLe91dxKRz9Muh2qEtKRc7SIOn-nF_7WRD6Vk7RTu-tZBlp0zCt5PmMHbtx80_sEEAUKkD6ESuOm4NRqIH4FIiQ24eA5xu_BiS1j2DKEyw692g65fENMqcekOFyUveBTBYtVkPQgLUju-SM3ybHYB06D3FYBn6DSH_XHNq9EGkOGNvjDCnNSAVe9YSopmTdO-CFG6AQkR7hT4sZgn8kEKzjFZpa5gJWOTmN39FF53LDsJJ5COxcudT5qWElKTIHxlsZKtHBnaRqR-YoOG4ZPxqEUZ35dGtnPiH6bhC4DngKJYWeH_kDW7jV4eDxQhz_iRpEnDhCWC7F5TJhlbNRZGPvyCEDZgZlC2CgFHloJmn_elb0HbGal3SERCBvxBN63QkjLYMqI
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: 1217

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_1pWvpgtseBeoSqcl0IAv5s",
      "name" : "Hg9UK9WPe8",
      "added_at" : "2026-08-18T14:36:45.079948Z"
    },
    "task_spec" : {
      "id" : "tsp_5DCssyWicdT8mULpw8t3RS",
      "type" : "other",
      "title" : "ou6ystasDQ Task"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_64YNUAv0fVyE21t8VZlV8F",
      "name" : "HpQ8LMWo5H",
      "added_at" : "2026-08-18T14:36:45.079948Z"
    },
    "task_spec" : {
      "id" : "tsp_5DCssyWicdT8mULpw8t3RS",
      "type" : "other",
      "title" : "ou6ystasDQ Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2vpVy0w4dDZRXu6Apgowlk/task-specs/tsp_5DCssyWicdT8mULpw8t3RS/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2vpVy0w4dDZRXu6Apgowlk/task-specs/tsp_5DCssyWicdT8mULpw8t3RS/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_2vpVy0w4dDZRXu6Apgowlk/task-specs/tsp_5DCssyWicdT8mULpw8t3RS/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_6EiLeiSziDGxtf0fGaeepr/users/usr_3dnOuMdjvVwx95Sh6pUaag HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiZTViNDk0Yi1kZDdmLTQ0YjgtYjBhZS1hNWM0YWU1YjIxODciLCJqdGkiOiI3ZThmM2Y0My01YzBmLTQ1ZjQtOTdjYS0yZmM4MTBjMzRhYTEiLCJpYXQiOjE3ODcwNjM4NjQsIm5iZiI6MTc4NzA2Mzg2NCwiZXhwIjoxNzg3MTUwMjY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzM0V2ExdFE1Y2hrdTJyZFlrOGRpS2giLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.ZJNgoJl-LR8J9BGqyOtEqGoancZ9i8Psl8J_WymKa1zWfjtB8zZVxjhdtVHNjVxaCvsmWUSh6sM8kSD87mt1Nbr2rQ3oWbAFlruJ368Susn9__BjHnCRjYiA0WboDRlRyDcnaR6Y24h0IgA-mtT5-NkF5HVCNvZ9ADlAyHIYTDkjF-y74866dMNlX59Eq0fLeRTrlxXSHzz-yTwbFIDPygKq_SQO60fzfh9EDAJ-f8r99f9PQM6R_HzT1ROm9QNg-LTevBlqgdX8ralk6IyC-ramAGj7jVQmjBevNGy2WgMyoVRhZdnZ__J27XVjj_oL8jTI3_e_AmdQ8mjTBgrwrIPUZf11R7LYYoPVdYBA2y_FZjVT9piCbvT9GwUXBlYoZ8w8fE9P4MDN9erlHOlRqXq2_hR98eiWdBYk3UaEPqtpPapCf6tPWciNC-RKqWmQof65xULBcIET_1LbwMegfpINrnz7BRgr7oDHpDu5BmZQQJd6tbyLkQkS2oE7WjnxjFjWBxdwjhbeYwmNpeUpYW3Wt2Sk9Z7JPiu_oMmG-Xg0n8HCe8auL00lspygiy32UcL10cVbDq9nildWs6vhmYdjsxCgqHmsttUMdMOdHiR7JIueSf49JkEdNfOLdoGEx7OV6QB7OSEY1hrUg3U_WjlZ9leDGO7eeOCcZCkb9AY
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: 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: 1115

{
  "id" : "usr_3dnOuMdjvVwx95Sh6pUaag",
  "name" : "Gaob8cBSRf",
  "email" : "9WU3cSHk@benchling.com",
  "timezone" : "UTC",
  "type" : "team",
  "access" : "read",
  "study" : {
    "id" : "sdy_6EiLeiSziDGxtf0fGaeepr",
    "project_id" : "pjt_2QhPr84ou1xa3zu8Ngf3Hz",
    "name" : "tf1gERBhsd",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1oD4yr1qnYa1oBUAjS9DoR",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "5DcwEtozl5",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_7dDryRwHnh1XRfk49tVreJ",
      "name" : "quc7Z6oGLO",
      "email" : "avzHVHxN@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1GppYIme3EwzuPceHnpgTY",
      "name" : "lqfdUyTiTH",
      "email" : "vHlaRPJq@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:43.773241Z",
    "updated_at" : "2026-08-18T14:37:43.773241Z"
  }
}

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_2gLhjSmOvmoPrAkpsLNaP4/users/usr_3sJrxEDX69l16uW1wSsrUb HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMTAzMWQ5Mi0wYzY2LTRkMWYtOTc1My1hNzUwYmVhZWI1YTEiLCJqdGkiOiI3YzZkODVhNy05NmI3LTQzYWMtYTM5Zi01MDhmNzNmNzM1NTEiLCJpYXQiOjE3ODcwNjM4NjEsIm5iZiI6MTc4NzA2Mzg2MSwiZXhwIjoxNzg3MTUwMjYxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZMZUhSMU94WXVMbWxNb2dqVks0OG8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.XD3L5Cn9q4-VsRGQHcSO3BcCPkYCCt70ssQVYXeSUV9E72Y96fgoTK97SG0doFio4K00oKKs66OHO1GTGg8zgMwYL-6GXHe4uCUOA6nvRBRo4kbpH3cp6SkBkWq54wHuJwS1r4rCgoJG_wlEnHAi2CGSLr1XE0KvVp0vWN-uN2T8_HSk6wUWkAU9FSiDzbpzU0a-FsFd1uFLn1DJQPKijYFwHNv6EJ9QxZJiyisBKOKn0JT4WpVKUvmRqHPAFJkyfsfFWFtbg9FiJjStjOzcXr8CAyw4_QFMMDinc7mwOFH3D_cRZKlckPaFa7O52p6EyrXi632t6a1oeD8UCtzjs9EVr7Dgr8Gs75YU_Fs6vyqlY4Y0IWrSbsiO6iQXdAQI8EkLWIstSJrgNa0g7_mfLs4S-DM2DuktuU-db1AaITEm7-tgsuQZgL2gZo3FYBWNmNVhQdf04CQBRFJIlhr96uAOT_aFSFcH1QS718w83n4UW3mTzePQpmcMKH3zY7evV2IWP1yt_1VWpS4oCkWpg6n7zpJstPds2ExglVDDnKQ7iRcqm4uAi75pRIR_Ii1CRi_pOq587E_hE6zgcmxJdxdCC2KuKuIsW_wz1hJ7IJr4Lx2SztY2zCFl0p40cPJhF1mL6qpofh322vmTrR_nYU-SKop35wQ1mjbI2TltLeU
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: 1117

{
  "id" : "usr_3sJrxEDX69l16uW1wSsrUb",
  "name" : "KXXkpfc8da",
  "email" : "jQFJUdBV@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "write",
  "study" : {
    "id" : "sdy_2gLhjSmOvmoPrAkpsLNaP4",
    "project_id" : "pjt_Y1wtqzjb58mINxkgIG2IY",
    "name" : "hLznOnFqVN",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1iLNo6v27vBQfjwUunzIYK",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "dJf2YxA6qs",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_3sJrxEDX69l16uW1wSsrUb",
      "name" : "KXXkpfc8da",
      "email" : "jQFJUdBV@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2huDq0Qf6GnytAs2Mu5DBo",
      "name" : "dRVfvxKFQY",
      "email" : "LX3g4S63@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:40.387206Z",
    "updated_at" : "2026-08-18T14:37:40.387206Z"
  }
}

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_4TWaimK4uxe6IRmDyr7Gey/users/usr_5hPPSn0epaMTeIStzri4K9 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NjI1NGMxZC0yNzRlLTQwNWUtYjk2NS1iOTVjNTQzNTQ0ZTUiLCJqdGkiOiJhMTE5YmIyZS05MGU1LTQxY2YtOGNmNS1lZjE2ZTY0NWQzNzAiLCJpYXQiOjE3ODcwNjM4NjUsIm5iZiI6MTc4NzA2Mzg2NSwiZXhwIjoxNzg3MTUwMjY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdNY0c3MUo3OXZaQmxIVE1nNXhSZVciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.GhDpxuTxkq9Y91SWKzCxTsJkGPWFtbEDEim-nJ9IpbovKJIAWBOtgRaVOR4kxdVLwalXnJVuWslMC0VW-Se00X2nRwgMwI17ROEwG-HYDHcFm-X6zvNYyiLN3wX8k1gMOaQ-0Vf3IJScsGFXTknY7nOaPEdmXuda6zrFK8fLs_e_8fkJgRF8OUDMYFluZ9IUDFIgZbS_hGh030FVhw16JctI4_PycOV4NMbUkKh32YHCvwhg_vnHHiqXtyIfSZnqS8Ico9PWq_t3g909lDRBAuErXFboYBDvLDs7toPOqPCBns0XWVAIfA1x0gBThUM_jHsnOAehDEDIST615FExrwW6yKH57uPIxSXju-ckNe3cNt0tbX9DoUIDu2M8pdnL0v-PETwVBTwmA1KC17o65LPZWs9-ITayd4kiqGa616YQnrboB1vk-_BMxv43XcbuBivV6qLX4ts9j2f1rIHbcWr2NLheSkyWF9iqcc9C2PvIZiTuqa0aTY4hsPOe57lX-SyttY4g8-5gmq_q5MhspWyECga5c1d6p1bxLGtlasb-0Vs1AFAvXq4h7_UZHt9fbE5-B7IGhH3PEpfKrf2aSQQthCf9DUE7fQi6CkAUyEal5K-mMS_jp5oFBgF8dDEQDraTPIQrwivIYscTg50BQatreWl1gyA7Hlcl109d4k0
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: 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: 1116

{
  "id" : "usr_5hPPSn0epaMTeIStzri4K9",
  "name" : "a7NKftV4MW",
  "email" : "iyahCY6j@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "read",
  "study" : {
    "id" : "sdy_4TWaimK4uxe6IRmDyr7Gey",
    "project_id" : "pjt_502IlzPCg9IQCnkLzhAJU",
    "name" : "dQmnyBm5MJ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3rPHEA0N1HAGToW22dyVJ1",
    "type" : "internal",
    "started_on" : "2026-08-18",
    "status" : "in_progress",
    "description" : "7HDjUFVXI4",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "tracking_day_base" : 0,
    "author" : {
      "id" : "usr_7D04rVdFUddjuz0juOCmBw",
      "name" : "Z2FGh80QTj",
      "email" : "8ii7iUjv@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4meuvPWbXas3PguOzKn2uV",
      "name" : "r4bISXMo4k",
      "email" : "C7v89vxS@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:37:45.480652Z",
    "updated_at" : "2026-08-18T14:37:45.480652Z"
  }
}

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_185SzQDF3c9W1elsCnocAF/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYzc2MTc3OC1jMDNkLTQ5MTUtODkxOS0xNTMyNTVhMTA3YmUiLCJqdGkiOiJhZGQ1NzYxMi1jNmIyLTRhZGUtYWY2My0xM2QzMDRkOTcyMzYiLCJpYXQiOjE3ODcwNjM4NjAsIm5iZiI6MTc4NzA2Mzg2MCwiZXhwIjoxNzg3MTUwMjYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1Zsb0NBN0JUdjN0djZtSzZNdkZoaiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.T88SImWavFmtd6yk8x6EabHic3l2u98EpLDA8--3_xPDHE_J3N4Sxw1pcZM08ct8S226gRSwDjTOg1dTBeLamq1E3xB6Tt252U_5-Y89dISHVG_uoMh7PBJoMfLp2vJ3L6JLk5YA3PPXYp52yrOvxZRvOGHROY6VqYQN_ucftyITlZm4ahrMeC7Yd9inyk2lG30jmh-u7zPpiTC1RQeGnfx7AkN8UYBG9O4Mf2AhM55bymW89ftflVgMZNexvAN4o6hM5jIdBH9vOGJZmEYmUsErJpk48fQPMouamuoWdH7iMNnwtDOiumzn_BDAt9Zl-Qsh59hWPRY7-dqFWVm-4m1GoWcjk9rQWFnNJBEOUvWSshEC1BFQeMtG28Y51JmLa-FopzcIkZ8ePVSsOpE_kDDVUgQZ97tRU34P5mZplXfvui480yf7-5dMb_FEdBoXEx3xkBryAvyY20gGQt0NUxxM6Cd9OwKwRn5JAeVaoDri-whYYnzsFDsLPusKgo4e3hv_cjhdCmuUjRMJUGyAU7a_THDsNDUBprZ0tbrxDcRdNvbawzrSxeVw5ecvNhAAkuwln9FjJzWw3_KWvJdEBWUhoR0qYlXH5tvo8PxH3MrW5D_41HWK4pLb5eMh8WPpg-cyU2dYxeAqYlnBtd45SVTPSSHw_CwABexL3m7QPNU
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: 5283

{
  "data" : [ {
    "id" : "usr_34MjBbp9vVyXNNU4Sc6qQh",
    "name" : "FGT2qfytmJ",
    "email" : "EXDnPliu@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_185SzQDF3c9W1elsCnocAF",
      "project_id" : "pjt_2PaOsZsdSQraeODCHfCnXr",
      "name" : "7MVUJb7ziG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_671HlSywBX2BKV5KPub413",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "LiJkx46IRN",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_34MjBbp9vVyXNNU4Sc6qQh",
        "name" : "FGT2qfytmJ",
        "email" : "EXDnPliu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_608P5jMeZcP02MuehAmZ8T",
        "name" : "MC7k3ClMxT",
        "email" : "DbivVqjB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:39.296233Z",
      "updated_at" : "2026-08-18T14:37:39.296233Z"
    }
  }, {
    "id" : "usr_608P5jMeZcP02MuehAmZ8T",
    "name" : "MC7k3ClMxT",
    "email" : "DbivVqjB@benchling.com",
    "timezone" : "UTC",
    "type" : "owner",
    "access" : "write",
    "study" : {
      "id" : "sdy_185SzQDF3c9W1elsCnocAF",
      "project_id" : "pjt_2PaOsZsdSQraeODCHfCnXr",
      "name" : "7MVUJb7ziG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_671HlSywBX2BKV5KPub413",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "LiJkx46IRN",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_34MjBbp9vVyXNNU4Sc6qQh",
        "name" : "FGT2qfytmJ",
        "email" : "EXDnPliu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_608P5jMeZcP02MuehAmZ8T",
        "name" : "MC7k3ClMxT",
        "email" : "DbivVqjB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:39.296233Z",
      "updated_at" : "2026-08-18T14:37:39.296233Z"
    }
  }, {
    "id" : "usr_6C9NLbDarAW4QrRWsxhqwh",
    "name" : "rG11uw6XgC",
    "email" : "SNrWrGiR@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read",
    "study" : {
      "id" : "sdy_185SzQDF3c9W1elsCnocAF",
      "project_id" : "pjt_2PaOsZsdSQraeODCHfCnXr",
      "name" : "7MVUJb7ziG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_671HlSywBX2BKV5KPub413",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "LiJkx46IRN",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_34MjBbp9vVyXNNU4Sc6qQh",
        "name" : "FGT2qfytmJ",
        "email" : "EXDnPliu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_608P5jMeZcP02MuehAmZ8T",
        "name" : "MC7k3ClMxT",
        "email" : "DbivVqjB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:39.296233Z",
      "updated_at" : "2026-08-18T14:37:39.296233Z"
    }
  }, {
    "id" : "usr_2DqJHbsgCAkZqxHhykjlDm",
    "name" : "JQl5A771CO",
    "email" : "6ZTnOKBA@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "write",
    "study" : {
      "id" : "sdy_185SzQDF3c9W1elsCnocAF",
      "project_id" : "pjt_2PaOsZsdSQraeODCHfCnXr",
      "name" : "7MVUJb7ziG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_671HlSywBX2BKV5KPub413",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "LiJkx46IRN",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_34MjBbp9vVyXNNU4Sc6qQh",
        "name" : "FGT2qfytmJ",
        "email" : "EXDnPliu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_608P5jMeZcP02MuehAmZ8T",
        "name" : "MC7k3ClMxT",
        "email" : "DbivVqjB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:37:39.296233Z",
      "updated_at" : "2026-08-18T14:37:39.296233Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_185SzQDF3c9W1elsCnocAF/users?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_185SzQDF3c9W1elsCnocAF/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_185SzQDF3c9W1elsCnocAF/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_3OZ2PC8mdLPnorXSC6FcM1/users/usr_5hGrspuG5HJZBneuWY4Rp0 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmYTliNmRjYy02MjYwLTRlNTQtODQxMy1hOWUwNDZhMmM4Y2YiLCJqdGkiOiIzMTZhYTE2OC0wNzYyLTRhMzYtYTgyZi0yNzMwYjQyY2JmZDkiLCJpYXQiOjE3ODcwNjM4NjUsIm5iZiI6MTc4NzA2Mzg2NSwiZXhwIjoxNzg3MTUwMjY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNqUHhOa0pTNE9kMUh6NkJIdGZVaWoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FNWuR8EUp3BGS5KMv_EA4dP2scU77BXUCINiE22517PR81yVsdEEiqAc_UcD_4N3n9qe2cB_Kr_5Xc3AwOW1s0_5qYTmL4fRNAuKf9aOK8LBd85Uep_Nzl8r3mPR1bsk8eJECGtE9Y29ZffHbW-vSin-wwPRl53YudatqyiZcx8XqhCq_-v-i5s0wmcuutLGQjNuS_Ly-LtbujuoWYAynfE-dhD6FARfj_kyGkMTZxzqQ9Knf-Due1yKFijGmDql0jouDetA0BmB08q9dnkmCrLhh38qZtf3Z3AaRmKiuKgRbVHyuDmavmpJOs8ZgXmfmP86k0yZBT15XPKAuVXnIgXpLaN_bjL-sKkYn3izvZ_LDvUmfYMDkN6NZyCNo7kPBqiFdFtGceimuCB_PY_IGnqYCc9eRmEkJB4lP6pZ9aieRdKg-CEELaHc4ZKRuZ1OsL_ntrB6r4rR1FzX_rLVojJthCjY4p4-_2RgXrUuqP40EmwQoK850bQOFtIVzLTz7vmrGZ6MDOdnD3v1dgutignQA0SSrcIeW_dOBGu91WcIDYATLcB-eGVMK43rLi0ITX1e9Ujqx2I9JzMbDWFv1C-up7aDS09mjyNCD3TJLdf9EqEwtgSMbf0Fo1B3pdLzqiGLYA9Ymep5lcfbcFkEvYa57B806vnddKPyRYkiL-o
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: 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_6FYFCdCXNzfhcULaeRofLQ HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkM2JjYzcxNy01ZmM4LTRmYjgtOTA2OS1hNjQ1MTQzOTE4MTIiLCJqdGkiOiI5YmMxMGE0Mi02MzBjLTQ4YTktYjRlZC0zOTA1YjVjZDU0NTYiLCJpYXQiOjE3ODcwNjM3NDksIm5iZiI6MTc4NzA2Mzc0OSwiZXhwIjoxNzg3MTUwMTQ5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzROOGVuaGRCRzhMbnc3ZlE0T3FLTXIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.NNOZ_pYmxHbvYfDLf-WRucijufwKaV4P_UU-ffLl4wB5_GZ_fgPiztY2LyFqTl7ZhXIKasny31E6R9PYOy7-80knEsbCS8J3lHb2zlKj1DmaG2yoF0eGHUeCbpN9do3AWaQJJPPV-eN9-mLh4ayTyuumu6iiduN36lczu_RuFPtU_FIVIwryOKBr6WOs21iA2Telj1b9LJxMBRSRvQjTXAAyybEVntNYMW8gw9J8mh9zTl_mg65WqQNL22optHpzK-Icu-TtGMQsqKpTFFb_54ZW1oAwUIt3dFugni1t5-Ken4Px5TxMW5HSK5UZPrUKj97hALTEUQR320Z3YFpMj6tsIDyhB1D3LBruXVin0ePsdc2X2p52uFP5ts_pfSDsUdO2LJkB92wv6rEK-KSCYGUAJNsvuHxA6PzvH2e1A2xc_5ux5_nF8vBedkJ3K52zfsN_uwI2ojwGKEc_O0Ho6C4D2gWe-zmjf1jp6PZXBsbHZ8_dMzJA6OTBEFH5MqJPHqkwWFKndRFp6X6MyhI2mH9y1HcHEw2yRmLgMZkEo3uKOx9uLeJCZDOMf1YvydOo1iC5UaMfg49o8zMd0VXe3FGatK674nuEzTXaQS17IcUosMnUm_GGsW7Hdu6N3VlkUIEckedGoKv2NEcEZEjdFfmvdJyw491l3ZN_oX2wWU0
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: 253

{
  "id" : "tgy_6FYFCdCXNzfhcULaeRofLQ",
  "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_24UJmr4dC64ZOPTmFYVYIN HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NDIyOGExYS1mMTk2LTQzNTctODNmZi1hYWJiYjQ1YzAwMTMiLCJqdGkiOiJhYzFkNWUyNy00ZTBjLTQ1MjItOTZmZC1lMzFiNTRhNDJkOTEiLCJpYXQiOjE3ODcwNjM3NTAsIm5iZiI6MTc4NzA2Mzc1MCwiZXhwIjoxNzg3MTUwMTUwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZHb25DdGZySDhNdHJEQlZxQnJLU2EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.TfhtgsJl1aoGz7Oaq8LV2W1OJudTp_cnN7Jsq4L_fqgh09b2tyCSjUZfq3wJBpcqPIuWdc6LB4FlJ3ZtGVMT9yDgq6IBWPy5s_Mj-H_8EdFdLGz1UR8gIhLBBDhVJ9JHKDu9MyLOA3ODH-AKExHiVkCN97JHDBxkGyK_hPSMjpBO3tBHHac-ENr8hOj_uX5N9zBf2tmUDY-V0Waj8JDIUefXM7t42bf8gIPRMTm69caY_dsKp9c0OURWi3iizYcRDqVTXOjpI9j71r0aU5-zaBFvSz_0kFw8HiKlWHvVejJnwnnrRqwIwQw8_ptQWraDgF7KgJQfnzTawJNPr0Az11a_dvrhnfn8wxuWKAmqFKXkXsXga9JiBRKvh1RtU7IlBT-hxfFkESF_6X9lOg9zcI6dQXX7pxJn40jLA1iqmtsg3Lbxfjea4Z4vXdhkQvKYV84pZpfJCJLHTBCzyF1rkkZ7e8wFPi9WfWrxkEU4amosa80og297WD8sBmP5RTcTpxT54E6_NI0-1W5X2GopvvyT_viNjhTCdXPLK-DlqRfd3q1euz9zlv5PmPIg82BF84zmGGmioYVilzmSIDWCbsO5Ncd-a32HlrFw9aIJYzHRE_UYk5eUHIQpqfqIjRQP9EFhqPxVrUl83YJyM6WDly95OhfbAcAEsDXwzeZ7mlI
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: 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: 253

{
  "id" : "tgy_24UJmr4dC64ZOPTmFYVYIN",
  "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.eyJhdWQiOiI4MDBkOGJiNS01MTVmLTQ3OTktYWRiOS0yN2QyM2IxZTdjM2EiLCJqdGkiOiI4MGYyYWVjNS00YmU3LTRlOTEtYmQ4Yi00NTEyYzkyYzg4ZjUiLCJpYXQiOjE3ODcwNjM3NTEsIm5iZiI6MTc4NzA2Mzc1MSwiZXhwIjoxNzg3MTUwMTUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVXeUdwWkI5dVEzdkdCa1ZTVmx6S0oiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.afEtJGEqBpG8odDedtoIZpmPJfL4lpx0OLmv5qri1K072Lo039eiUo0DBIwxhD5GFV4I-uIs9fCW4T7AqNf7Eizk6RGNFwVD5mkXDyTkTWCZtK908bldsNY8tNGb3gC8mFdTimCzyUNugYWZpNJDF-36Q76hRDLCXTuQ94rvvzTE_5M6YGr5EWOVmXerPKZL9XhwTzeU5hgNLje0VKo7QpwOXxCkVDWGPJ-NzEOzHOD6nrNPybkasLsyXyOk9g2t0_B5ekOV1N4tWBUs2BtMLAd9hb_GproOVnAAR-bmKeVo9hU0378BXDQxs-bo9ETzJuxKeapVlr2m1oG8kAW44wX7CZAUffZIIXSdsHRWKwFB5tDr0QTNaHeb09PCa0vGG-gHTiHNv2IFCaeajtsW9cgdriZ356Oj5i_BGLxs58uwvIr4cJgqxk4BOGV9aUHOW39XYpQsGCpzOkSl0JmhJ9n-XGCF-Rj9Izic75BBy1zHlrVzDVbGz-kiLYpqRLO-QbiqnF1mgglFF9Tbvn2vWcFXp6JSQK6rk9u1A_kutUpmBQr5J7bDuh6Fs0boNQfdzPM9dSjHWUlhFJz5n74T4dyQBWp7wCODeF_dRjSleYwr_F7I8lCZpwtyvl_xuWXH02PPtHXqMQ1daDxq5vMnD1IYbbM78dH6t2l9sXfq-Yw
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: 692

{
  "data" : [ {
    "id" : "tgy_KIySKECTvIK3JE8hifLi5",
    "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_4sxdCx1Oy4oOSHO0VnPq6o HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4NmM0MWViNS1kNGU2LTRiODMtYTA5Ny1iNzAyYzIyMzkwMTIiLCJqdGkiOiJiZGQ4ZDhkMi1lZjFiLTRlZjctOWVmNS02MzFjYjA0YzYyZmEiLCJpYXQiOjE3ODcwNjM3NTAsIm5iZiI6MTc4NzA2Mzc1MCwiZXhwIjoxNzg3MTUwMTUwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY0a1lHZXc4dlRkQzFrVmFwUGJNOUUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.gxq0Ds11KNwIpcKANiAycaOHvxMZZ8RrystAEpVZWmiLrp9XwiCTCxZ3rB9sXjkHPjHioXPAECdrg2EONUVIEIzUacLIHx4j87ji8am4FlyEWg6RRU-AM4Adbou811tIcUmJunynmEVi_93VfPn6HTd4YV3-dKY14Bxkpxki2l5evUK3Bma2baDJWeHOHzVUPVJ9FFjQ940GBs1WYXEvLVxY3QzI06Iy2V9dPNPd2_A4aksW00_VNiU0kDKb1fj4oNlz1gpvhm6XJcnQnvDcjaJVKHTg5RBhe65ev4nsztFDwcdCnfV3WEMNiWHETj1YGT55cFn5NhG3X0rtzjXtoYtNxpxw2k-qiB4HdmXwiK2n0PZiHjYATVWxuvcaAg7eGdP1W14fqzTna6W8z8nVl_lhbecyF4M7YhU1M87A_OpapdwNELzrVyFRs__xUz2wD6bKA9WsfiUn-r_k70ZTQD_Ptmu8co32ZftqnX2luBJyXqv2agdxFQ07Y-Su31Sv_qEVYoE_fOdBQyIwv3ay8Kw9UNzjVo1MRWh5jvK5d0npU5WyZE310wuZE_NX3rfL23MA6IQBt36m54OhmD7A8o-34_px-cxU1vWdINQkeRAyq_39MEbQjIZatEs0ZIBPgDamDLPnTiqjeNE42s55hmmc70Esk0gnMeyQIXnAIk0
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: 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.eyJhdWQiOiIwZWVjN2U5OS1iNzQ2LTQyZGItOTIyNC0yOTVlOGI4M2ZlMDgiLCJqdGkiOiJlNjMwMzdlZS01Y2FjLTRjNjMtOTU4Ny03YjYyMTNjYzczMTgiLCJpYXQiOjE3ODcwNjM4MTEsIm5iZiI6MTc4NzA2MzgxMSwiZXhwIjoxNzg3MTUwMjExLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFOcUdyb3E1Y1BPd05DaDdzd09KVGIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.FagzfVXYw7qJ-KafITwiLb1_4V7z3iarzIt6yuvzFLxuHf7RMz1c-BZo_Xlkr6BMgoUkKyo8wTgQp-XM9BrdDaKjFuwwXUQDSaHMMtJK09WOHGRTcfZPtGEQSLocXUlzFyfuRg85q1VK1aQGsP33iOAm4NpfdoQKcIBlxHYJ3KZ2gPi4HGaf_HWNnVNf58-4b27NdeEkTo1XwBnt7OqAWi-gSOzi7OkKzyGAC0AP2E0PKf1bR4FZTjLO1Ch64DY6DvhPINP6S7kOC7WeV6V7dk3AAj1nsq_HrjDe2CMq7Q1oqCDBp0AHWRNxdFvElTUQMiQLejh9OQMB1q4fD1a6H2CpojaV-JOLPnheUkOK2i1a9nOC5Z0cJVRUkUytkMJlQSc1O5mjC-XvljYcpaNXH1xBlZ5vaI0Nr_ycns55CLfQAlMOPD1Kr7cuKD5Sd6OclUlZxSSuRIat7kcsqjspyoEuVbr75_qLRPj6o1p6GUniaO2LBfCym2j28IFlDO-lkhZH7kRmj9Mec0QsFNZ6OCN_3rkcAwJRk7oNoYCEOdHjmlv9OfuB7YM_W0XcCzGPxkHUyTEuFMU8ZLs8p3mvy9v5r3NZj3LhLXadjfoByKPcLQB-iCahjfYkeG2kugcfyimkH7qznbjBeQu9LKzXKvnenBZ80cA9rmHrG4H1JIs
Content-Length: 146
Host: localhost:8080

{
  "name" : "npdt9ZTPU1",
  "email" : "NKfC9x8s@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_7jtPEQhds5meQdeDCODf3u",
  "name" : "npdt9ZTPU1",
  "email" : "NKfC9x8s@benchling.com",
  "timezone" : "UTC",
  "status" : "pending",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-08-18T14:36:51.422100Z",
  "updated_at" : "2026-08-18T14:36:51.422100Z"
}

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_1pdkwmuXab3AAFbjapNlXG HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4Mzk0MWQ5NS1jZmJmLTRhMjMtOTlhOS05OWY1MTBiNWZlYjQiLCJqdGkiOiJmMjNlYWE5ZS0xYTAxLTRmOWYtYWMzNS04NDY4NTIyYzFlNmMiLCJpYXQiOjE3ODcwNjM4MTMsIm5iZiI6MTc4NzA2MzgxMywiZXhwIjoxNzg3MTUwMjEzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1pQU0Y0b05zWmRHUlR5eGpqVm9DUiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdfQ.W-59kKhL3TRRX07Gx_xalUIYhzNElle0Td2HTRKr31yCCHvNJsHUo7n7bVcq1qzbSVWD4a5iwyEM6uhlHvOTPdQ2GDwkTWhlrbaAoARI6loQnmoAhWBak7bAP1T_Cs4fFR_GPGNS_n435PSe0P5rqIo_2YJjTu7R9nTfa8Wn0OETCqMSv_Wk79PrZCwd3_5vE-PdhSf69VQDmG0ffKa_bAfZa-N7LA8m4WbiRb6N8d6nHIQyylci98lNsxbWYUavSR1zYMS1-2OlBh2lC9El4FV6hwm10FKgdUZDCLcknRyQA1H_TSAy_fsX3zOsvSGXXryryUI1Be858rLjJhAlKRArz7ksNtwxv0V8LIPA1Ygh5zN-VaG9KQXXBoSXHiSA4Ad-njKdZhT7VZzJOKltLzonJW4JBmGZxkKuRngRst_tiG1_ma_DtMs2QYqiUKFR-OoLB-KsPT_qWMNh2CeXOfKJuLURYOMtlFwe3xvYocJNox4kTK8IChWplRCqk5LmNDFKZqxrpkbQKnWA-KO8LCB6qO2DleKPOUEIcQLoyKyuzWS21DfsW0jmIBZEswUqTlV52lomwETQKnJEFADmBbmxEwrn2nhZncrw39gvFrJUrLy-qlU4RZK5H8crHQsRr1hQutEalX6dlfE_eE4i8PSPuExY3pc3PsLtpwTUktc
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_1pdkwmuXab3AAFbjapNlXG",
  "name" : "JjCBf Overwatch",
  "email" : "om7umJkG@benchling.com",
  "timezone" : "UTC",
  "status" : "active",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-08-18T14:36:53.339621Z",
  "updated_at" : "2026-08-18T14:36:53.339621Z"
}

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_4vyn9LD73k0O8BQH2nMNAe HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxYTQ0YmM5NC00MDRkLTQwMjctYTExYi01NmI3NWFkYTQ5MmIiLCJqdGkiOiJiOTNiOGE3ZC05ZjVlLTQ0MjUtYmZlOC1hZjFhYWFlMTc0MjAiLCJpYXQiOjE3ODcwNjM4MTIsIm5iZiI6MTc4NzA2MzgxMiwiZXhwIjoxNzg3MTUwMjEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZKRjV0UzEyTEpXcklRc0MyR3JzREIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXX0.KscDcUMgBEZp4EB9WG5SMoqLfgEfTHVgLESrurL1tOcZxx5g_g4mVNWF2TxNg2Oa66Xp_eENw2ec9Dty_BF5zSQgNDNxP6PbDqn021qQM5uB6IZ2oyIK3kW-vF9O6XSla4sMWOpgGN9imarqeHeptr-_VAktHU1VV2udCXk_OJ129t52lUIiGWNoZ6WWXK577GM0-uqh8if6f06dbzsQZxdJEDGJ-VcBvlOTRDbullqRBsJykTPVyQxvT6FGjj4IxmJK1kODg4aorfPlnKBwPTAAhqdVFBnVEwWJD90KYWuiMYPnOfCoqXkk_3e9wt4XhSUYYKcVPB7EKIBwVwlohGrnbxbEjAoo2qjRzq-Vu0MQegQ05yE--tuXE4svFCL-Q4Vc9BS7hH9-VZq2Lsjvo9LI0ocxapPnSjwKynjDmZYrqHA6pnIVi2t-HM-PrBKUYmegCIbnRln6lxPE9uMQ5Os35Equy0cfcSM2y0E8VP6LecrY6b7KIUrfw4VJFNo-UPIPy68BkEK3dHpp0mVVWmO3UZ7Zpj8VJIYoW8ijxLmUqFV9GAjZgrxurNZBoj6J-4QJjVDFis9e25ButvQpG36WS9X28QM8PP34nElCfDehdHlJE2zbDMJECWEy_1cn3iXLQjYWCskXoOGlpJB4P75o-wwrAb0S2jza4lcVuz4
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_4vyn9LD73k0O8BQH2nMNAe",
  "name" : "Benchling In Vivo",
  "email" : "ItQgXY0Q@benchling.com",
  "timezone" : "Europe/London",
  "status" : "inactive",
  "metadata" : {
    "user-internal-id" : "USER-4321"
  },
  "created_at" : "2026-08-18T14:36:49.713582Z",
  "updated_at" : "2026-08-18T14:36:52.760924Z"
}

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.eyJhdWQiOiI3NDY5YWUwMC05M2EyLTQxMzYtYTgwMS02MzYxZTE4OTYwMGEiLCJqdGkiOiI2OGY2YzEwMi1iNzgxLTQ4OWUtYTFhNi00ZWE1NDdhMTkyNDUiLCJpYXQiOjE3ODcwNjM4MTEsIm5iZiI6MTc4NzA2MzgxMSwiZXhwIjoxNzg3MTUwMjExLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1dQRW1nRENCMHB0WFdhZUJlOHhNIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il19.fU3TO0n32n-p_WLpllW2Qz6B7MpUsyFzU0qGU2xUhONpGdTHdhUIuIM3qaTVIMccRXm1gJi5mvqmJOrcX99q0RvXqoi5e4UfuHW78-KffFaxdbG0wbsp92bjfQhSzcdzPK6nMnvU0egdTb1qaPJk2sRWOTh_ICCNXulMlblC-Hndf8_ecQtg_16l2Gsbt1rho4T7aIKe-37uAX3N3mLhGT5MzVWhGE7PR64S87vML15_TAVam9AZLyxBeQ2Sfk0WgDHiwD8FrGlnnKyEE4OHktijwcjQMqAodhqBJ94_FFQs1c2FIOfi5hO8HOkeEpOjlJG5ZSCFo_f3kIOJHfTdQ_PQvwlEPrBkufDC2Vr8r4xm__ZvveZ7fMa-tVe00G2tQ3gMwhnUarRzrvd3ebVkUrF6cYvhgeeI4rkdIwZsOGh44FSaRqOG7ioVtTPdiHS0TTrBpWpa-8mYubqtLuq2QoVoXJJQtqJuVd_AwqPqUbM0L5AHZstwB2YG7041HMatq228OmmQ8hxZDYTq06vuab2J_eiysFO80naPuDPqyiOjy9HEDC1wSZ_9R2LOc_nAC_1xJ184pROMkbYMQ1yFc2Wg67padfy-Td0l_EEQ1nIgqqlqx778a9eRGFIlMrISWM233XKbZLiAUEZb2C3Iw8k0ECBZVLZtERAxj-_Dhd4
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_3ihCJr5F6dIjIeReMwXsvJ",
    "name" : "3soDg Overwatch",
    "email" : "lmMHdg1D@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:36:51.587599Z",
    "updated_at" : "2026-08-18T14:36:51.587599Z"
  } ],
  "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_7LqNV8Tpziq4r13nYujB55",
  "client_id" : "5fa7bed1-6c8c-432c-a248-7b2e7f49a9a4",
  "event" : "animal.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:20.824484Z",
  "payload" : {
    "id" : "aml_4rlIkSsk7bUWRKpIHg02eE",
    "catalog" : "A0000001",
    "name" : "yDWeocsFMk",
    "number" : 1,
    "strain" : "BETv7jkSWE",
    "species" : "M50Gydek8C",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "wg0c6ajINM",
    "ear" : "nJrdBLFsog",
    "tag" : "XA1FZFXHjM",
    "donor" : "w3wQxsNBQa",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_6qp3y5fX7mSdKKxs8C5GoI",
      "project_id" : "pjt_23reBRk8IJyzlMyPplPznK",
      "name" : "GLNPrd4Wbw",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6C8bdXlsuodjcdYgCbuAP1",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "6Sfq4Hd6YG",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2ZhO7svi1QomIkl80RhFzJ",
        "name" : "yXWsmK5f68",
        "email" : "M4uxYO2i@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2ScNh5H1dFPGz907VpEQTV",
        "name" : "60fgNHY2NQ",
        "email" : "c9ptvhVv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:20.462517Z",
      "updated_at" : "2026-08-18T14:38:20.462517Z"
    },
    "study_group" : {
      "id" : "grp_5HpW9M2Sslat3heUyrnCb2",
      "study_id" : "sdy_6qp3y5fX7mSdKKxs8C5GoI",
      "name" : "C2pHIieAuk",
      "no" : 1431765428,
      "color" : "nGcGYdGRoG",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:38:20.758276Z",
      "updated_at" : "2026-08-18T14:38:20.758276Z"
    },
    "cage" : {
      "id" : "cge_7ENii6jWeaiYyuJ7wwtjDA",
      "study_id" : "sdy_6qp3y5fX7mSdKKxs8C5GoI",
      "name" : "0iIiMrQogC",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:38:20.743364Z",
      "updated_at" : "2026-08-18T14:38:20.743364Z"
    },
    "created_at" : "2026-08-18T14:38:20.765642Z",
    "updated_at" : "2026-08-18T14:38:20.765642Z"
  }
}

animal.updated

Triggered when an animal is updated.

{
  "id" : "whe_4sMJxy21FWgJUJDXUTorKM",
  "client_id" : "465400b9-d6e7-4465-8999-2429fcae5c4b",
  "event" : "animal.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.638177Z",
  "payload" : {
    "id" : "aml_6ohKiZ3rZQ8gcedeFBO5qJ",
    "catalog" : "A0000001",
    "name" : "GCvaQOehTD",
    "number" : 1,
    "strain" : "ryyc8FZzZT",
    "species" : "dIirHXHRbK",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "46ldM5plcC",
    "ear" : "jdWHtC01Ry",
    "tag" : "r42MxfLFW4",
    "donor" : "NbfmruMLzL",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_5tdiFAf1HmdsKDirdxZJbI",
      "name" : "aJxvgbsE0k",
      "email" : "hQNYwOKn@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3oQVOwei1CgaPg4uPtOqfk",
      "title" : "Found dead",
      "comment" : "kSy2o1k7dC"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "project_id" : "pjt_3HS4McM9TtoSi78VqdT4YN",
      "name" : "rTBg2auv88",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2yl1WzuNcC8vbFziuSLeHO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "kFQKTYkQNP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5wuGWu3t2mosuVRpIi2mnG",
        "name" : "VL78s2Lvf6",
        "email" : "1p0pun3f@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1x1dUQRyzBRovPVp9IyNs0",
        "name" : "LkZsFl7XR0",
        "email" : "884JNCtV@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.215100Z",
      "updated_at" : "2026-08-18T14:38:15.215100Z"
    },
    "study_group" : {
      "id" : "grp_2ElzBOqOPPm6K0GDVliWu6",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "yl4SBf0gqn",
      "no" : 491752755,
      "color" : "T11z9fF1Yt",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:38:15.459793Z",
      "updated_at" : "2026-08-18T14:38:15.459793Z"
    },
    "cage" : {
      "id" : "cge_5FBCssLBXKx9yRmOlv8TDv",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "rOQCjLIhPF",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:38:15.449093Z",
      "updated_at" : "2026-08-18T14:38:15.449093Z"
    },
    "created_at" : "2026-08-18T14:38:15.464473Z",
    "updated_at" : "2026-08-18T14:38:15.464473Z"
  }
}

animal.deleted

Triggered when an animal is deleted.

{
  "id" : "whe_6iqgRRVqld7oWPJWdZpuIn",
  "client_id" : "c366c11a-e265-434f-b71d-a7e4cbaeca41",
  "event" : "animal.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.641987Z",
  "payload" : {
    "id" : "aml_6ohKiZ3rZQ8gcedeFBO5qJ",
    "catalog" : "A0000001",
    "name" : "GCvaQOehTD",
    "number" : 1,
    "strain" : "ryyc8FZzZT",
    "species" : "dIirHXHRbK",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "46ldM5plcC",
    "ear" : "jdWHtC01Ry",
    "tag" : "r42MxfLFW4",
    "donor" : "NbfmruMLzL",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_5tdiFAf1HmdsKDirdxZJbI",
      "name" : "aJxvgbsE0k",
      "email" : "hQNYwOKn@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3oQVOwei1CgaPg4uPtOqfk",
      "title" : "Found dead",
      "comment" : "kSy2o1k7dC"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "project_id" : "pjt_3HS4McM9TtoSi78VqdT4YN",
      "name" : "rTBg2auv88",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2yl1WzuNcC8vbFziuSLeHO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "kFQKTYkQNP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5wuGWu3t2mosuVRpIi2mnG",
        "name" : "VL78s2Lvf6",
        "email" : "1p0pun3f@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1x1dUQRyzBRovPVp9IyNs0",
        "name" : "LkZsFl7XR0",
        "email" : "884JNCtV@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.215100Z",
      "updated_at" : "2026-08-18T14:38:15.215100Z"
    },
    "study_group" : {
      "id" : "grp_2ElzBOqOPPm6K0GDVliWu6",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "yl4SBf0gqn",
      "no" : 491752755,
      "color" : "T11z9fF1Yt",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:38:15.459793Z",
      "updated_at" : "2026-08-18T14:38:15.459793Z"
    },
    "cage" : {
      "id" : "cge_5FBCssLBXKx9yRmOlv8TDv",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "rOQCjLIhPF",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:38:15.449093Z",
      "updated_at" : "2026-08-18T14:38:15.449093Z"
    },
    "created_at" : "2026-08-18T14:38:15.464473Z",
    "updated_at" : "2026-08-18T14:38:15.464473Z"
  }
}

animal.metadata.updated

Triggered when an animal metadata is updated.

{
  "id" : "whe_6JsYHDE9pRl6rBKZyVGrPH",
  "client_id" : "6d7743d1-87b0-4764-a83e-04bfd318230f",
  "event" : "animal.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.643384Z",
  "payload" : {
    "id" : "aml_6ohKiZ3rZQ8gcedeFBO5qJ",
    "catalog" : "A0000001",
    "name" : "GCvaQOehTD",
    "number" : 1,
    "strain" : "ryyc8FZzZT",
    "species" : "dIirHXHRbK",
    "sex" : "m",
    "dob" : "2026-08-17",
    "tail" : "46ldM5plcC",
    "ear" : "jdWHtC01Ry",
    "tag" : "r42MxfLFW4",
    "donor" : "NbfmruMLzL",
    "tracking_date" : "2026-08-18",
    "disease_induction_date" : "2026-08-18",
    "terminated_at" : "2026-08-18",
    "terminated_by" : {
      "id" : "usr_5tdiFAf1HmdsKDirdxZJbI",
      "name" : "aJxvgbsE0k",
      "email" : "hQNYwOKn@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3oQVOwei1CgaPg4uPtOqfk",
      "title" : "Found dead",
      "comment" : "kSy2o1k7dC"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "project_id" : "pjt_3HS4McM9TtoSi78VqdT4YN",
      "name" : "rTBg2auv88",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2yl1WzuNcC8vbFziuSLeHO",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "kFQKTYkQNP",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5wuGWu3t2mosuVRpIi2mnG",
        "name" : "VL78s2Lvf6",
        "email" : "1p0pun3f@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1x1dUQRyzBRovPVp9IyNs0",
        "name" : "LkZsFl7XR0",
        "email" : "884JNCtV@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.215100Z",
      "updated_at" : "2026-08-18T14:38:15.215100Z"
    },
    "study_group" : {
      "id" : "grp_2ElzBOqOPPm6K0GDVliWu6",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "yl4SBf0gqn",
      "no" : 491752755,
      "color" : "T11z9fF1Yt",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-08-18T14:38:15.459793Z",
      "updated_at" : "2026-08-18T14:38:15.459793Z"
    },
    "cage" : {
      "id" : "cge_5FBCssLBXKx9yRmOlv8TDv",
      "study_id" : "sdy_3OxzC8Yma8YWSaYfRwmSPv",
      "name" : "rOQCjLIhPF",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-08-18T14:38:15.449093Z",
      "updated_at" : "2026-08-18T14:38:15.449093Z"
    },
    "created_at" : "2026-08-18T14:38:15.464473Z",
    "updated_at" : "2026-08-18T14:38:15.464473Z"
  }
}

Animal Dosage

animal.dosage.created

Triggered when an animal dosage is created.

{
  "id" : "whe_2mylMrbAJ18lOybt3MZunk",
  "client_id" : "3babee11-8497-485a-a8a4-0e3c494628d1",
  "event" : "animal.dosage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:14.732365Z",
  "payload" : {
    "id" : "dsg_4SPJ3edGX0McUYfW54EoKx",
    "name" : "Example dosage",
    "dosed_at" : "2026-08-18T14:38:14.427837Z",
    "comments" : "zeUDJGwJ6D",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "9.55",
      "display_unit" : "mg/kg",
      "display_value" : "9.55"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "16.54",
      "display_unit" : "ml/kg",
      "display_value" : "16.54"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "24.35",
      "display_unit" : "mg/ml",
      "display_value" : "24.35"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "33.92",
      "display_unit" : "µL",
      "display_value" : "33.92"
    },
    "study" : {
      "id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "project_id" : "pjt_6sXTuwmPArkpYBtibv1SHD",
      "name" : "VaG75p6rPc",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7J2iau8kHHdMu1JT1evkzH",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "3h4RZBRFM3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1Tjy6k9GGI1CEVHQ5MT2iB",
        "name" : "CsPQlsZxBS",
        "email" : "O2jJka15@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_wpwMjqzM1QONAYLJ0EoQQ",
        "name" : "3Agp3PKXV7",
        "email" : "gf6ueR7t@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:14.156182Z",
      "updated_at" : "2026-08-18T14:38:14.156182Z"
    },
    "animal" : {
      "id" : "aml_74ahxnMsmYH3hGimZIJHrk",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "study_group_id" : "grp_5Y4c1Oqw3kzldGrr37Gs2w",
      "cage_id" : "cge_1MhSSnyN3bpRvDjPvOoUK6",
      "catalog" : "A0000001",
      "name" : "6DCnX8HT26",
      "number" : 1,
      "strain" : "tfydO01lQw",
      "species" : "OhBuPklmtN",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "2LJ0JMLkDh",
      "ear" : "7j565v7NC1",
      "tag" : "WAcgSPsxmZ",
      "donor" : "0b9v7rPEwj",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:14.401188Z",
      "updated_at" : "2026-08-18T14:38:14.401188Z",
      "disease_induction_date" : "2026-08-18"
    },
    "measurement" : {
      "id" : "mst_3Azkc53JPAPfgkwCmfpg07",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "animal_id" : "aml_74ahxnMsmYH3hGimZIJHrk",
      "measured_at" : "2026-08-18",
      "calculations" : [ {
        "id" : "vbl_5iXttn5RtPfJOXDAKRNWIs",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_tkS4pttD1SktmWicgpXbR",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_4TugMvnlH47ZZ9NlibuMNH",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_67ELGtvwruqExSzTCHmxjr",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_67ELGtvwruqExSzTCHmxjr",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-08-18T14:38:14.410530Z",
      "updated_at" : "2026-08-18T14:38:14.410530Z"
    },
    "user" : {
      "id" : "usr_1BuF9XeOrPv7tl99MP0OJc",
      "name" : "SAn2H Overwatch",
      "email" : "FivXxN0l@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:38:14.134707Z",
      "updated_at" : "2026-08-18T14:38:14.134707Z"
    },
    "treatment" : {
      "id" : "tmt_2zgX4iMPzyy1XsD5IDCRj9",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "type" : "dose_volume",
      "name" : "7bMU6JIdXJ",
      "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-08-18T14:38:14.420146Z",
      "updated_at" : "2026-08-18T14:38:14.420146Z",
      "external_entity_id" : "Lllvg6Jt3y"
    },
    "created_at" : "2026-08-18T14:38:14.428102Z",
    "updated_at" : "2026-08-18T14:38:14.428102Z"
  }
}

animal.dosage.deleted

Triggered when an animal dosage is deleted.

{
  "id" : "whe_3eQfAV0ZkEVsWuM6ev0l38",
  "client_id" : "757208a7-2c17-4d9b-b782-daa5fb25f740",
  "event" : "animal.dosage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:14.738207Z",
  "payload" : {
    "id" : "dsg_4SPJ3edGX0McUYfW54EoKx",
    "name" : "Example dosage",
    "dosed_at" : "2026-08-18T14:38:14.427837Z",
    "comments" : "zeUDJGwJ6D",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "9.55",
      "display_unit" : "mg/kg",
      "display_value" : "9.55"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "16.54",
      "display_unit" : "ml/kg",
      "display_value" : "16.54"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "24.35",
      "display_unit" : "mg/ml",
      "display_value" : "24.35"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "33.92",
      "display_unit" : "µL",
      "display_value" : "33.92"
    },
    "study" : {
      "id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "project_id" : "pjt_6sXTuwmPArkpYBtibv1SHD",
      "name" : "VaG75p6rPc",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7J2iau8kHHdMu1JT1evkzH",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "3h4RZBRFM3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1Tjy6k9GGI1CEVHQ5MT2iB",
        "name" : "CsPQlsZxBS",
        "email" : "O2jJka15@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_wpwMjqzM1QONAYLJ0EoQQ",
        "name" : "3Agp3PKXV7",
        "email" : "gf6ueR7t@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:14.156182Z",
      "updated_at" : "2026-08-18T14:38:14.156182Z"
    },
    "animal" : {
      "id" : "aml_74ahxnMsmYH3hGimZIJHrk",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "study_group_id" : "grp_5Y4c1Oqw3kzldGrr37Gs2w",
      "cage_id" : "cge_1MhSSnyN3bpRvDjPvOoUK6",
      "catalog" : "A0000001",
      "name" : "6DCnX8HT26",
      "number" : 1,
      "strain" : "tfydO01lQw",
      "species" : "OhBuPklmtN",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "2LJ0JMLkDh",
      "ear" : "7j565v7NC1",
      "tag" : "WAcgSPsxmZ",
      "donor" : "0b9v7rPEwj",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:14.401188Z",
      "updated_at" : "2026-08-18T14:38:14.401188Z",
      "disease_induction_date" : "2026-08-18"
    },
    "measurement" : {
      "id" : "mst_3Azkc53JPAPfgkwCmfpg07",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "animal_id" : "aml_74ahxnMsmYH3hGimZIJHrk",
      "measured_at" : "2026-08-18",
      "calculations" : [ {
        "id" : "vbl_5iXttn5RtPfJOXDAKRNWIs",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_tkS4pttD1SktmWicgpXbR",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_4TugMvnlH47ZZ9NlibuMNH",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_67ELGtvwruqExSzTCHmxjr",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ {
          "id" : "vbl_67ELGtvwruqExSzTCHmxjr",
          "key" : "weight",
          "value" : "55",
          "unit" : "g"
        } ]
      } ],
      "created_at" : "2026-08-18T14:38:14.410530Z",
      "updated_at" : "2026-08-18T14:38:14.410530Z"
    },
    "user" : {
      "id" : "usr_1BuF9XeOrPv7tl99MP0OJc",
      "name" : "SAn2H Overwatch",
      "email" : "FivXxN0l@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:38:14.134707Z",
      "updated_at" : "2026-08-18T14:38:14.134707Z"
    },
    "treatment" : {
      "id" : "tmt_2zgX4iMPzyy1XsD5IDCRj9",
      "study_id" : "sdy_4qBXYp5Muy51Em6w5cglJN",
      "type" : "dose_volume",
      "name" : "7bMU6JIdXJ",
      "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-08-18T14:38:14.420146Z",
      "updated_at" : "2026-08-18T14:38:14.420146Z",
      "external_entity_id" : "Lllvg6Jt3y"
    },
    "created_at" : "2026-08-18T14:38:14.428102Z",
    "updated_at" : "2026-08-18T14:38:14.428102Z"
  }
}

Animal Measurement

animal.measurement.created

Triggered when an animal measurement is created.

{
  "id" : "whe_67ZMexsxNaCK1A7kKS56K3",
  "client_id" : "3b1c7d5b-3a69-4510-9fba-28d2388fcd1f",
  "event" : "animal.measurement.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:21.211739Z",
  "payload" : {
    "id" : "mst_1TsN5RapPRYSOpMToDUPnI",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_46Mo9f0IqdruftzvSOIaTt",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_yJHP91Fqu0XYo4TFUrXgW",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_2wuugHz2OYcQv0xyrETsBP",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "project_id" : "pjt_WI1JRLTemGtqeGEQZVMEw",
      "name" : "cVuJQEPoaH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6qX2MQ10YQkGXsqECUE6Pa",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "Vgveb8MI5X",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2hC1oWUvkOvmg1tI4uq1XQ",
        "name" : "cfWRIDEPJa",
        "email" : "28Mpz3BN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7EeezyxwezyAO6ooKUbhZh",
        "name" : "0KYpFXfvTw",
        "email" : "AFB0VypA@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:20.850971Z",
      "updated_at" : "2026-08-18T14:38:20.850971Z"
    },
    "animal" : {
      "id" : "aml_7VZfRUI4LwevYeItlJQaBf",
      "study_id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "study_group_id" : "grp_62WihbjAa2jEFSTm9k8tM3",
      "cage_id" : "cge_3BFEqAXBqTI7OB8RYCr2Ye",
      "catalog" : "A0000001",
      "name" : "XjLuQl4eLO",
      "number" : 1,
      "strain" : "QJwBxVoy4d",
      "species" : "HUPcMZxoUN",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "L3rY7qj0QD",
      "ear" : "e6sDq6mKHp",
      "tag" : "GNcnOJ4Co0",
      "donor" : "QMZbXf0Gh5",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:21.085107Z",
      "updated_at" : "2026-08-18T14:38:21.085107Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4zVlnBxotzrFx2QLQtYAZR",
      "name" : "vdxqM9ili3",
      "email" : "PZox46z4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-08-18T14:38:20.836871Z",
      "updated_at" : "2026-08-18T14:38:20.836871Z"
    },
    "created_at" : "2026-08-18T14:38:21.095143Z",
    "updated_at" : "2026-08-18T14:38:21.095143Z"
  }
}

animal.measurement.updated

Triggered when an animal measurement is updated.

{
  "id" : "whe_6Oiar2Bz7GPLQ9PG5LljeE",
  "client_id" : "2956a78d-82ca-48b4-a1c1-4856bfd1cb13",
  "event" : "animal.measurement.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:21.215646Z",
  "payload" : {
    "id" : "mst_1TsN5RapPRYSOpMToDUPnI",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_46Mo9f0IqdruftzvSOIaTt",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_yJHP91Fqu0XYo4TFUrXgW",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_2wuugHz2OYcQv0xyrETsBP",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "project_id" : "pjt_WI1JRLTemGtqeGEQZVMEw",
      "name" : "cVuJQEPoaH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6qX2MQ10YQkGXsqECUE6Pa",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "Vgveb8MI5X",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2hC1oWUvkOvmg1tI4uq1XQ",
        "name" : "cfWRIDEPJa",
        "email" : "28Mpz3BN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7EeezyxwezyAO6ooKUbhZh",
        "name" : "0KYpFXfvTw",
        "email" : "AFB0VypA@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:20.850971Z",
      "updated_at" : "2026-08-18T14:38:20.850971Z"
    },
    "animal" : {
      "id" : "aml_7VZfRUI4LwevYeItlJQaBf",
      "study_id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "study_group_id" : "grp_62WihbjAa2jEFSTm9k8tM3",
      "cage_id" : "cge_3BFEqAXBqTI7OB8RYCr2Ye",
      "catalog" : "A0000001",
      "name" : "XjLuQl4eLO",
      "number" : 1,
      "strain" : "QJwBxVoy4d",
      "species" : "HUPcMZxoUN",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "L3rY7qj0QD",
      "ear" : "e6sDq6mKHp",
      "tag" : "GNcnOJ4Co0",
      "donor" : "QMZbXf0Gh5",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:21.085107Z",
      "updated_at" : "2026-08-18T14:38:21.085107Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4zVlnBxotzrFx2QLQtYAZR",
      "name" : "vdxqM9ili3",
      "email" : "PZox46z4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-08-18T14:38:20.836871Z",
      "updated_at" : "2026-08-18T14:38:20.836871Z"
    },
    "created_at" : "2026-08-18T14:38:21.095143Z",
    "updated_at" : "2026-08-18T14:38:21.095143Z"
  }
}

animal.measurement.deleted

Triggered when an animal measurement is delete.

{
  "id" : "whe_73WnwLXPQriMlyPAaHDyc4",
  "client_id" : "3fd4bb7d-7b50-440c-9cd9-f2cab8799ace",
  "event" : "animal.measurement.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:21.219127Z",
  "payload" : {
    "id" : "mst_1TsN5RapPRYSOpMToDUPnI",
    "measured_at" : "2026-08-18",
    "calculations" : [ {
      "id" : "vbl_46Mo9f0IqdruftzvSOIaTt",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_yJHP91Fqu0XYo4TFUrXgW",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_2wuugHz2OYcQv0xyrETsBP",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ {
        "id" : "vbl_1fXe5tOSiTmtBjIhJosCaj",
        "key" : "weight",
        "value" : "55",
        "unit" : "g"
      } ]
    } ],
    "study" : {
      "id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "project_id" : "pjt_WI1JRLTemGtqeGEQZVMEw",
      "name" : "cVuJQEPoaH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6qX2MQ10YQkGXsqECUE6Pa",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "Vgveb8MI5X",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2hC1oWUvkOvmg1tI4uq1XQ",
        "name" : "cfWRIDEPJa",
        "email" : "28Mpz3BN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7EeezyxwezyAO6ooKUbhZh",
        "name" : "0KYpFXfvTw",
        "email" : "AFB0VypA@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:20.850971Z",
      "updated_at" : "2026-08-18T14:38:20.850971Z"
    },
    "animal" : {
      "id" : "aml_7VZfRUI4LwevYeItlJQaBf",
      "study_id" : "sdy_2sCwtyO9V9STN9dChMV5Pl",
      "study_group_id" : "grp_62WihbjAa2jEFSTm9k8tM3",
      "cage_id" : "cge_3BFEqAXBqTI7OB8RYCr2Ye",
      "catalog" : "A0000001",
      "name" : "XjLuQl4eLO",
      "number" : 1,
      "strain" : "QJwBxVoy4d",
      "species" : "HUPcMZxoUN",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "L3rY7qj0QD",
      "ear" : "e6sDq6mKHp",
      "tag" : "GNcnOJ4Co0",
      "donor" : "QMZbXf0Gh5",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:21.085107Z",
      "updated_at" : "2026-08-18T14:38:21.085107Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4zVlnBxotzrFx2QLQtYAZR",
      "name" : "vdxqM9ili3",
      "email" : "PZox46z4@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-08-18T14:38:20.836871Z",
      "updated_at" : "2026-08-18T14:38:20.836871Z"
    },
    "created_at" : "2026-08-18T14:38:21.095143Z",
    "updated_at" : "2026-08-18T14:38:21.095143Z"
  }
}

Animal Observation

animal.observation.created

Triggered when an animal observation is created.

{
  "id" : "whe_4dPYXLD6749pzVyZaFyI2E",
  "client_id" : "4f0401ea-4798-40fd-84aa-6ae1c10fd5ec",
  "event" : "animal.observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.971942Z",
  "payload" : {
    "id" : "obs_2PDO7chWR6PXHu8HRFiH4Y",
    "glossary_id" : "gly_2PL05DGXIlHHHbqmUQuG1H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-08-18T14:38:16.904111Z",
    "study" : {
      "id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "project_id" : "pjt_56A2PPBcJArdn2nfpkkzfL",
      "name" : "Qxa3iRAd3q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1WQvao4UDmkKcyB7CFNAAe",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "J0n7yQc9hd",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4iVRWqnTA8q94ONAUbNTRE",
        "name" : "on1jGuJq0U",
        "email" : "JPeFkciv@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_49b2HQ88lLeuVzjUjCiA4V",
        "name" : "w4TztEqBfX",
        "email" : "jwEuh0rj@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:16.531361Z",
      "updated_at" : "2026-08-18T14:38:16.531361Z"
    },
    "animal" : {
      "id" : "aml_3Vy7D8TpXV2K3KTQtBTl8f",
      "study_id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "study_group_id" : "grp_4gL5bBfwr9OOCPCJ4hiqUa",
      "cage_id" : "cge_5nYxb1fjnEr12t251bDhWu",
      "catalog" : "A0000001",
      "name" : "CBtQi3uMfp",
      "number" : 1,
      "strain" : "pYIZ5mjBod",
      "species" : "dkt3h2AJIs",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "Gtm7NAyEbz",
      "ear" : "559oS0LfMr",
      "tag" : "lIq2KdtWqR",
      "donor" : "m6prF4FP0i",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_3XJqMUfoW7Gg9o507pB9tE",
        "name" : "Jvp4nDnfDY",
        "email" : "FZzGbnis@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1o13xvZeYLUc2ZFr0Vx50s",
        "title" : "Found dead",
        "comment" : "spnuToTc3W"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:16.770324Z",
      "updated_at" : "2026-08-18T14:38:16.770324Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_2LLzi4x3nUa2JvePFyb1vy",
      "name" : "x2ean Overwatch",
      "email" : "pdsRIlNI@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:38:16.507078Z",
      "updated_at" : "2026-08-18T14:38:16.507078Z"
    },
    "created_at" : "2026-08-18T14:38:16.904325Z",
    "updated_at" : "2026-08-18T14:38:16.904325Z"
  }
}

animal.observation.updated

Triggered when an animal observation is updated.

{
  "id" : "whe_7S9djTfoVZ2aWqLjwWF2d0",
  "client_id" : "395bd1d6-6c49-4518-a402-2370f11d9761",
  "event" : "animal.observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.973827Z",
  "payload" : {
    "id" : "obs_2PDO7chWR6PXHu8HRFiH4Y",
    "glossary_id" : "gly_2PL05DGXIlHHHbqmUQuG1H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-08-18T14:38:16.904111Z",
    "study" : {
      "id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "project_id" : "pjt_56A2PPBcJArdn2nfpkkzfL",
      "name" : "Qxa3iRAd3q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1WQvao4UDmkKcyB7CFNAAe",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "J0n7yQc9hd",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4iVRWqnTA8q94ONAUbNTRE",
        "name" : "on1jGuJq0U",
        "email" : "JPeFkciv@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_49b2HQ88lLeuVzjUjCiA4V",
        "name" : "w4TztEqBfX",
        "email" : "jwEuh0rj@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:16.531361Z",
      "updated_at" : "2026-08-18T14:38:16.531361Z"
    },
    "animal" : {
      "id" : "aml_3Vy7D8TpXV2K3KTQtBTl8f",
      "study_id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "study_group_id" : "grp_4gL5bBfwr9OOCPCJ4hiqUa",
      "cage_id" : "cge_5nYxb1fjnEr12t251bDhWu",
      "catalog" : "A0000001",
      "name" : "CBtQi3uMfp",
      "number" : 1,
      "strain" : "pYIZ5mjBod",
      "species" : "dkt3h2AJIs",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "Gtm7NAyEbz",
      "ear" : "559oS0LfMr",
      "tag" : "lIq2KdtWqR",
      "donor" : "m6prF4FP0i",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_3XJqMUfoW7Gg9o507pB9tE",
        "name" : "Jvp4nDnfDY",
        "email" : "FZzGbnis@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1o13xvZeYLUc2ZFr0Vx50s",
        "title" : "Found dead",
        "comment" : "spnuToTc3W"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:16.770324Z",
      "updated_at" : "2026-08-18T14:38:16.770324Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_2LLzi4x3nUa2JvePFyb1vy",
      "name" : "x2ean Overwatch",
      "email" : "pdsRIlNI@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:38:16.507078Z",
      "updated_at" : "2026-08-18T14:38:16.507078Z"
    },
    "created_at" : "2026-08-18T14:38:16.904325Z",
    "updated_at" : "2026-08-18T14:38:16.904325Z"
  }
}

animal.observation.deleted

Triggered when an animal observation is deleted.

{
  "id" : "whe_4oxOmotwfTXthKn8dXLeBS",
  "client_id" : "21a724f9-57a5-4ebb-8952-b6908d5b768b",
  "event" : "animal.observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.974904Z",
  "payload" : {
    "id" : "obs_2PDO7chWR6PXHu8HRFiH4Y",
    "glossary_id" : "gly_2PL05DGXIlHHHbqmUQuG1H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-08-18T14:38:16.904111Z",
    "study" : {
      "id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "project_id" : "pjt_56A2PPBcJArdn2nfpkkzfL",
      "name" : "Qxa3iRAd3q",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1WQvao4UDmkKcyB7CFNAAe",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "J0n7yQc9hd",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_4iVRWqnTA8q94ONAUbNTRE",
        "name" : "on1jGuJq0U",
        "email" : "JPeFkciv@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_49b2HQ88lLeuVzjUjCiA4V",
        "name" : "w4TztEqBfX",
        "email" : "jwEuh0rj@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:16.531361Z",
      "updated_at" : "2026-08-18T14:38:16.531361Z"
    },
    "animal" : {
      "id" : "aml_3Vy7D8TpXV2K3KTQtBTl8f",
      "study_id" : "sdy_6uwPmbNlniSnAp1s2pj8ou",
      "study_group_id" : "grp_4gL5bBfwr9OOCPCJ4hiqUa",
      "cage_id" : "cge_5nYxb1fjnEr12t251bDhWu",
      "catalog" : "A0000001",
      "name" : "CBtQi3uMfp",
      "number" : 1,
      "strain" : "pYIZ5mjBod",
      "species" : "dkt3h2AJIs",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "Gtm7NAyEbz",
      "ear" : "559oS0LfMr",
      "tag" : "lIq2KdtWqR",
      "donor" : "m6prF4FP0i",
      "tracking_date" : "2026-08-18",
      "terminated_at" : "2026-08-18",
      "terminated_by" : {
        "id" : "usr_3XJqMUfoW7Gg9o507pB9tE",
        "name" : "Jvp4nDnfDY",
        "email" : "FZzGbnis@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_1o13xvZeYLUc2ZFr0Vx50s",
        "title" : "Found dead",
        "comment" : "spnuToTc3W"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:16.770324Z",
      "updated_at" : "2026-08-18T14:38:16.770324Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_2LLzi4x3nUa2JvePFyb1vy",
      "name" : "x2ean Overwatch",
      "email" : "pdsRIlNI@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-08-18T14:38:16.507078Z",
      "updated_at" : "2026-08-18T14:38:16.507078Z"
    },
    "created_at" : "2026-08-18T14:38:16.904325Z",
    "updated_at" : "2026-08-18T14:38:16.904325Z"
  }
}

Animal Sample

animal.sample.created

Triggered when an animal sample is created.

{
  "id" : "whe_6xW9LBigVdaotUhxBPvub4",
  "client_id" : "654a3875-091a-49cf-a8f9-ce7d90353f71",
  "event" : "animal.sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:17.848851Z",
  "payload" : {
    "id" : "spl_k0onWqe3BJjI0MRLIvZEM",
    "sample_id" : "S2106531198",
    "sample_definition_id" : "sdf_KYkhICZsVDCnKdX6t0lLo",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:38:17.776261Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-369029078" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "project_id" : "pjt_8srsVY2bhaDdBjOwee09k",
      "name" : "kqu2GkZtxH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MBiccsokZI8RIxm1GeCMi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "AMuJBuY7Kv",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Nj1ifejUaHxJiWbpLTNDh",
        "name" : "T5eslhKtg3",
        "email" : "t8yQOQLU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4n79dqC1lZSIa9DE3wkLC7",
        "name" : "agV2EjaG7z",
        "email" : "HBXJn4O6@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.386354Z",
      "updated_at" : "2026-08-18T14:38:17.386354Z"
    },
    "animal" : {
      "id" : "aml_Rr4cA0lwC1mTgBEdoHFzS",
      "study_id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "study_group_id" : "grp_6HjNxfp7EZvqjBnSWoF6pc",
      "cage_id" : "cge_1vkySOFdowgYJVGjzVnpvc",
      "catalog" : "A0000001",
      "name" : "ieG5WHNMP3",
      "number" : 1,
      "strain" : "oFwy6XSsly",
      "species" : "QySOrz77Ui",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "lkUyRIS0rH",
      "ear" : "dSESxeS7EX",
      "tag" : "PT4LruiZiu",
      "donor" : "YUNOAgUe9N",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:17.662332Z",
      "updated_at" : "2026-08-18T14:38:17.662332Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4ZfubLb3e2CEGapwFSkBHj",
      "name" : "cZHdfioONx",
      "email" : "3QupGJ6k@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "vJBufylC3F" : "iiLudUvsv2"
      },
      "created_at" : "2026-08-18T14:38:17.762355Z",
      "updated_at" : "2026-08-18T14:38:17.762355Z"
    },
    "created_at" : "2026-08-18T14:38:17.776511Z",
    "updated_at" : "2026-08-18T14:38:17.776511Z"
  }
}

animal.sample.updated

Triggered when an animal sample is updated.

{
  "id" : "whe_78ioWrhRuaYsjkFwdaBdps",
  "client_id" : "3fb653f1-4366-4fc0-a4a6-93cd900c3b2e",
  "event" : "animal.sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:17.851825Z",
  "payload" : {
    "id" : "spl_k0onWqe3BJjI0MRLIvZEM",
    "sample_id" : "S2106531198",
    "sample_definition_id" : "sdf_KYkhICZsVDCnKdX6t0lLo",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:38:17.776261Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-369029078" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "project_id" : "pjt_8srsVY2bhaDdBjOwee09k",
      "name" : "kqu2GkZtxH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MBiccsokZI8RIxm1GeCMi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "AMuJBuY7Kv",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Nj1ifejUaHxJiWbpLTNDh",
        "name" : "T5eslhKtg3",
        "email" : "t8yQOQLU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4n79dqC1lZSIa9DE3wkLC7",
        "name" : "agV2EjaG7z",
        "email" : "HBXJn4O6@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.386354Z",
      "updated_at" : "2026-08-18T14:38:17.386354Z"
    },
    "animal" : {
      "id" : "aml_Rr4cA0lwC1mTgBEdoHFzS",
      "study_id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "study_group_id" : "grp_6HjNxfp7EZvqjBnSWoF6pc",
      "cage_id" : "cge_1vkySOFdowgYJVGjzVnpvc",
      "catalog" : "A0000001",
      "name" : "ieG5WHNMP3",
      "number" : 1,
      "strain" : "oFwy6XSsly",
      "species" : "QySOrz77Ui",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "lkUyRIS0rH",
      "ear" : "dSESxeS7EX",
      "tag" : "PT4LruiZiu",
      "donor" : "YUNOAgUe9N",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:17.662332Z",
      "updated_at" : "2026-08-18T14:38:17.662332Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4ZfubLb3e2CEGapwFSkBHj",
      "name" : "cZHdfioONx",
      "email" : "3QupGJ6k@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "vJBufylC3F" : "iiLudUvsv2"
      },
      "created_at" : "2026-08-18T14:38:17.762355Z",
      "updated_at" : "2026-08-18T14:38:17.762355Z"
    },
    "created_at" : "2026-08-18T14:38:17.776511Z",
    "updated_at" : "2026-08-18T14:38:17.776511Z"
  }
}

animal.sample.deleted

Triggered when an animal sample is deleted.

{
  "id" : "whe_3FP7d3gKOIFr0TlTJbB9w4",
  "client_id" : "d4a58546-7778-46d8-b676-8d8f7a6445fc",
  "event" : "animal.sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:17.853933Z",
  "payload" : {
    "id" : "spl_k0onWqe3BJjI0MRLIvZEM",
    "sample_id" : "S2106531198",
    "sample_definition_id" : "sdf_KYkhICZsVDCnKdX6t0lLo",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-08-18T16:38:17.776261Z",
    "details" : [ {
      "key" : "volume",
      "value" : "5",
      "unit" : "ml"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-369029078" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "project_id" : "pjt_8srsVY2bhaDdBjOwee09k",
      "name" : "kqu2GkZtxH",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7MBiccsokZI8RIxm1GeCMi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "AMuJBuY7Kv",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Nj1ifejUaHxJiWbpLTNDh",
        "name" : "T5eslhKtg3",
        "email" : "t8yQOQLU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4n79dqC1lZSIa9DE3wkLC7",
        "name" : "agV2EjaG7z",
        "email" : "HBXJn4O6@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.386354Z",
      "updated_at" : "2026-08-18T14:38:17.386354Z"
    },
    "animal" : {
      "id" : "aml_Rr4cA0lwC1mTgBEdoHFzS",
      "study_id" : "sdy_5ZzpislFOMoVo4AbTDH81t",
      "study_group_id" : "grp_6HjNxfp7EZvqjBnSWoF6pc",
      "cage_id" : "cge_1vkySOFdowgYJVGjzVnpvc",
      "catalog" : "A0000001",
      "name" : "ieG5WHNMP3",
      "number" : 1,
      "strain" : "oFwy6XSsly",
      "species" : "QySOrz77Ui",
      "sex" : "m",
      "dob" : "2026-08-17",
      "tail" : "lkUyRIS0rH",
      "ear" : "dSESxeS7EX",
      "tag" : "PT4LruiZiu",
      "donor" : "YUNOAgUe9N",
      "tracking_date" : "2026-08-18",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-08-18T14:38:17.662332Z",
      "updated_at" : "2026-08-18T14:38:17.662332Z",
      "disease_induction_date" : "2026-08-18"
    },
    "user" : {
      "id" : "usr_4ZfubLb3e2CEGapwFSkBHj",
      "name" : "cZHdfioONx",
      "email" : "3QupGJ6k@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "vJBufylC3F" : "iiLudUvsv2"
      },
      "created_at" : "2026-08-18T14:38:17.762355Z",
      "updated_at" : "2026-08-18T14:38:17.762355Z"
    },
    "created_at" : "2026-08-18T14:38:17.776511Z",
    "updated_at" : "2026-08-18T14:38:17.776511Z"
  }
}

Cage

cage.created

Triggered when an cage is created.

{
  "id" : "whe_2HoSrQFhGMRt4QA7BMyIB0",
  "client_id" : "b23ad67e-95de-49c2-a450-e1fe08a23695",
  "event" : "cage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.313339Z",
  "payload" : {
    "id" : "cge_3hNUCWfMv88RJZQDlGFB8H",
    "name" : "fEkSyqbNGN",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_6KnficnnFdC2PMc8ywgmIG",
      "project_id" : "pjt_6rNUckjXd5K4yxxwg7Zp5L",
      "name" : "dYUfPJw46l",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5xYQrjMxPp6pnGOSoxmw0D",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qtFATmi2w8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1qvW7LPREKF1tC6MFvQLxK",
        "name" : "4H1Dl4bVoe",
        "email" : "E4I9qdET@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7V3rycUfa1Yx5wEOEaYZO4",
        "name" : "7G8qjipNQq",
        "email" : "GoPCDt1w@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.996794Z",
      "updated_at" : "2026-08-18T14:38:12.996794Z"
    },
    "created_at" : "2026-08-18T14:38:13.247314Z",
    "updated_at" : "2026-08-18T14:38:13.247314Z"
  }
}

cage.updated

Triggered when an cage is updated.

{
  "id" : "whe_7175yAtcB6YeficFcdBKdO",
  "client_id" : "bfcc83b8-d99d-4a33-b96c-62318453f508",
  "event" : "cage.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.316947Z",
  "payload" : {
    "id" : "cge_3hNUCWfMv88RJZQDlGFB8H",
    "name" : "fEkSyqbNGN",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_6KnficnnFdC2PMc8ywgmIG",
      "project_id" : "pjt_6rNUckjXd5K4yxxwg7Zp5L",
      "name" : "dYUfPJw46l",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5xYQrjMxPp6pnGOSoxmw0D",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qtFATmi2w8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1qvW7LPREKF1tC6MFvQLxK",
        "name" : "4H1Dl4bVoe",
        "email" : "E4I9qdET@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7V3rycUfa1Yx5wEOEaYZO4",
        "name" : "7G8qjipNQq",
        "email" : "GoPCDt1w@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.996794Z",
      "updated_at" : "2026-08-18T14:38:12.996794Z"
    },
    "created_at" : "2026-08-18T14:38:13.247314Z",
    "updated_at" : "2026-08-18T14:38:13.247314Z"
  }
}

cage.deleted

Triggered when an cage is deleted.

{
  "id" : "whe_1k8W7nlAdUk8bmanmUBSAy",
  "client_id" : "a377efd4-f0b1-447e-9ecb-7a8c6c274191",
  "event" : "cage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.320054Z",
  "payload" : {
    "id" : "cge_3hNUCWfMv88RJZQDlGFB8H",
    "name" : "fEkSyqbNGN",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_6KnficnnFdC2PMc8ywgmIG",
      "project_id" : "pjt_6rNUckjXd5K4yxxwg7Zp5L",
      "name" : "dYUfPJw46l",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5xYQrjMxPp6pnGOSoxmw0D",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "qtFATmi2w8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_1qvW7LPREKF1tC6MFvQLxK",
        "name" : "4H1Dl4bVoe",
        "email" : "E4I9qdET@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7V3rycUfa1Yx5wEOEaYZO4",
        "name" : "7G8qjipNQq",
        "email" : "GoPCDt1w@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.996794Z",
      "updated_at" : "2026-08-18T14:38:12.996794Z"
    },
    "created_at" : "2026-08-18T14:38:13.247314Z",
    "updated_at" : "2026-08-18T14:38:13.247314Z"
  }
}

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_45prgVecRqZ8s4JOsxHiL1",
  "client_id" : "ad6fc8de-ec0f-4db6-9e96-c185e0ec0fda",
  "event" : "planned_animal.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.232929Z",
  "payload" : {
    "id" : "adf_rGSYgHqAlAMoQKm2TpcHc",
    "planned_id" : "P-001",
    "strain" : "ltvnh9mPqJ",
    "species" : "v9ElGiJi3T",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_5tpkc5gPaY5bRYAgRgGUIB",
    "study" : {
      "id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "project_id" : "pjt_2wyJO3pjqrXNd5QrKbsHEB",
      "name" : "y4XFN8xD7j",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4oNekkaJALGXCBkIzRIMu3",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "RrjOOMzwfk",
      "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-08-18T14:38:19.069775Z",
      "updated_at" : "2026-08-18T14:38:19.069775Z"
    },
    "study_group" : {
      "id" : "grp_363cZ5f4wLdgmQjfM8JQK1",
      "study_id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "name" : "XPhlVkPsMZ",
      "no" : 28476047,
      "color" : "#bb542e",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-08-18T14:38:19.101018Z",
      "updated_at" : "2026-08-18T14:38:19.101018Z"
    },
    "created_at" : "2026-08-18T14:38:19.111022Z",
    "updated_at" : "2026-08-18T14:38:19.111022Z"
  }
}

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_3PTDrVOFm2mzRrCQqHQ6bV",
  "client_id" : "80404f15-b86d-4c93-baa7-5fa155c99769",
  "event" : "planned_animal.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.236774Z",
  "payload" : {
    "id" : "adf_rGSYgHqAlAMoQKm2TpcHc",
    "planned_id" : "P-001",
    "strain" : "ltvnh9mPqJ",
    "species" : "v9ElGiJi3T",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_5tpkc5gPaY5bRYAgRgGUIB",
    "study" : {
      "id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "project_id" : "pjt_2wyJO3pjqrXNd5QrKbsHEB",
      "name" : "y4XFN8xD7j",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4oNekkaJALGXCBkIzRIMu3",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "RrjOOMzwfk",
      "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-08-18T14:38:19.069775Z",
      "updated_at" : "2026-08-18T14:38:19.069775Z"
    },
    "study_group" : {
      "id" : "grp_363cZ5f4wLdgmQjfM8JQK1",
      "study_id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "name" : "XPhlVkPsMZ",
      "no" : 28476047,
      "color" : "#bb542e",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-08-18T14:38:19.101018Z",
      "updated_at" : "2026-08-18T14:38:19.101018Z"
    },
    "created_at" : "2026-08-18T14:38:19.111022Z",
    "updated_at" : "2026-08-18T14:38:19.111022Z"
  }
}

planned_animal.deleted

Triggered when one or more planned animals are deleted.

{
  "id" : "whe_7dVZwrqsiaDcI6WGv81sEH",
  "client_id" : "b651a4a5-aaf1-4093-8e6e-84c911632537",
  "event" : "planned_animal.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.240116Z",
  "payload" : {
    "id" : "adf_rGSYgHqAlAMoQKm2TpcHc",
    "planned_id" : "P-001",
    "strain" : "ltvnh9mPqJ",
    "species" : "v9ElGiJi3T",
    "sex" : "f",
    "metadata" : null,
    "animal_id" : "aml_5tpkc5gPaY5bRYAgRgGUIB",
    "study" : {
      "id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "project_id" : "pjt_2wyJO3pjqrXNd5QrKbsHEB",
      "name" : "y4XFN8xD7j",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4oNekkaJALGXCBkIzRIMu3",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "RrjOOMzwfk",
      "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-08-18T14:38:19.069775Z",
      "updated_at" : "2026-08-18T14:38:19.069775Z"
    },
    "study_group" : {
      "id" : "grp_363cZ5f4wLdgmQjfM8JQK1",
      "study_id" : "sdy_3ax7yIdCgjse35wYjNIiu2",
      "name" : "XPhlVkPsMZ",
      "no" : 28476047,
      "color" : "#bb542e",
      "max_animals" : 10,
      "control" : false,
      "metadata" : { },
      "created_at" : "2026-08-18T14:38:19.101018Z",
      "updated_at" : "2026-08-18T14:38:19.101018Z"
    },
    "created_at" : "2026-08-18T14:38:19.111022Z",
    "updated_at" : "2026-08-18T14:38:19.111022Z"
  }
}

Species

species.created

Triggered when a species is created.

{
  "id" : "whe_6O3xD5uNGe2IjzK7QFVzyw",
  "client_id" : "6387e730-a3c5-4a14-9ee4-ecb0dc7c27b7",
  "event" : "species.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.023261Z",
  "payload" : {
    "id" : "spc_7vrXkyaPAlaWVqAdQbz0F",
    "name" : "Cd8Y0cS97W",
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.964094Z",
    "updated_at" : "2026-08-18T14:38:18.964094Z"
  }
}

species.updated

Triggered when a species is updated.

{
  "id" : "whe_130J9hunZfmKmL8ZzjckNs",
  "client_id" : "6b9d06cb-0911-4bef-9828-f79cb3104e21",
  "event" : "species.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.026841Z",
  "payload" : {
    "id" : "spc_7vrXkyaPAlaWVqAdQbz0F",
    "name" : "Cd8Y0cS97W",
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.964094Z",
    "updated_at" : "2026-08-18T14:38:18.964094Z"
  }
}

species.deleted

Triggered when a species is deleted.

{
  "id" : "whe_buQot7wbwixUjRPPlYK4w",
  "client_id" : "889c7330-da79-42a3-b8a7-7e12a8027c6b",
  "event" : "species.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.030053Z",
  "payload" : {
    "id" : "spc_7vrXkyaPAlaWVqAdQbz0F",
    "name" : "Cd8Y0cS97W",
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.964094Z",
    "updated_at" : "2026-08-18T14:38:18.964094Z"
  }
}

Strain

strain.created

Triggered when a strain is created.

{
  "id" : "whe_3noQHom2YZIBgz5HyZfI1b",
  "client_id" : "c7d6bcad-ebc5-43eb-9b6b-a712dc0f26b3",
  "event" : "strain.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.688361Z",
  "payload" : {
    "id" : "stn_1ioHPtvlWIE9ZJp7Emq8Pv",
    "name" : "lgZ7J97pFe",
    "species" : {
      "id" : "spc_34j4VviiHfaGIsM37IpYtK",
      "name" : "qk7FY4RnyO",
      "active" : true,
      "created_at" : "2026-08-18T14:38:18.633083Z",
      "updated_at" : "2026-08-18T14:38:18.633083Z"
    },
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.634100Z",
    "updated_at" : "2026-08-18T14:38:18.634100Z"
  }
}

strain.updated

Triggered when a strain is updated.

{
  "id" : "whe_1epUXHTpgjcyP9u8JkG7vL",
  "client_id" : "f28510bf-0917-481e-8707-93438cfaefc1",
  "event" : "strain.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.692930Z",
  "payload" : {
    "id" : "stn_1ioHPtvlWIE9ZJp7Emq8Pv",
    "name" : "lgZ7J97pFe",
    "species" : {
      "id" : "spc_34j4VviiHfaGIsM37IpYtK",
      "name" : "qk7FY4RnyO",
      "active" : true,
      "created_at" : "2026-08-18T14:38:18.633083Z",
      "updated_at" : "2026-08-18T14:38:18.633083Z"
    },
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.634100Z",
    "updated_at" : "2026-08-18T14:38:18.634100Z"
  }
}

strain.deleted

Triggered when a strain is deleted.

{
  "id" : "whe_4gB1b46i1nOoAzCdZYyU7i",
  "client_id" : "9e8405e8-9fb7-46ba-857c-2876dedca946",
  "event" : "strain.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.693990Z",
  "payload" : {
    "id" : "stn_1ioHPtvlWIE9ZJp7Emq8Pv",
    "name" : "lgZ7J97pFe",
    "species" : {
      "id" : "spc_34j4VviiHfaGIsM37IpYtK",
      "name" : "qk7FY4RnyO",
      "active" : true,
      "created_at" : "2026-08-18T14:38:18.633083Z",
      "updated_at" : "2026-08-18T14:38:18.633083Z"
    },
    "active" : true,
    "created_at" : "2026-08-18T14:38:18.634100Z",
    "updated_at" : "2026-08-18T14:38:18.634100Z"
  }
}

Study

study.created

Triggered when a study is created.

{
  "id" : "whe_2Tbyq75cwDn63cJbshmQbK",
  "client_id" : "d152bb2c-1191-49c4-bf0e-07815db8c679",
  "event" : "study.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.152924Z",
  "payload" : {
    "id" : "sdy_5SwzH9ymvdFt81QuyLdXm9",
    "name" : "zPPhyU57HK",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_59fHLYlIe4HTWPLMPFA3lp",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "FJkPUm72ME",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1xsXM4riGqdf3TksjNiEfB",
      "name" : "GXRSNiP0Vg",
      "email" : "XhMDHHfY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6wWVt1C7PrHqbP6ymk98Pm",
      "name" : "zEIZ3oWF78",
      "email" : "8OwTevgF@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_61KGPE99mhdPQUyzpi3Lye",
      "name" : "36ETj9FCmt",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:38:14.856294Z",
      "updated_at" : "2026-08-18T14:38:14.856294Z"
    },
    "started_on" : "2026-08-18",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:38:14.866355Z",
    "updated_at" : "2026-08-18T14:38:14.866355Z"
  }
}

study.updated

Triggered when a study is updated.

{
  "id" : "whe_2QNRfyZFBOMyjKMC32KLXk",
  "client_id" : "c4b561fe-7c5b-4b1c-98a7-c37d3ab41d12",
  "event" : "study.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.158736Z",
  "payload" : {
    "id" : "sdy_5SwzH9ymvdFt81QuyLdXm9",
    "name" : "zPPhyU57HK",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_59fHLYlIe4HTWPLMPFA3lp",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "FJkPUm72ME",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1xsXM4riGqdf3TksjNiEfB",
      "name" : "GXRSNiP0Vg",
      "email" : "XhMDHHfY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6wWVt1C7PrHqbP6ymk98Pm",
      "name" : "zEIZ3oWF78",
      "email" : "8OwTevgF@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_61KGPE99mhdPQUyzpi3Lye",
      "name" : "36ETj9FCmt",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:38:14.856294Z",
      "updated_at" : "2026-08-18T14:38:14.856294Z"
    },
    "started_on" : "2026-08-18",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:38:14.866355Z",
    "updated_at" : "2026-08-18T14:38:14.866355Z"
  }
}

study.deleted

Triggered when a study is deleted.

{
  "id" : "whe_4UnjV13abOxe0VGoBIiNbo",
  "client_id" : "15838be9-b8f3-4af3-a610-0bedc384849c",
  "event" : "study.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.160136Z",
  "payload" : {
    "id" : "sdy_5SwzH9ymvdFt81QuyLdXm9",
    "name" : "zPPhyU57HK",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_59fHLYlIe4HTWPLMPFA3lp",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "FJkPUm72ME",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1xsXM4riGqdf3TksjNiEfB",
      "name" : "GXRSNiP0Vg",
      "email" : "XhMDHHfY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6wWVt1C7PrHqbP6ymk98Pm",
      "name" : "zEIZ3oWF78",
      "email" : "8OwTevgF@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_61KGPE99mhdPQUyzpi3Lye",
      "name" : "36ETj9FCmt",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:38:14.856294Z",
      "updated_at" : "2026-08-18T14:38:14.856294Z"
    },
    "started_on" : "2026-08-18",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:38:14.866355Z",
    "updated_at" : "2026-08-18T14:38:14.866355Z"
  }
}

study.metadata.updated

Triggered when a study metadata is updated.

{
  "id" : "whe_2QPQmvvOW0mTDQCpGnxImJ",
  "client_id" : "976f80aa-818d-4fc9-9de8-b7278672fa80",
  "event" : "study.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.165474Z",
  "payload" : {
    "id" : "sdy_5SwzH9ymvdFt81QuyLdXm9",
    "name" : "zPPhyU57HK",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_59fHLYlIe4HTWPLMPFA3lp",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "FJkPUm72ME",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1xsXM4riGqdf3TksjNiEfB",
      "name" : "GXRSNiP0Vg",
      "email" : "XhMDHHfY@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6wWVt1C7PrHqbP6ymk98Pm",
      "name" : "zEIZ3oWF78",
      "email" : "8OwTevgF@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_61KGPE99mhdPQUyzpi3Lye",
      "name" : "36ETj9FCmt",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-08-18T14:38:14.856294Z",
      "updated_at" : "2026-08-18T14:38:14.856294Z"
    },
    "started_on" : "2026-08-18",
    "tracking_day_base" : 0,
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-08-18T14:38:14.866355Z",
    "updated_at" : "2026-08-18T14:38:14.866355Z"
  }
}

Study Group

study.group.created

Triggered when a study group is created.

{
  "id" : "whe_70OautTDuX4MhJC4GC1WmZ",
  "client_id" : "4b2016cf-4510-4ad1-a220-0012f93e9eae",
  "event" : "study.group.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.965133Z",
  "payload" : {
    "id" : "grp_3OeJhEyf2GF3hwB9C5dMPO",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_3SINjW0SYFJxITFLeb8N3p",
      "project_id" : "pjt_5DffwKKErxggxNtgwsKWpB",
      "name" : "iAX5cCZWOI",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1yeIVBjg4xqj5suJr0RaWi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "i8dXpmKYN3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_38uXNr7ztcl9VpoUIJWweE",
        "name" : "AE5Z6PK9Fg",
        "email" : "NEeqVgow@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2DkIVktKSq5safJeh9WxzR",
        "name" : "zZoL7Gyazy",
        "email" : "P1y5otN9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.673512Z",
      "updated_at" : "2026-08-18T14:38:15.673512Z"
    },
    "created_at" : "2026-08-18T14:38:15.893055Z",
    "updated_at" : "2026-08-18T14:38:15.893055Z"
  }
}

study.group.updated

Triggered when a study group is updated.

{
  "id" : "whe_22KMykx8DbQeQUGhGtP97c",
  "client_id" : "da02d7d8-430f-45e2-b90c-5d96c76ca264",
  "event" : "study.group.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.966601Z",
  "payload" : {
    "id" : "grp_3OeJhEyf2GF3hwB9C5dMPO",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_3SINjW0SYFJxITFLeb8N3p",
      "project_id" : "pjt_5DffwKKErxggxNtgwsKWpB",
      "name" : "iAX5cCZWOI",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1yeIVBjg4xqj5suJr0RaWi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "i8dXpmKYN3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_38uXNr7ztcl9VpoUIJWweE",
        "name" : "AE5Z6PK9Fg",
        "email" : "NEeqVgow@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2DkIVktKSq5safJeh9WxzR",
        "name" : "zZoL7Gyazy",
        "email" : "P1y5otN9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.673512Z",
      "updated_at" : "2026-08-18T14:38:15.673512Z"
    },
    "created_at" : "2026-08-18T14:38:15.893055Z",
    "updated_at" : "2026-08-18T14:38:15.893055Z"
  }
}

study.group.deleted

Triggered when a study group is deleted.

{
  "id" : "whe_3Z1kVcQyeRNeEkOsLtogI0",
  "client_id" : "c0f4aedb-ae98-4a04-b663-919963e867e8",
  "event" : "study.group.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:15.967683Z",
  "payload" : {
    "id" : "grp_3OeJhEyf2GF3hwB9C5dMPO",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_3SINjW0SYFJxITFLeb8N3p",
      "project_id" : "pjt_5DffwKKErxggxNtgwsKWpB",
      "name" : "iAX5cCZWOI",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1yeIVBjg4xqj5suJr0RaWi",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "i8dXpmKYN3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_38uXNr7ztcl9VpoUIJWweE",
        "name" : "AE5Z6PK9Fg",
        "email" : "NEeqVgow@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2DkIVktKSq5safJeh9WxzR",
        "name" : "zZoL7Gyazy",
        "email" : "P1y5otN9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.673512Z",
      "updated_at" : "2026-08-18T14:38:15.673512Z"
    },
    "created_at" : "2026-08-18T14:38:15.893055Z",
    "updated_at" : "2026-08-18T14:38:15.893055Z"
  }
}

Study Request

study.request.created

Triggered when a request is created.

{
  "id" : "whe_50ySlJBmEp3p0n0DI55zEt",
  "client_id" : "9cb997d5-299f-422d-8873-abbdf44ddd1e",
  "event" : "study.request.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:12.958353Z",
  "payload" : {
    "id" : "req_3Cjt6mbrC2eoZVssZUFDI8",
    "user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "assigned_user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "status" : "pending",
    "due_date" : "2026-08-18",
    "groups" : [ {
      "ref" : "OhAMapBJne",
      "label" : "1mssB302MR"
    } ],
    "fields" : [ {
      "group_ref" : "OhAMapBJne",
      "label" : "Lq0PNakSUF",
      "value" : "a3uKic6DTH",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_7goEWJRekbDNK5UW5GO4IC",
      "project_id" : "pjt_62tdxTXVcnuBaaR0xo7LX5",
      "name" : "JxKoy3yJOJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2tqnP0llrQ1CuzjGf223B8",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "YLmu5Zu84v",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5lIWIaYZdBZDy6EutWdPkm",
        "name" : "ZZUFQqVhlS",
        "email" : "8L36PFcZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1DC2R3vT4TTBikuOTPJzUO",
        "name" : "Yic6pzaY7s",
        "email" : "0gINVmTw@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.387127Z",
      "updated_at" : "2026-08-18T14:38:12.387127Z"
    },
    "created_at" : "2026-08-18T14:38:12.852534Z",
    "updated_at" : "2026-08-18T14:38:12.852534Z"
  }
}

study.request.updated

Triggered when a request is updated.

{
  "id" : "whe_4WwZkvQ17zwwCRWiKtyybD",
  "client_id" : "9c679711-776b-4160-a78e-294bca876ca8",
  "event" : "study.request.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:12.961126Z",
  "payload" : {
    "id" : "req_3Cjt6mbrC2eoZVssZUFDI8",
    "user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "assigned_user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "status" : "pending",
    "due_date" : "2026-08-18",
    "groups" : [ {
      "ref" : "OhAMapBJne",
      "label" : "1mssB302MR"
    } ],
    "fields" : [ {
      "group_ref" : "OhAMapBJne",
      "label" : "Lq0PNakSUF",
      "value" : "a3uKic6DTH",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_7goEWJRekbDNK5UW5GO4IC",
      "project_id" : "pjt_62tdxTXVcnuBaaR0xo7LX5",
      "name" : "JxKoy3yJOJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2tqnP0llrQ1CuzjGf223B8",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "YLmu5Zu84v",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5lIWIaYZdBZDy6EutWdPkm",
        "name" : "ZZUFQqVhlS",
        "email" : "8L36PFcZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1DC2R3vT4TTBikuOTPJzUO",
        "name" : "Yic6pzaY7s",
        "email" : "0gINVmTw@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.387127Z",
      "updated_at" : "2026-08-18T14:38:12.387127Z"
    },
    "created_at" : "2026-08-18T14:38:12.852534Z",
    "updated_at" : "2026-08-18T14:38:12.852534Z"
  }
}

study.request.deleted

Triggered when a request is deleted.

{
  "id" : "whe_24OoR9qG2aog5X1A06NRpS",
  "client_id" : "f56f4dd6-df06-4689-8581-4852eed2382d",
  "event" : "study.request.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:12.964193Z",
  "payload" : {
    "id" : "req_3Cjt6mbrC2eoZVssZUFDI8",
    "user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "assigned_user_id" : "usr_1wOXgRhOIHxApiXsSdIBce",
    "status" : "pending",
    "due_date" : "2026-08-18",
    "groups" : [ {
      "ref" : "OhAMapBJne",
      "label" : "1mssB302MR"
    } ],
    "fields" : [ {
      "group_ref" : "OhAMapBJne",
      "label" : "Lq0PNakSUF",
      "value" : "a3uKic6DTH",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_7goEWJRekbDNK5UW5GO4IC",
      "project_id" : "pjt_62tdxTXVcnuBaaR0xo7LX5",
      "name" : "JxKoy3yJOJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2tqnP0llrQ1CuzjGf223B8",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "YLmu5Zu84v",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_5lIWIaYZdBZDy6EutWdPkm",
        "name" : "ZZUFQqVhlS",
        "email" : "8L36PFcZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1DC2R3vT4TTBikuOTPJzUO",
        "name" : "Yic6pzaY7s",
        "email" : "0gINVmTw@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:12.387127Z",
      "updated_at" : "2026-08-18T14:38:12.387127Z"
    },
    "created_at" : "2026-08-18T14:38:12.852534Z",
    "updated_at" : "2026-08-18T14:38:12.852534Z"
  }
}

Study Sample Plan [BETA]

study.sample_definition.created

Triggered when a sample plan definition is created.

{
  "id" : "whe_4y3SjLxsVFXRcHT4lY8jBS",
  "client_id" : "8e46d8e6-e69b-4e6d-b4c8-eb97b6f97987",
  "event" : "study.sample_definition.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.957062Z",
  "payload" : {
    "id" : "sdf_2G433UMKYGa7NhosJf70RQ",
    "sample_type" : {
      "team_glossary_id" : "tgy_n8Yd5GUFH9c2IbVNwQX2J",
      "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_3js9uQqbSgWltldHYpnMwl",
      "project_id" : "pjt_ts4X5MSu0UmG1D1uIqZom",
      "name" : "RoChBECBwp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2gIC2tmddPQ0bRxCT86orl",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "SNjn8LZ33K",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2jYK6MgJTTWS6YZobeIoRj",
        "name" : "hcDq7vsfgy",
        "email" : "gmifYMNZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3hHAvIvmt05MvhapvO0buA",
        "name" : "9Xm97yuHmJ",
        "email" : "y5nKNWO8@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:13.706649Z",
      "updated_at" : "2026-08-18T14:38:13.706649Z"
    },
    "created_at" : "2026-08-18T14:38:13.910822Z",
    "updated_at" : "2026-08-18T14:38:13.910822Z"
  }
}

study.sample_definition.updated

Triggered when a sample plan definition is updated.

{
  "id" : "whe_dOb03PewUkcAFwLtbsAIZ",
  "client_id" : "40866395-406c-4e91-abe0-a13d53e7f335",
  "event" : "study.sample_definition.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.960467Z",
  "payload" : {
    "id" : "sdf_2G433UMKYGa7NhosJf70RQ",
    "sample_type" : {
      "team_glossary_id" : "tgy_n8Yd5GUFH9c2IbVNwQX2J",
      "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_3js9uQqbSgWltldHYpnMwl",
      "project_id" : "pjt_ts4X5MSu0UmG1D1uIqZom",
      "name" : "RoChBECBwp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2gIC2tmddPQ0bRxCT86orl",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "SNjn8LZ33K",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2jYK6MgJTTWS6YZobeIoRj",
        "name" : "hcDq7vsfgy",
        "email" : "gmifYMNZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3hHAvIvmt05MvhapvO0buA",
        "name" : "9Xm97yuHmJ",
        "email" : "y5nKNWO8@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:13.706649Z",
      "updated_at" : "2026-08-18T14:38:13.706649Z"
    },
    "created_at" : "2026-08-18T14:38:13.910822Z",
    "updated_at" : "2026-08-18T14:38:13.910822Z"
  }
}

study.sample_definition.deleted

Triggered when a sample plan definition is deleted.

{
  "id" : "whe_6nCA4zGRqowfqQVc6YO4Yk",
  "client_id" : "f098807f-8c7c-49d3-9af2-d941b91345dc",
  "event" : "study.sample_definition.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:13.963080Z",
  "payload" : {
    "id" : "sdf_2G433UMKYGa7NhosJf70RQ",
    "sample_type" : {
      "team_glossary_id" : "tgy_n8Yd5GUFH9c2IbVNwQX2J",
      "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_3js9uQqbSgWltldHYpnMwl",
      "project_id" : "pjt_ts4X5MSu0UmG1D1uIqZom",
      "name" : "RoChBECBwp",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2gIC2tmddPQ0bRxCT86orl",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "SNjn8LZ33K",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_2jYK6MgJTTWS6YZobeIoRj",
        "name" : "hcDq7vsfgy",
        "email" : "gmifYMNZ@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3hHAvIvmt05MvhapvO0buA",
        "name" : "9Xm97yuHmJ",
        "email" : "y5nKNWO8@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:13.706649Z",
      "updated_at" : "2026-08-18T14:38:13.706649Z"
    },
    "created_at" : "2026-08-18T14:38:13.910822Z",
    "updated_at" : "2026-08-18T14:38:13.910822Z"
  }
}

Study Task Spec

study.task_spec.created

Triggered when a study task spec is created.

{
  "id" : "whe_5rNHZgPnwzDfgQVJgWyzjU",
  "client_id" : "36423942-d30f-4a87-a734-f67b4fd8da1a",
  "event" : "study.task_spec.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.391897Z",
  "payload" : {
    "id" : "tsp_2MDXN02tjRT9tp6JqG5p9N",
    "title" : "i0rM7YHu0c Task",
    "description" : "pVz3uNTogB Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-08-18",
          "end" : "2026-08-19"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6lIaeXnhjuR8xxmTysXMFA",
      "project_id" : "pjt_6Ufy8VHoUoOzGtvKeDCutI",
      "name" : "Uk9XFEw4dz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6jo9Yv7zvUgGi3R7LrCOJr",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "HDqmIpf9ip",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7ZGXjteZtD2igNY3DGRjC8",
        "name" : "2QpL9U6V1e",
        "email" : "z0eB7O4J@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_22NKJ16ZVTmrq4feLOMsfO",
        "name" : "Q2g34XnfrK",
        "email" : "RoFVm6Q5@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.992463Z",
      "updated_at" : "2026-08-18T14:38:15.992463Z"
    },
    "created_at" : "2026-08-18T14:38:16.340400Z",
    "updated_at" : "2026-08-18T14:38:16.340400Z"
  }
}

study.task_spec.updated

Triggered when a study task spec is updated.

{
  "id" : "whe_3nE4pIIMzQ4GJkCB20HrRq",
  "client_id" : "3b4b20cb-2fc3-4140-8258-05dfc4a3ed82",
  "event" : "study.task_spec.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.394099Z",
  "payload" : {
    "id" : "tsp_2MDXN02tjRT9tp6JqG5p9N",
    "title" : "i0rM7YHu0c Task",
    "description" : "pVz3uNTogB Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-08-18",
          "end" : "2026-08-19"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6lIaeXnhjuR8xxmTysXMFA",
      "project_id" : "pjt_6Ufy8VHoUoOzGtvKeDCutI",
      "name" : "Uk9XFEw4dz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6jo9Yv7zvUgGi3R7LrCOJr",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "HDqmIpf9ip",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7ZGXjteZtD2igNY3DGRjC8",
        "name" : "2QpL9U6V1e",
        "email" : "z0eB7O4J@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_22NKJ16ZVTmrq4feLOMsfO",
        "name" : "Q2g34XnfrK",
        "email" : "RoFVm6Q5@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.992463Z",
      "updated_at" : "2026-08-18T14:38:15.992463Z"
    },
    "created_at" : "2026-08-18T14:38:16.340400Z",
    "updated_at" : "2026-08-18T14:38:16.340400Z"
  }
}

study.task_spec.deleted

Triggered when a study task spec is deleted.

{
  "id" : "whe_4KxDLQty3sXdCNF9hIiAin",
  "client_id" : "2c118371-721c-487c-a74f-cd2620c6d071",
  "event" : "study.task_spec.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:16.395164Z",
  "payload" : {
    "id" : "tsp_2MDXN02tjRT9tp6JqG5p9N",
    "title" : "i0rM7YHu0c Task",
    "description" : "pVz3uNTogB Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-08-18",
          "end" : "2026-08-19"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6lIaeXnhjuR8xxmTysXMFA",
      "project_id" : "pjt_6Ufy8VHoUoOzGtvKeDCutI",
      "name" : "Uk9XFEw4dz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6jo9Yv7zvUgGi3R7LrCOJr",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "HDqmIpf9ip",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_7ZGXjteZtD2igNY3DGRjC8",
        "name" : "2QpL9U6V1e",
        "email" : "z0eB7O4J@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_22NKJ16ZVTmrq4feLOMsfO",
        "name" : "Q2g34XnfrK",
        "email" : "RoFVm6Q5@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:15.992463Z",
      "updated_at" : "2026-08-18T14:38:15.992463Z"
    },
    "created_at" : "2026-08-18T14:38:16.340400Z",
    "updated_at" : "2026-08-18T14:38:16.340400Z"
  }
}

Study Treatment

study.treatment.created

Triggered when a treatment is created.

{
  "id" : "whe_6exlOKZ7pME134lMAqi3x",
  "client_id" : "872099a0-6857-4c31-b3c6-498bd547110e",
  "event" : "study.treatment.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.334886Z",
  "payload" : {
    "id" : "tmt_73izrBVWtKzMio3UQb1vm5",
    "type" : "concentration",
    "name" : "ZeTYiDnLQU",
    "label" : "Test Treatment Label",
    "external_entity_id" : "FqjpRwpjZn",
    "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_2S8MqjOPEn0IxGs6sZmDPF",
      "project_id" : "pjt_f3jLVc6nc1RLmKCxaI5ri",
      "name" : "krbmxp9CgU",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6fbBhPC8coF0SRZycgguYf",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hldKogu65H",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_xbeEElIrUDnz9qHu5QGPz",
        "name" : "iUgqYgmF6T",
        "email" : "tX9MCAY3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2wwAwmdEZtVFefy87cuOuX",
        "name" : "27IDNuxsMH",
        "email" : "gXXnlpJG@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.876016Z",
      "updated_at" : "2026-08-18T14:38:17.876016Z"
    },
    "created_at" : "2026-08-18T14:38:18.263986Z",
    "updated_at" : "2026-08-18T14:38:18.263986Z"
  }
}

study.treatment.updated

Triggered when a treatment is updated.

{
  "id" : "whe_7aXuJAxIMj25XAWLaT3zVL",
  "client_id" : "0190b8d6-5505-4862-b542-62a8a83f6740",
  "event" : "study.treatment.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.336492Z",
  "payload" : {
    "id" : "tmt_73izrBVWtKzMio3UQb1vm5",
    "type" : "concentration",
    "name" : "ZeTYiDnLQU",
    "label" : "Test Treatment Label",
    "external_entity_id" : "FqjpRwpjZn",
    "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_2S8MqjOPEn0IxGs6sZmDPF",
      "project_id" : "pjt_f3jLVc6nc1RLmKCxaI5ri",
      "name" : "krbmxp9CgU",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6fbBhPC8coF0SRZycgguYf",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hldKogu65H",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_xbeEElIrUDnz9qHu5QGPz",
        "name" : "iUgqYgmF6T",
        "email" : "tX9MCAY3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2wwAwmdEZtVFefy87cuOuX",
        "name" : "27IDNuxsMH",
        "email" : "gXXnlpJG@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.876016Z",
      "updated_at" : "2026-08-18T14:38:17.876016Z"
    },
    "created_at" : "2026-08-18T14:38:18.263986Z",
    "updated_at" : "2026-08-18T14:38:18.263986Z"
  }
}

study.treatment.deleted

Triggered when a treatment is deleted.

{
  "id" : "whe_2EtKASmKlKtiS2ahzuDv17",
  "client_id" : "8a688881-63eb-47fc-bece-3cc76679c8e6",
  "event" : "study.treatment.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.337620Z",
  "payload" : {
    "id" : "tmt_73izrBVWtKzMio3UQb1vm5",
    "type" : "concentration",
    "name" : "ZeTYiDnLQU",
    "label" : "Test Treatment Label",
    "external_entity_id" : "FqjpRwpjZn",
    "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_2S8MqjOPEn0IxGs6sZmDPF",
      "project_id" : "pjt_f3jLVc6nc1RLmKCxaI5ri",
      "name" : "krbmxp9CgU",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6fbBhPC8coF0SRZycgguYf",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "hldKogu65H",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_xbeEElIrUDnz9qHu5QGPz",
        "name" : "iUgqYgmF6T",
        "email" : "tX9MCAY3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2wwAwmdEZtVFefy87cuOuX",
        "name" : "27IDNuxsMH",
        "email" : "gXXnlpJG@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:17.876016Z",
      "updated_at" : "2026-08-18T14:38:17.876016Z"
    },
    "created_at" : "2026-08-18T14:38:18.263986Z",
    "updated_at" : "2026-08-18T14:38:18.263986Z"
  }
}

study.treatment.assigned

Triggered when a treatment is assigned to a study group.

{
  "id" : "whe_7CmuQXl2UGPZqrI3COPtTe",
  "client_id" : "d66ebfd0-0194-4770-bb5e-972639be8397",
  "event" : "study.treatment.assigned",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:17.345427Z",
  "payload" : {
    "study_group" : {
      "id" : "grp_7ZeYr7LeR4zAUHJtf4vjKQ",
      "name" : "KsB4HCOrHN",
      "no" : 2096559525,
      "color" : "#00afc0",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_2AYk9vm2SHdMLxGpmyXaBa",
        "project_id" : "pjt_3ZyVneH2HxqJIEKElJS0XB",
        "name" : "CZBizIYjZh",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_7chVvuKOV900T2vWLtcvF9",
        "type" : "internal",
        "started_on" : "2026-08-18",
        "status" : "in_progress",
        "description" : "urpwP7S5w6",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_6K43tvrX9I8r2HITdug594",
          "name" : "O39IdHAXix",
          "email" : "LYvAOekO@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_5p8SXnH4tHtbxKgFRwBgJQ",
          "name" : "XjTe2j3RIX",
          "email" : "NpMQFQxe@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-08-18T14:38:17.047221Z",
        "updated_at" : "2026-08-18T14:38:17.047221Z"
      },
      "created_at" : "2026-08-18T14:38:17.289418Z",
      "updated_at" : "2026-08-18T14:38:17.289418Z"
    },
    "treatment" : {
      "id" : "tmt_SWnELWP1MHds4uNDQFkcU",
      "type" : "volume",
      "name" : "zlZ6XhPtLZ",
      "label" : "Test Treatment Label",
      "external_entity_id" : "s2WN6O3njb",
      "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_2AYk9vm2SHdMLxGpmyXaBa",
        "project_id" : "pjt_3ZyVneH2HxqJIEKElJS0XB",
        "name" : "CZBizIYjZh",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_7chVvuKOV900T2vWLtcvF9",
        "type" : "internal",
        "started_on" : "2026-08-18",
        "status" : "in_progress",
        "description" : "urpwP7S5w6",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_6K43tvrX9I8r2HITdug594",
          "name" : "O39IdHAXix",
          "email" : "LYvAOekO@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_5p8SXnH4tHtbxKgFRwBgJQ",
          "name" : "XjTe2j3RIX",
          "email" : "NpMQFQxe@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-08-18T14:38:17.047221Z",
        "updated_at" : "2026-08-18T14:38:17.047221Z"
      },
      "created_at" : "2026-08-18T14:38:17.305131Z",
      "updated_at" : "2026-08-18T14:38:17.305131Z"
    }
  }
}

study.treatment.unassigned

Triggered when a treatment is unassigned from a study group.

{
  "id" : "whe_5ktmMOkLXYkxFgv7QmS4ls",
  "client_id" : "8e78ed41-9d07-4740-83a2-d43f27d34a30",
  "event" : "study.treatment.unassigned",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:17.348302Z",
  "payload" : {
    "study_group" : {
      "id" : "grp_7ZeYr7LeR4zAUHJtf4vjKQ",
      "name" : "KsB4HCOrHN",
      "no" : 2096559525,
      "color" : "#00afc0",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_2AYk9vm2SHdMLxGpmyXaBa",
        "project_id" : "pjt_3ZyVneH2HxqJIEKElJS0XB",
        "name" : "CZBizIYjZh",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_7chVvuKOV900T2vWLtcvF9",
        "type" : "internal",
        "started_on" : "2026-08-18",
        "status" : "in_progress",
        "description" : "urpwP7S5w6",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_6K43tvrX9I8r2HITdug594",
          "name" : "O39IdHAXix",
          "email" : "LYvAOekO@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_5p8SXnH4tHtbxKgFRwBgJQ",
          "name" : "XjTe2j3RIX",
          "email" : "NpMQFQxe@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-08-18T14:38:17.047221Z",
        "updated_at" : "2026-08-18T14:38:17.047221Z"
      },
      "created_at" : "2026-08-18T14:38:17.289418Z",
      "updated_at" : "2026-08-18T14:38:17.289418Z"
    },
    "treatment" : {
      "id" : "tmt_SWnELWP1MHds4uNDQFkcU",
      "type" : "volume",
      "name" : "zlZ6XhPtLZ",
      "label" : "Test Treatment Label",
      "external_entity_id" : "s2WN6O3njb",
      "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_2AYk9vm2SHdMLxGpmyXaBa",
        "project_id" : "pjt_3ZyVneH2HxqJIEKElJS0XB",
        "name" : "CZBizIYjZh",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_7chVvuKOV900T2vWLtcvF9",
        "type" : "internal",
        "started_on" : "2026-08-18",
        "status" : "in_progress",
        "description" : "urpwP7S5w6",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "tracking_day_base" : 0,
        "author" : {
          "id" : "usr_6K43tvrX9I8r2HITdug594",
          "name" : "O39IdHAXix",
          "email" : "LYvAOekO@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_5p8SXnH4tHtbxKgFRwBgJQ",
          "name" : "XjTe2j3RIX",
          "email" : "NpMQFQxe@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-08-18T14:38:17.047221Z",
        "updated_at" : "2026-08-18T14:38:17.047221Z"
      },
      "created_at" : "2026-08-18T14:38:17.305131Z",
      "updated_at" : "2026-08-18T14:38:17.305131Z"
    }
  }
}

Study User

study.user.created

Triggered when a study user is created.

{
  "id" : "whe_69br6NSXLzvU8U82UMZTLx",
  "client_id" : "2dd24276-c1c9-45c1-9423-7994f7e3006e",
  "event" : "study.user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.990470Z",
  "payload" : {
    "id" : "usr_Ncl41lwg21PlgJXo5coum",
    "name" : "WuI09STuPM",
    "email" : "ZIuynwMc@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_3AmR4whFmw0zUxxiycJBTI",
      "project_id" : "pjt_7KUS4yFvHQ28uXUMUowBax",
      "name" : "imb9dMBoHr",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1dIUKg3iDGURgHji53dTOm",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "ZhiAFZ7FAX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Ncl41lwg21PlgJXo5coum",
        "name" : "WuI09STuPM",
        "email" : "ZIuynwMc@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2CRWzcjGtT8QgmDzo8U8ee",
        "name" : "NvxjtZEFy1",
        "email" : "XN2cOVQU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:19.299210Z",
      "updated_at" : "2026-08-18T14:38:19.299210Z"
    }
  }
}

study.user.updated

Triggered when a study user is updated.

{
  "id" : "whe_6FkKi4bCjMCf3HOLCLPhVb",
  "client_id" : "6fa8bcb3-6b0e-4168-8c34-c3adef8c2e71",
  "event" : "study.user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:19.997707Z",
  "payload" : {
    "id" : "usr_Ncl41lwg21PlgJXo5coum",
    "name" : "WuI09STuPM",
    "email" : "ZIuynwMc@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_3AmR4whFmw0zUxxiycJBTI",
      "project_id" : "pjt_7KUS4yFvHQ28uXUMUowBax",
      "name" : "imb9dMBoHr",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1dIUKg3iDGURgHji53dTOm",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "ZhiAFZ7FAX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Ncl41lwg21PlgJXo5coum",
        "name" : "WuI09STuPM",
        "email" : "ZIuynwMc@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2CRWzcjGtT8QgmDzo8U8ee",
        "name" : "NvxjtZEFy1",
        "email" : "XN2cOVQU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:19.299210Z",
      "updated_at" : "2026-08-18T14:38:19.299210Z"
    }
  }
}

study.user.deleted

Triggered when a study user is deleted.

{
  "id" : "whe_4ZFTwhFFtlL4mUFFdfrgbt",
  "client_id" : "bef88467-515c-41f4-bfe8-b2852be0c3a6",
  "event" : "study.user.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:20.000820Z",
  "payload" : {
    "id" : "usr_Ncl41lwg21PlgJXo5coum",
    "name" : "WuI09STuPM",
    "email" : "ZIuynwMc@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_3AmR4whFmw0zUxxiycJBTI",
      "project_id" : "pjt_7KUS4yFvHQ28uXUMUowBax",
      "name" : "imb9dMBoHr",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1dIUKg3iDGURgHji53dTOm",
      "type" : "internal",
      "started_on" : "2026-08-18",
      "status" : "in_progress",
      "description" : "ZhiAFZ7FAX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "tracking_day_base" : 0,
      "author" : {
        "id" : "usr_Ncl41lwg21PlgJXo5coum",
        "name" : "WuI09STuPM",
        "email" : "ZIuynwMc@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2CRWzcjGtT8QgmDzo8U8ee",
        "name" : "NvxjtZEFy1",
        "email" : "XN2cOVQU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-08-18T14:38:19.299210Z",
      "updated_at" : "2026-08-18T14:38:19.299210Z"
    }
  }
}

Team Glossary Observation [BETA]

team.glossary_observation.created

Triggered when a team glossary observation is created.

{
  "id" : "whe_16adj6j5uWjZHIWCrhoOaH",
  "client_id" : "4bc3d92c-f956-4c37-8b21-908020b0a28d",
  "event" : "team.glossary_observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.398716Z",
  "payload" : {
    "id" : "tgy_2TVm8vOjKeVImcRar33DtP",
    "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_s8JSzNlYeCo3fNOcewRdk",
  "client_id" : "40f2f644-7283-485f-9d72-fc006c73772f",
  "event" : "team.glossary_observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.400450Z",
  "payload" : {
    "id" : "tgy_2TVm8vOjKeVImcRar33DtP",
    "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_5Zu2lbcPC3x8uHXrcgF3vb",
  "client_id" : "f58a8287-8015-48bf-b677-50cbe8ddee6f",
  "event" : "team.glossary_observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:18.401910Z",
  "payload" : {
    "id" : "tgy_2TVm8vOjKeVImcRar33DtP",
    "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_17BWEpBf9Phi9LWfo6VkSI",
  "client_id" : "fc4b7bc6-de31-488f-808f-211a1285b431",
  "event" : "team.glossary_sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:14.824295Z",
  "payload" : {
    "id" : "tgy_4Mw803arfd2piEPwqjT9Jp",
    "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_TF4iQWelgNuOeIJBYSww0",
  "client_id" : "cbd9a047-d5b8-4bf2-ae3d-f9bb02f0a57e",
  "event" : "team.glossary_sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:14.828086Z",
  "payload" : {
    "id" : "tgy_4Mw803arfd2piEPwqjT9Jp",
    "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_5IqKUOIiTQQc98lOsurbZ",
  "client_id" : "3d518bc4-04cb-43d4-9b95-8da0fbb196ff",
  "event" : "team.glossary_sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:14.829408Z",
  "payload" : {
    "id" : "tgy_4Mw803arfd2piEPwqjT9Jp",
    "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_3oujXjWkZhJBb9AeJ1u6rl",
  "client_id" : "ceae8320-597c-4834-a98c-ed8a902d97d1",
  "event" : "user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:20.318587Z",
  "payload" : {
    "id" : "usr_65Fz4tfbwdWpUkDqlwidwM",
    "name" : "3nkPo Overwatch",
    "email" : "1G03x0u5@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:38:20.217991Z",
    "updated_at" : "2026-08-18T14:38:20.217991Z"
  }
}

user.updated

Triggered when a user is updated on a team.

{
  "id" : "whe_4u7yYWKSC2Izu5Bli9qlZF",
  "client_id" : "3096a2dd-dd8a-418e-bca0-18a5f96685cf",
  "event" : "user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-08-18T14:38:20.321741Z",
  "payload" : {
    "id" : "usr_65Fz4tfbwdWpUkDqlwidwM",
    "name" : "3nkPo Overwatch",
    "email" : "1G03x0u5@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-08-18T14:38:20.217991Z",
    "updated_at" : "2026-08-18T14:38:20.217991Z"
  }
}