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.

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

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

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

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.

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:

Extract the Signature header from the incoming HTTP request
Get the raw request body as bytes (before any JSON parsing)
Compute HMAC-SHA256 using your signing_secret as the key
Convert the result to a lowercase hexadecimal string
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

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.

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

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.

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" : "61cbd336-a384-4562-b33f-65c03c4ea191",
  "client_secret" : "Iee3dmj2duvQjxiSbpvI7YApSm4Lg74nRI4UT9Wc"
}

Response

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

{
  "token_type" : "Bearer",
  "expires_in" : 86400,
  "access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MWNiZDMzNi1hMzg0LTQ1NjItYjMzZi02NWMwM2M0ZWExOTEiLCJqdGkiOiJlMGRkYjQ5NS00YTJhLTQxZTUtYmIwOS01NDVjYzliNGZiYTAiLCJpYXQiOjE3NzgyNTI2MjcsIm5iZiI6MTc3ODI1MjYyNywiZXhwIjoxNzc4MzM5MDI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzgxYTdaQkNiaDRJRXdndVhnTGhOTCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.mA-42G8mvmao8M3UKAX4G19uAtWAV90gK2AL82_zlZfTrsVclfQOMrDq8ATOhl3I7DkBX-H51aYDtWI-ReeM7mc7ibyY-29TrbpyYy5B8tsAkhKgLY-EWsPiVROZTdlUL7X4zdS4iX9qfNdpzs6EMeZzTXhtVigUj3BEq1fNPx5gnf5WdFMCput39IMhnywDAyHKv76aoJoTOWNKjrvsaeBEzQam7E0lLaUrDF7L-clLeIqYE8gncIvF2POvprw7A1g5mMj2nLrodSGwvblOXmkL5itNzEdnYpRb8vYNXFchCnFif5rs1B2TkASIPGubpMM3BdObbqa8tTp-Nif3LpDEU7YQQQQW74L8nK6BMHW7Ha0DnZKaOBRWxM0JCSHiaxlSZrmAe0wj3RWqRmBfH5UOrmr0B9OwpATKbnwhC3m7HALYmG0Zytk7amrYhaZk1_2hX6WakUwxrEl8XzhAfMCwSd_3BK7MH5orqNAZHKZ6_jXY5cFV2f-pAcmpNAuRJjW06aAnO5_HxautDDa8WLTkAhbdzZ1VImu_VUT37L2O6Him67FnbKozyj7mMPo6Jt-ySHQJTpMaz04ze-GBB3cpZ5SsbudibVD44UmZ6FxjFC2XCzEtHn-idOQRSr0pVOzYZ08RynsXWzaw4SmHiKkJ3BYZN1c1GfinyinLvhY"
}

Glossary

Your team’s glossary and their configurations for entities that include—Samples, Observations and Euthanized reasons.

Attributes

Path Type Description

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.

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_3ewvnYRRomwQxd2ZAF483S HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NmFlMTFhMS1hYTJiLTQyYjktOTM4Yy03ZGEwYTkxMTYzYjMiLCJqdGkiOiJmNjA3MjUyMy0xYzA4LTRkNTUtOGM5Mi04Y2EzMmUxNDZiYjMiLCJpYXQiOjE3NzgyNTI2MTUsIm5iZiI6MTc3ODI1MjYxNSwiZXhwIjoxNzc4MzM5MDE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNJOVU1QkFtZnBSTnVrT09zdHoyamIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.aXM4EGl6tRYMmyVLtQnDbE_DdXXe-psTOQ-9fZHu2VXIS6qDFUJmt9zFICmlZEdd1FuwSgBEsv3NQ0P1nw2SzztfKK8O4yMqWCCh9RuCk9ImAoM6tN3YRQSaUdW_WNdHQGAB4X3sAhhTAtwmFpP53PDyi-R7zEb8qsw8EAXpRBRUyGx5nncWcH8QUyg3mWiZIYL6M912bcsXjYmhanxNsJpmlQfz6Q0cH6N5uBdvUntMNdJYLHqiXpc1BBGc7SYrjjCfuO5cfCBNch99oUvRxVwS1N5RjsFoQR2T1_6ulVyShPTNXIfWbONBBAnVJNqMpVtLj4oWr3bCRYirkeotSRXRwUgWCgI0T29_jF9GPppqYviQSxO5Of1Tw1bzWY7TO07h4PL7Q4LCtVjQfuiHgkBVQh0iGoNgntVEr1gqQeTn1WDYq56DeSNnxDsIsDYfFxPLhR-CuGlNHEtJDEz9q28VuIAuinzQSlzsqvDqP7kzky0DZlxiB-6xMMUXAVCnr7xPUvUepfL2CQoThNOI-q68qfFKUMJSKMuEUOGA8ZRWr-d0aQTIk8xofnVRNUBdiQLCb7Gxeki1e4tkMTD7sR4J9pvyLutunyM-qsWqiL3CTtVOBhY5zC_lIzYdWSCX3kNkxKM5jr0VvQ6EQdhSnsUf3l5K5KucVj-Xh1aQEFY
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: 100

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

List all glossary items

Returns a list of your glossary.

Query parameters

Parameter Description

Parameter	Description
`perPage`	The number of glossaries to return per page.
`page`	The page of glossaries to return.
`type`	Filter glossaries by type

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.eyJhdWQiOiIxNmJkZjkxMi1kZjM3LTRlZGMtODEzMi0zMDViM2MzNmM1NTIiLCJqdGkiOiIxMGQwYWEwYS1jNjE4LTRiMjItOWRmMS1mNzY2YjlhZTU0OTciLCJpYXQiOjE3NzgyNTI2MTMsIm5iZiI6MTc3ODI1MjYxMywiZXhwIjoxNzc4MzM5MDEzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVsM3RPMlFrRVB5RFI3Z3FjYkxRY0QiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.h62dFv_MJbt5L4NRn_PLVRyEmELSQj8oI6Oj7lXRjIfnQKNV739P4dwVZVoYu_qDnr9x3V1zcNjmzRBwZX__12Bd0B3iZggBcBf7ysOATJe5zXb4DUPPUaDCk-KBnDyHl_dYDi8LpKMjFlyqLzxa8GNwyOSXSF9zf9phWM9cMxWPeq2h6xQ5FVoV9oRWGYTe_kLyv5lVHL4uh-Tg_47kRsXiR_j-dyrpF1RTgTWWStgpatK2H3gKLd33TEOeTPXnCCMmBPr5r7eo4iA3h74m7lSbxsjkmgnfqmmvFWqt0PoTdfw86gEd12WWcRL6TEH4rCxjIVk91y_Wc70fwpdqMVJ-frhc_aG47EVOXUaxX7eN2yZtRVY2J8kuBTgU7gIQz2mfjm1XH2XT4QaawFWcdpPl1j2jBP-mlPCJsGN90nprASKicn9wI3g3dAPZo7xjCPZNG2KEtgof6v5c8uzzmaNib4FNyhqJ4hbgTNUOnJ-17umVN4PL0GtQAz7idYPr7pl0vuYQZKv9R1IuVGjPyiWKyTu8MNX2f0x3a7zSI8oyb_RvhCEhqaNv45mJ27oMhIXjdllu16FKnuB0fEZmJZ1kIxYd249lVKzkEmEi4iRYJtXiZSoyKrNuAlX9x9fSdXy0BIFs-WXYuMXBXFeb8X3rwjSjIMybDDam3R5NGz8
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: 496

{
  "data" : [ {
    "id" : "gly_1eQ6lRF1K9vQh5dVh6qLTw",
    "title" : "Brain",
    "group" : "samples"
  } ],
  "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

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.

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

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.

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.eyJhdWQiOiI4Y2IyMmE0Zi1hNTZhLTRiMGEtOGUwNy00NDYzZGVmYjQ5ZjEiLCJqdGkiOiI2ZWZhMmNjMi1jODUyLTQzMDctOTBlZS1iYWI2OWFjYTMyMzQiLCJpYXQiOjE3NzgyNTI1OTMsIm5iZiI6MTc3ODI1MjU5MywiZXhwIjoxNzc4MzM4OTkzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRnSW9ERmJoa3RXc05WalpLcVg3cFAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.aA6mMqgC8jHVo81MMNf5J6QkA7LnRFTGOPZv-NAItB6OFFd-F0Jo-eVTUHoetiBmNMUyJiu2fB8n-DisgcPU0TPmV6r2yfTQsFfptluqk7Mb4o-7x2UfiiyPuFtkyURLYqXPaHZwCNwrGvxTHV6wn29lnwaYFY0qeMYb1zlBXwUualLZBhWvcFBtAlsbWFc-oPoiRxvlaNVnZV2uIYZV4jdrjLsn365doeSarFlx7bIOryPY_nvJORds5X9yyOohFFtKDOK6nPkDkY5prxa4qlYdKdEZM4wYDaBEHIEodEHqx3vBz9EDduAPHdaQ8GKrrVehAazrVu3FSh-gQmYfTWI07C_Oft_oKJlCPxlbeaQFyIsMQzwI4cS1iLdmKLaKwaOz1vBUbOgKq96eMb6D8tldCXpP7N3rS1KlKNrz1-Z6RfgStAIwpjXrzOEbRQ9Ecw5sFbwN5gCUJVkuiYpjIRxcl69JD1htf76JmyR44Sct9bBG1pS1DNkMOGHTohie5WJgA2u5jRm6d-Essq3OJBknmvUasZEorIj2Hs27X2EC31XyZJxmZPZpeXU8xxnWNq4bjnKdK_1fpbflLDkYmMwPYz0JE8XqiT461-A6XypTdPawNAkoEyPYrF2qowuyWEG3JJ06ZTR0mTKRS7M1GIPPG5T_PIkqCoE6WC-uZpg
Content-Length: 197
Host: localhost:8080

{
  "cage_id" : "cge_Hona5lmeR3zlOr8a6K4nD",
  "name" : "Animal 1",
  "strain" : "f1q5YI2CQz",
  "sex" : "m",
  "dob" : "2026-05-08",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  }
}

Response

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

{
  "id" : "aml_5ifhB2iuHksuFf77QUAS6S",
  "catalog" : "A0000001",
  "name" : "Animal 1",
  "number" : 1,
  "strain" : "f1q5YI2CQz",
  "species" : "gbxTlWg68F",
  "sex" : "m",
  "dob" : "2026-05-08",
  "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_22A4Nz9vJZ8iSJAUvPOuRE",
    "project_id" : "pjt_1c8fwwoqNams56WbG6ElCO",
    "name" : "MjzvxRHogF",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1lK401mNOR0f2T4XggoRx",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "6F9XJFBgjn",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_4yVmd8hsiCSj1O7JRJAjzJ",
      "name" : "ROafPzIr34",
      "email" : "Q7zjqZ6J@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_50eTdt6C4ECsSB6EhygSPb",
      "name" : "GX9uaynIUR",
      "email" : "SKF9wjqv@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:13.794508Z",
    "updated_at" : "2026-05-08T16:03:13.794508Z"
  },
  "study_group" : null,
  "cage" : {
    "id" : "cge_Hona5lmeR3zlOr8a6K4nD",
    "study_id" : "sdy_22A4Nz9vJZ8iSJAUvPOuRE",
    "name" : "rFnFTOWf2D",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-05-08T16:03:13.949327Z",
    "updated_at" : "2026-05-08T16:03:13.949327Z"
  },
  "created_at" : "2026-05-08T16:03:13.980914Z",
  "updated_at" : "2026-05-08T16:03:13.980914Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Request

GET /api/public/v1/animals/aml_6uZLDWApGl0QuqSIW3bUPO HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxZjdhNzQ4MC0wYmVjLTQwNmYtYTBmNy1hNjZiZmVjMDZhY2EiLCJqdGkiOiI2ZDdlY2NjMy1jMzM0LTRkYzctYTllZi1hZjZjOWFkNjVlOTAiLCJpYXQiOjE3NzgyNTI1OTQsIm5iZiI6MTc3ODI1MjU5NCwiZXhwIjoxNzc4MzM4OTk0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZKY09IWVVEMkY2NnRxdm9tU0E3ajQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.g3ZYIc4Jh7jvYaioc1zqzCWGYH27zqSuyGpe1ZaDx4lLjDEcfjY5HCEP1yIj0LtBUe_61mYbqylQxBMkIncK-P7MPVm1Tdp5EdpaHD4QSYL6pZSaXpZCtrLX6I1pY2qiYS7auOKNh95BQtSoYpjMNMhRkx3illvAYUqn2DGIlxoz58lh8a3D8oJrMQ5ghxUzi65hirxEgXtXpDpaoGAtSEUNVoqUDpzXvCKTLB2ufd1yDhWAavmU0f4p4Xx5P7TmfhBvT7ljztD-eJNBhKJu-VBWYz3Mo48Tr81p1B9cXnEnapT0XYA05DJJi9HCcdHQISxDP-Vc6FhcFg_J4j-lc50zDn3mIPsLJ_Dvb3-W9-9ibMunmwjk-GJUEYz2eBh-hhU-jMMz-J-OO331ATMyCGsqDVC-Lp19CZABva0hu97BxXrbipJj4XbHMuw0r1bM5UxJBpnNnaJ_DPI85dFtJ8F4ASDB-qqLDTmX5-rClsZJ_546SPS332w3KH6G6MJTnjrexJNFEZlNtQWtZ6aPOO5DVmnJKS19tAtoOqkYKedVYuwSPz5Awh3IeRI1ai-oGTfpTWpPnunweDq6kdGBiVVPPQyM85jDW8KlDTELv3fMJ53P_Ykp7PK8DHeBBJGsGePePJIOwNgVH0-4PIyVv0fo5XLBpzT1W1AH4uPYYEQ
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: 2550

{
  "id" : "aml_6uZLDWApGl0QuqSIW3bUPO",
  "catalog" : "A0000001",
  "name" : "LCDidQudM7",
  "number" : 1,
  "strain" : "roY2gdrwn3",
  "species" : "DqHNP6zYq8",
  "sex" : "m",
  "dob" : "2026-05-07",
  "tail" : "NFwWpGeTW7",
  "ear" : "raoKon2c7y",
  "tag" : "BYQeuZMm2R",
  "donor" : "ySLlhpP4Q5",
  "tracking_date" : "2026-05-08",
  "disease_induction_date" : "2026-05-08",
  "terminated_at" : "2026-05-08",
  "terminated_by" : {
    "id" : "usr_5Mlc6lBAQpTxwBcQQnaxab",
    "name" : "vdCcocsqmO",
    "email" : "HhtyNTRS@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_508tORgwxdOsBX0B3DghTq",
    "title" : "Found dead",
    "comment" : "vXZEDd1Hle"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_2d2NPsqy5a4mQ290aC3GHF",
    "project_id" : "pjt_XwKoGWDQIiE1d0CCDVe4Q",
    "name" : "8B9QpH5pao",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5bAtx9o9lx8xGUtsL6mQzs",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "6a0F7NFA1z",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_3pvMFEYr30t04y9NccxNkr",
      "name" : "EnG5PgISyG",
      "email" : "eKbgSPg7@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1yjvMW9R5adkfuxVh9KMwT",
      "name" : "VINSkOsXDi",
      "email" : "4qJcZGxA@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:14.281946Z",
    "updated_at" : "2026-05-08T16:03:14.281946Z"
  },
  "study_group" : {
    "id" : "grp_1atnVFjxRGZs3G7P5QEh6A",
    "study_id" : "sdy_2d2NPsqy5a4mQ290aC3GHF",
    "name" : "L1MplFSDh0",
    "no" : 561129999,
    "color" : "GzTB47p8wn",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-05-08T16:03:14.447294Z",
    "updated_at" : "2026-05-08T16:03:14.447294Z"
  },
  "cage" : {
    "id" : "cge_2BBtybruhy8Qhr9xfYMGLu",
    "study_id" : "sdy_2d2NPsqy5a4mQ290aC3GHF",
    "name" : "gz3E9zfUQY",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-05-08T16:03:14.433326Z",
    "updated_at" : "2026-05-08T16:03:14.433326Z"
  },
  "created_at" : "2026-05-08T16:03:14.452862Z",
  "updated_at" : "2026-05-08T16:03:14.452862Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Fields

Path Type Description

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.

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_29bflwWz7zRzHtexjOo5Xb HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjN2YxMTY1Yy1jOGI5LTQ1OGYtYjM4MS0wZDY4YWM1ODVkNjQiLCJqdGkiOiI5ZDE2OTE1Ny0wNDVhLTQ1OTctODk1MC01ZjdjZjhiODU4YzIiLCJpYXQiOjE3NzgyNTI1OTUsIm5iZiI6MTc3ODI1MjU5NSwiZXhwIjoxNzc4MzM4OTk1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFDb293ZjJXbms3YjhYMnA4am5KUkwiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.f4B1VIa1AXloT2zmzwi5oYM7_TLHkIFKu5OXzxfBirimX-Nqs7cdJwbVvpCw6rCo5gDpjj2chSt-_vedrBP1_CXwWJpxM2M4TscKl6IfAQBkrlDprR1koJB-O1qi3UY40yj0SQg1DWwPvJGo78gR7nBrAfqmoAYFpQIofHqNKPvqF-Q2qJ2-vGLhv-T-JK4AcEY5fHA8UbEFUqq6y-Gs3o5ptEVa9htsE4wnchnz4DpTeW7x7p53bi0-O0q1JQRTsbTe0xcF_UonN8U7ppTV8uyAOjr6XEQyHuzw_nLoMJf157tbSREZKZGZWEd44HUFp3wP6TF_Mi-sh3ny9w6z6GlNkErVBibuR3dkuSR0tDYyPka4osKXbk_coRFMgl4QyU9rC6xO2BQBbnRURAH1fr33bXXYXeLqy0MZ2q0Wy4Fs498R6e2XQzKOyLrEnt9EGBsPh39JG1DKrKxjz7vdJmBwxCiSZCGj5fpf_7N778iNuXFlq5b0FWzzLRo04KlPI4GiB1CqVwy3LxGY3oi8mfnHKG5lLTyE2cs-l0_hhD-HC-6lUvu54tZMe73wz8B_T0P8-hlQwjS8iuEvVQQ2FoAwmucgbxPCFyEPMZulzHi9b7wbBAsHMr2GFIW66BDLLdon1aD2NdtQMP5irJPQSAQcE407lTOuAUK3W0I11R0
Content-Length: 265
Host: localhost:8080

{
  "study_group_id" : "grp_4BQsFkGf2mzpl3ozB8gOIo",
  "cage_id" : "cge_3xmAqV7g5TNNLjp2HpF69M",
  "name" : "Benchling In Vivo Animal",
  "strain" : "tgt6eKDwCZ",
  "sex" : "f",
  "dob" : "2026-05-06",
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  }
}

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

{
  "id" : "aml_29bflwWz7zRzHtexjOo5Xb",
  "catalog" : "A0000001",
  "name" : "Benchling In Vivo Animal",
  "number" : 1,
  "strain" : "tgt6eKDwCZ",
  "species" : "9Ievh4FvNh",
  "sex" : "f",
  "dob" : "2026-05-06",
  "tail" : "ZOWPbko43q",
  "ear" : "vHLHisAyLD",
  "tag" : "3albk9az8t",
  "donor" : "AIBoNm09IK",
  "tracking_date" : "2026-05-08",
  "disease_induction_date" : "2026-05-08",
  "terminated_at" : null,
  "terminated_by" : null,
  "terminated_reason" : null,
  "disease_survivor" : null,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-4321"
  },
  "study" : {
    "id" : "sdy_66bYiGuFiQIpvsXReLyFGf",
    "project_id" : "pjt_arGc6k6KLJy4lt2VYCLpX",
    "name" : "Vj0VAGTGl5",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3XWe6GTeUiBnDnfpGvG5ti",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "VgLopE2Ib0",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7YCzWdfqt5rWLRq92LuTra",
      "name" : "3P67aQOjUa",
      "email" : "wIekuNMj@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_51UKccOEfbiLTadDlkIgRV",
      "name" : "jDDG2jd05c",
      "email" : "m0JyQIUZ@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:15.601900Z",
    "updated_at" : "2026-05-08T16:03:15.601900Z"
  },
  "study_group" : {
    "id" : "grp_4BQsFkGf2mzpl3ozB8gOIo",
    "study_id" : "sdy_66bYiGuFiQIpvsXReLyFGf",
    "name" : "xj62USeENy",
    "no" : 812758317,
    "color" : "#ef7f96",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "new-study-group-internal-id" : "NEW-GROUP-1234"
    },
    "created_at" : "2026-05-08T16:03:15.786523Z",
    "updated_at" : "2026-05-08T16:03:15.786523Z"
  },
  "cage" : {
    "id" : "cge_3xmAqV7g5TNNLjp2HpF69M",
    "study_id" : "sdy_66bYiGuFiQIpvsXReLyFGf",
    "name" : "ZI6qx05qsg",
    "catalog" : "C0000002",
    "metadata" : {
      "new-cage-internal-id" : "NEWCAGE-1234"
    },
    "created_at" : "2026-05-08T16:03:15.791179Z",
    "updated_at" : "2026-05-08T16:03:15.791179Z"
  },
  "created_at" : "2026-05-08T16:03:12.794608Z",
  "updated_at" : "2026-05-08T16:03:15.818647Z"
}

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

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

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.eyJhdWQiOiIyZGM3YmUwMi00YWM1LTQ4YWYtODUwMC01NDQ4NTEyNGFiMDgiLCJqdGkiOiI5MDNkNDFjMy0xZGE3LTRmMzktYTdmZC0xMjVmNWY0NDBkNjQiLCJpYXQiOjE3NzgyNTI1ODksIm5iZiI6MTc3ODI1MjU4OSwiZXhwIjoxNzc4MzM4OTg5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFLbWdLcHlTQW5ldVlnYXVPVGoyZk4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.So2VA-kAUNT0P3xCdMRtV5qFatbeB9uefayMCHg_2mLNdUoaJWQhKOv9GACswodjk2wQGeSzn08ZCaC6C6Zt9mmUqcUFqHr-cVl1ET41G1AnhkazokidGjUncomRz6lZICiW4ywREKboyIGTsimLnhbNMg_5b7h4hfyfnOrlwejlCd9Sqc9avqG8iVieHUuKpl7gsf41kmHds5PKgTaUGGt3UZH8qrBwuEYzCO4c0rQfMu_A91FWuvQfpqzWsMveQjTiJ91rIM7OeqvI6lm2Z6Bp1HBEKKrZwUAtQdT86vMiP0LLgbPMlnQOuuVYdIjrgB5dHyae0sLuPCS1VauDuSu0PKfMdgtpFrSK0coRWnfib59ASwrTvZkCUlmMsDrXYwluOo5jlq07Myy_RCUCwbnezxG5l4yguk1_U4NzEV-lEFhf8oqWlDPcz4A9op0K_bPATnjdx9Vy0-hztp8JG-IqdaYa_faRX0ZcjiRlqpUDATczzAm6wtodTvLl6COtYo9GvtcnbxTQCkitrWY2Km0HZ26zDhjNe2zhjuY6lykKL4Vu4UIlPUwrMDmTcHsTUOSQEJ-vEcVTWNsShPdoW0SzgPiNBZp4nNfTdSenSp3nKE1p4S_LTXcyl5xKN_6Rm2C4HzjlFhzK-X-vTdRLz2u0sPIq4r7IoIBGyRXpYRE
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: 3129

{
  "data" : [ {
    "id" : "aml_2Re7PU12NsTWgf204AXNji",
    "catalog" : "A0000001",
    "name" : "gHEFxkeUfB",
    "number" : 1,
    "strain" : "lud7wFyL6q",
    "species" : "JbaQuXqV3n",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "fG4dlcPLCg",
    "ear" : "1WtBZvIfpz",
    "tag" : "voqFrplrUB",
    "donor" : "bW3Gk1ad1K",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_1Jg2hYuXQOiKL1P9SZSrdC",
      "name" : "PXhLljDL0R",
      "email" : "Zmv5ErSm@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_4K0Rn9YBn25ezujAeL8oMM",
      "title" : "Found dead",
      "comment" : "R0G2WeYpKz"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_3DMaOkiFg6gqIpDooliddB",
      "project_id" : "pjt_44xO0PsfOLZmHH8iJMcbay",
      "name" : "fJ7JwyXWz9",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5FPJmJrrOEzrtzzSWCbgqW",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "gOioOd5Gt7",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_4SaiPKKTyGkUZxUcSZJbIH",
        "name" : "XAWt26AVWQ",
        "email" : "GuJix8zd@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1GTl1m1q9ZnXDrUxCoD8GL",
        "name" : "9a27PGyZ7B",
        "email" : "ts2nCW6m@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:09.511593Z",
      "updated_at" : "2026-05-08T16:03:09.511593Z"
    },
    "study_group" : {
      "id" : "grp_fMCpq0i4I0vl8IxKCC8Tl",
      "study_id" : "sdy_3DMaOkiFg6gqIpDooliddB",
      "name" : "r0Pmgiq30O",
      "no" : 1859828383,
      "color" : "lgknAkYH4U",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:03:09.767056Z",
      "updated_at" : "2026-05-08T16:03:09.767056Z"
    },
    "cage" : {
      "id" : "cge_77Clmj7tHqUOjUyrrf3Kxx",
      "study_id" : "sdy_3DMaOkiFg6gqIpDooliddB",
      "name" : "cSJIv5BgEy",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:03:09.725640Z",
      "updated_at" : "2026-05-08T16:03:09.725640Z"
    },
    "created_at" : "2026-05-08T16:03:09.774582Z",
    "updated_at" : "2026-05-08T16:03:09.774582Z"
  } ],
  "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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Request

DELETE /api/public/v1/animals/aml_4D8BSjTD48DXI3ZGmGBTL6 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MTVjODJlYy0zZjZiLTQ5NWQtOTM3Yi1kNzg2Yzc3ZTMzZjMiLCJqdGkiOiI5YzZmNzc1MS0xZGY0LTQ4NjAtYjcyMy01MGNmNjllYjJmZTUiLCJpYXQiOjE3NzgyNTI1OTQsIm5iZiI6MTc3ODI1MjU5NCwiZXhwIjoxNzc4MzM4OTk0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdUbktvckJvWmYzRFE2R1FWdFU0bGsiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.TKQeP_nAPxOTa4bp9QgMxYA1LuZFfBfELeWYeq85sG2_DrlhZSuSV1gYN6lsFIFzcM5GKyJMkyVZcfd6L0JDk1c419R3PFNHA8uR3S-totqAA5a4AiXFDE9QxMeCxEWrQkIGM-0jPYRk6yQxjRatWwrdfGyMeKei7l5QllAkkKysBSm0Xf969zVdMqrqrN63otRkYdNyltHt-AJAEvLDY0GvC2BWxSCJEvsAGEmhRfVdRzT0wNcTxsDCQSw32eNA_DGGaNRwt2nWebaGhAnCC7NfsRM-OcNy7ob_JXYY6OfAIIccop0tcPwdsnFzJBp_nYiIlZrUMS-HfhGlMYMQfVIeQMlZSYRetvWxm29H5sZcy24YyG4KaCVE0aFGoMUzIRbXip0qIvnLWK72_UIo4xS1RaR25ofMtx2zD-khticTmDQ5-XHRiR5k39SZbgo3FSQ4LIHUNxw4eTszxlSJTrtA0wRSz9ktfx5zkKYI1_HhXkqnmSnmoOG3Z8WoYQQUE2-iejf-87DJkZFOjFl89A9wFt7yEzEF9hk0QBGGZxXC2zQAV8V1qv6m2oZUl1KOGIaX45ecdZQytgPvs2eGin34RyiBExdFBzRuH_Uhxt9-01JAkuR6j-MyWx6BZX-qHeG_MPopEJTRYl7-HAA_a3OQbC2m159xKQohrYlghzY
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: 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

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.

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

Parameter	Description
`animalId`	The unique identifier of the animal.
`dosageId`	The unique identifier of the dosage.

animalId

The unique identifier of the animal.

dosageId

The unique identifier of the dosage.

Request

GET /api/public/v1/animals/aml_6CjLcy7DvINylbZCqRhTxo/dosages/dsg_239jV7h9JpcmE8WUjobYKt HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MzA3Y2E0My0yM2QzLTQ5MjktOWIyYi1kM2JkNDQ1MGY5Y2IiLCJqdGkiOiIwOTA0ZDRmNS01YWQ4LTQwZjctODNhNi0zOWM3YzE1YTg1N2MiLCJpYXQiOjE3NzgyNTI2MDksIm5iZiI6MTc3ODI1MjYwOSwiZXhwIjoxNzc4MzM5MDA5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzROcmhHcnFOYWpRNWxoaGlkVnlUZDkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.h-S5DCgqX0h_50zc3SoYw7LU1lA4XgThZxHryjJAdncuxB9-AEkJWtppE5NXqW83rUGhE13hWQXdpNAW1klJ4KfQWhirDAhXrIamzFyCfceh7eabWpTE9Be4m0hoO3C6vzlDWgowLSL7gdy1c0aYHvevrCuY6gqTCCNRh7_UhzM3PIxC1FOZvvVRNyNi1e15vCL6V1Tts5OAuDUnJQd_ONB8nAUh2TNeOR2VZxwKSxj-Y72qkpSePmdG055sO-p0Ah5FOuOoEUZxgg2-L4pbpy6UbaobBpsbRxvqPo_ZX91DRIhRJjcU5KIThy4X5UW-zRWHnv6rtCrUBtn81z-3uxhroTcI3L6EuqrLYb10o4Mh68HLfiXo_5rPPjedjeSJVrDgH8Haq7Ix-e4cH2gt2ka7OzoG4hxHo0Zoi6wafgFGYd7wo_wcmverqeJxv1vAkfUoY81AqTyR2vCGsBMdwblEgyjjFTuGA5mSY7Cdwxwk0OXTnzZkYIspiRee-Hv2zfY75qZp4-4Ixn8tlDX3o48N1BoOf_uH49mHNA5tei82zmegPEfYp0kENOQcbIosMi41iU2MKE57INEFyf7EWMxIX0WmeGL-Way-S1I-5K49n5dtRBas1KGGRdrX617woCQngatBUraKpxi1O3tBOmsgYFXZRVmWiUMFyCP_gG8
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: 4627

{
  "id" : "dsg_239jV7h9JpcmE8WUjobYKt",
  "name" : "Example dosage",
  "dosed_at" : "2026-05-08T16:03:29.060909Z",
  "comments" : "hCSc2lhfQo",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "3.87",
    "display_unit" : "mg/kg",
    "display_value" : "3.87"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "14.34",
    "display_unit" : "ml/kg",
    "display_value" : "14.34"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "28.05",
    "display_unit" : "mg/ml",
    "display_value" : "28.05"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "32.79",
    "display_unit" : "µL",
    "display_value" : "32.79"
  },
  "study" : {
    "id" : "sdy_4WHwID40ka1N6DdnHq7QnI",
    "project_id" : "pjt_UD2VHvcug0NsAY6iTEumT",
    "name" : "bOWieAAJqv",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1YBNLrOd3oTg0zmBYHc6uJ",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "iuEI62kr2a",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_4FecjooavFlSmyXWZMJhL0",
      "name" : "V0tVGmcnCK",
      "email" : "lmqFnbvG@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3UZAcAUEDMZea8KAP1Kife",
      "name" : "5bo2WYqDzl",
      "email" : "xlxxkWQN@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:28.811005Z",
    "updated_at" : "2026-05-08T16:03:28.811005Z"
  },
  "animal" : {
    "id" : "aml_6CjLcy7DvINylbZCqRhTxo",
    "study_id" : "sdy_4WHwID40ka1N6DdnHq7QnI",
    "study_group_id" : "grp_3ikKapDa04ehWfnOzYtX4K",
    "cage_id" : "cge_BbGmCl5cIoPRCw8Lm2Uwu",
    "catalog" : "A0000001",
    "name" : "JEFKsWjf9Q",
    "number" : 1,
    "strain" : "diq1gfMzEV",
    "species" : "wH0S9rpz1A",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "aQRt5XQCiI",
    "ear" : "tZRzkDSc3a",
    "tag" : "y4lm9fG4KL",
    "donor" : "izkW93JeBa",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_7my3Uj0IkdkgFuxm2jh4S2",
      "name" : "kzDrXRB3Oh",
      "email" : "doppXdAu@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_242sQ3YmAC311r6qx1BJeB",
      "title" : "Found dead",
      "comment" : "omv0k4InsK"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:28.974665Z",
    "updated_at" : "2026-05-08T16:03:28.974665Z",
    "disease_induction_date" : "2026-05-08"
  },
  "measurement" : {
    "id" : "mst_1dMunNBktQ8ZdxcgXG6Cjq",
    "study_id" : "sdy_4WHwID40ka1N6DdnHq7QnI",
    "animal_id" : "aml_6CjLcy7DvINylbZCqRhTxo",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_bC3FdNfPbXNGZ7v8uL4WP",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "created_at" : "2026-05-08T16:03:29.044887Z",
    "updated_at" : "2026-05-08T16:03:29.044887Z"
  },
  "user" : {
    "id" : "usr_2Y4xLLSYltL1560RfoZyDz",
    "name" : "FnVyx Overwatch",
    "email" : "nJDaoDzT@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:28.788394Z",
    "updated_at" : "2026-05-08T16:03:28.788394Z"
  },
  "treatment" : {
    "id" : "tmt_6TkdRbf2tubbdGpTe35SE7",
    "study_id" : "sdy_4WHwID40ka1N6DdnHq7QnI",
    "type" : "dose_volume",
    "name" : "DX1o1mdAPt",
    "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-05-08T16:03:29.053712Z",
    "updated_at" : "2026-05-08T16:03:29.053712Z",
    "external_entity_id" : "phmrlIneDL"
  },
  "created_at" : "2026-05-08T16:03:29.060926Z",
  "updated_at" : "2026-05-08T16:03:29.060926Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

Parameter	Description
`perPage`	The number of dosages to return per page.
`page`	The page of dosages to return.

perPage

The number of dosages to return per page.

page

The page of dosages to return.

Request

GET /api/public/v1/animals/aml_53O23oN6mAQgrZbzMLacN3/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MTlkNjRlNC03YmI5LTRhMTItYTA5NC02ZmMwNGQwNGQ4MGEiLCJqdGkiOiJlMWZlYmY1Ny0wOGVkLTQzNzMtYmYxNS1kOGU4MjM4ZmFlNDgiLCJpYXQiOjE3NzgyNTI2MDYsIm5iZiI6MTc3ODI1MjYwNiwiZXhwIjoxNzc4MzM5MDA2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVyb204QmhRTGNsV3RBVVg2bldxY2MiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.TM0mnzVxe6bvZqai1JGDajYwZLKRLIXe9G3aDlaxEnWszczADhRobW6OveNywj13wb_6Ox-vPc1dA4NH0tvkD2UJlw7gnHKpO514eu83TVp7A_X4h3TCnCPYzOJXEcgOihL3mZnfncUdoNVC-3eNWIn0oAlk1Ignjerbl2-GUpxQtpbYE4j7SDT9Y2Xs5IgbMawxKECNoesiGlwRj9h94sZ1OueaUSmEjsPsinX5piVqZHlR0J-olgt81Zek67s8_d92zBdFIBfqPBIe1nPIGh_22CnHQkbq3OYPV9CFsdNBYo5OjNFjCG4ycWiuP2uROZxvQGoEGI1PxpyV1YCpRmkBgB5x57z_kpkxmyqACXLxxZgfokMGlWm8vC3P9sSNwm4iTgFoZRdrPM6qSm7Q7wsqNmxcSUJJ_wWSqV7u5bGTiaC4HeyWzyNprJkjQ23V7VbsLtsyiVfJ3pCvbCDJZj0GG-zyrnQrQrb5h3FNwdn4nTyxAPPol89rc-726wqJVE_7nunQ-tslcGT6nzuYoEMmwi6gkboQP5LPB-rSzAMbyRFJtc-tq27dg3NB57sAXJnPil24AuwfaQ6vcafDkR1spvNUupreDlpXeXjCgu8V6-6F1NVySLT4PwMyWb8JT8SD-CCA0QRZjV-g3CAcd0KMMuEV86DdH9FRvsRe0oM
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: 5463

{
  "data" : [ {
    "id" : "dsg_v3Z9NeMF8VJ26TJIAUkHT",
    "name" : "Example dosage",
    "dosed_at" : "2026-05-08T16:03:26.816227Z",
    "comments" : "geyfyOutTZ",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "1.57",
      "display_unit" : "mg/kg",
      "display_value" : "1.57"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "14.78",
      "display_unit" : "ml/kg",
      "display_value" : "14.78"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "21.68",
      "display_unit" : "mg/ml",
      "display_value" : "21.68"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "34.16",
      "display_unit" : "µL",
      "display_value" : "34.16"
    },
    "study" : {
      "id" : "sdy_5C2oUTp8wg9C5JCMCIBYWj",
      "project_id" : "pjt_5OPeDezZy77sTS7hEURYrl",
      "name" : "SN9iIvX3Rx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_75SosF3mjmvro4ZA6t1XPG",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "mQdYzha9tH",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_4CGdQuZglVdW69XXNnxMsJ",
        "name" : "3bytqV9YDm",
        "email" : "3qeEpJ9b@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3w1PuyoxL6xcGIB6KiyxJK",
        "name" : "fvlTUJwH4G",
        "email" : "Mj1BMlUF@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:26.564475Z",
      "updated_at" : "2026-05-08T16:03:26.564475Z"
    },
    "animal" : {
      "id" : "aml_53O23oN6mAQgrZbzMLacN3",
      "study_id" : "sdy_5C2oUTp8wg9C5JCMCIBYWj",
      "study_group_id" : "grp_7GLUarD141G62sdjYR6tXK",
      "cage_id" : "cge_4uVxImvsDIR3waueJKDDR6",
      "catalog" : "A0000001",
      "name" : "8f2JL8rmgZ",
      "number" : 1,
      "strain" : "1ms0CCKURE",
      "species" : "7rbEUuF6sp",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "bGQqvLaRry",
      "ear" : "DgiRHKfHIq",
      "tag" : "3VaZrVvXpr",
      "donor" : "R1OrAqv1aR",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_2WuB8vSsrY6UuzRbNGqK3t",
        "name" : "dtu7Q1ZNIb",
        "email" : "ht9rwZwp@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2HYqTJwo68PYRJMF59l3uG",
        "title" : "Found dead",
        "comment" : "fse0iznj5Y"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:26.719602Z",
      "updated_at" : "2026-05-08T16:03:26.719602Z",
      "disease_induction_date" : "2026-05-08"
    },
    "measurement" : {
      "id" : "mst_6rZDgfRBfHEsghlVQpxqUV",
      "study_id" : "sdy_5C2oUTp8wg9C5JCMCIBYWj",
      "animal_id" : "aml_53O23oN6mAQgrZbzMLacN3",
      "measured_at" : "2026-05-08",
      "calculations" : [ {
        "id" : "vbl_5k7Z4CBH1mjhTjsQD2NeHW",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ ]
      } ],
      "created_at" : "2026-05-08T16:03:26.792289Z",
      "updated_at" : "2026-05-08T16:03:26.792289Z"
    },
    "user" : {
      "id" : "usr_3x1rYxxlCw1Zab1TBhIRVk",
      "name" : "IfK9a Overwatch",
      "email" : "Z1pPM1aQ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:26.549015Z",
      "updated_at" : "2026-05-08T16:03:26.549015Z"
    },
    "treatment" : {
      "id" : "tmt_4XwqbDTnjV7OlsxOvxmVAR",
      "study_id" : "sdy_5C2oUTp8wg9C5JCMCIBYWj",
      "type" : "volume",
      "name" : "k2URQODhIb",
      "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-05-08T16:03:26.803927Z",
      "updated_at" : "2026-05-08T16:03:26.803927Z",
      "external_entity_id" : "4mflgH4Dsf"
    },
    "created_at" : "2026-05-08T16:03:26.816235Z",
    "updated_at" : "2026-05-08T16:03:26.816235Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_53O23oN6mAQgrZbzMLacN3/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_53O23oN6mAQgrZbzMLacN3/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_53O23oN6mAQgrZbzMLacN3/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

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.

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

Parameter	Description
`animalId`	The unique identifier of the animal.
`measurementId`	The unique identifier of the measurement.

animalId

The unique identifier of the animal.

measurementId

The unique identifier of the measurement.

Request

GET /api/public/v1/animals/aml_4xgRl1OoTTMrv0MmnGrvAY/measurements/mst_35kHX1DXm3IlKtcPDEq5Kd HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyMDcxM2JkNC0wOWJkLTQ4MTEtOWFlYy02ZDQwY2NjYjQ1YTciLCJqdGkiOiI4NzAzMmJjNC05ZGJhLTQwM2YtODkxNy1kZjI0MDFlODY1MmEiLCJpYXQiOjE3NzgyNTI2MTgsIm5iZiI6MTc3ODI1MjYxOCwiZXhwIjoxNzc4MzM5MDE4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVXc1U2YkJWVWtDNG84bVZGVENZSTMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.TmLItAOMgdKKfTKQxt5StD7s4Ch3cI92JuzauSeHc7qJuIbeBU1tx4m32TQtz3WDCj-AEHukH6MCy4th7M7MgikShbFob89onwVTLKBzFDPtlOrdAEGGvpc_Dr8J4YBfYfcsirLB6EoUbMFmAj-0LxQxA4DvhBAbGGNZAV8Ykrl7fsEtBNqv26o5_vq9n9BwqmvbaGNXU8vHaqMhSn51iE-VvI-_KLdCh1DGV4BTpP8fQtaORvvP823VSiw6wDgWZjOO1r2_PVpdfwHMnPK8ZX87zQiLO3Zwr99V3K9uAQjjy8l0YgGv2C8PPD6jP_br0s1UWoNAUltp1K5Be32KVSUfrdHIcahlADM1qhDLzgFYTaDuy-PEj8ZndkXTv39iGZz70sc0MMNaQoHw0MouTJuYsXo-h7tFLdymRl5BsFlVLujxSRMVl-KjVALfMv7QKCamLYL9gHEtQPmDhEO5DYg5yZuvjS_P3aNk8rxoktmSF_PEO1bh1wk-hW3aImjy1g87gOvX3-K8unog_JiBCZbRWaZHXNNDJhAfs41ADHQxrvRW2U8szUp8BIp6X9526kUzc7TNg1PBHG5qngDYli1kM8Sy5e4GBAaCLEh85UvfY4aqOOLBierVMp00Yw5P0JrnYbi799zcIkL-PmiyBacrwja_8wwt6lPriTjB6fM
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: 3256

{
  "id" : "mst_35kHX1DXm3IlKtcPDEq5Kd",
  "measured_at" : "2026-05-08",
  "calculations" : [ {
    "id" : "vbl_6wElQ6Wyg3r5BI4EO9Ut22",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_1Fo8FEUwkCQOt8aEvubOF4",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_2uPPgNbessRJlrFOUhfq4V",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_2R3QDNoYuTpKVE7PT39gfK",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ ]
  } ],
  "study" : {
    "id" : "sdy_5DYCxDxIZhxD4b0EpdgKJA",
    "project_id" : "pjt_16Kl2Mkx3qDNQYXuOWMqnY",
    "name" : "gFz8UZOtqi",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6LYTya39T4hijwi3OJqg6I",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "Q1OkWeUupv",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_6Xcfk849dNWnW2E7WNF5UV",
      "name" : "41OSIzzrH6",
      "email" : "bdftNva4@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1UOJJ4JgV7CKdy8w8URi0E",
      "name" : "Y9urM4vRQK",
      "email" : "lDVRH3mF@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:37.940034Z",
    "updated_at" : "2026-05-08T16:03:37.940034Z"
  },
  "animal" : {
    "id" : "aml_4xgRl1OoTTMrv0MmnGrvAY",
    "study_id" : "sdy_5DYCxDxIZhxD4b0EpdgKJA",
    "study_group_id" : "grp_12Hpg7CuAzQYhRPfVhGFl2",
    "cage_id" : "cge_3ww0SfBiIdHnYPkttoMxVE",
    "catalog" : "A0000001",
    "name" : "mMj1Z4fMIe",
    "number" : 1,
    "strain" : "G450Wx3c6j",
    "species" : "Utb43JB1vh",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "NoqDD0WoZC",
    "ear" : "1a4JNF1RfQ",
    "tag" : "veEcroBVQo",
    "donor" : "eQzYndglHp",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_79ojHx9x47QLhcyZTxdG99",
      "name" : "3gflqU1dVO",
      "email" : "6L1RjFxS@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_67EJxnBxobwugD4E8f4dG2",
      "title" : "Found dead",
      "comment" : "gkDCiHG2rt"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:38.102471Z",
    "updated_at" : "2026-05-08T16:03:38.102471Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_5upfrcQicAgr0jMQCjH3Sy",
    "name" : "32EhD Overwatch",
    "email" : "t6k6hVgQ@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:37.913079Z",
    "updated_at" : "2026-05-08T16:03:37.913079Z"
  },
  "created_at" : "2026-05-08T16:03:38.175681Z",
  "updated_at" : "2026-05-08T16:03:38.175681Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

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).

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_6tGA4OFEw0IEAR76JPy6Zn/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1YTcxODUwOS1hODQ4LTQ0NzEtOTI3Zi0zMTIyZTNmMWEwOWQiLCJqdGkiOiI5ZjNlZTdkNC1kOGRmLTQ2NTctOTQwNS05ZTg5YjJhZjEzY2QiLCJpYXQiOjE3NzgyNTI2MTksIm5iZiI6MTc3ODI1MjYxOSwiZXhwIjoxNzc4MzM5MDE5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZOcEVicUpFSVpvM2RxQ0Y2cDYwb2wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.gCXDrvbwKgcS1XPD0ZTjawGUpmu1wPZwlugbApGG74ZKizLJdGZk_yCen_c1EnxJvJsvHEDvC8Ixr5VbWl_suMsZcjkyuV2eM045DaS0d3u8M8No3JXeG4xik7xsl-Ibn0xKJg3OS5vI5GnWArzkHr4eUHyuhXtu0nCrLH_RNEeP0HWB95dnQXFKDrPqqzPAULFuaqfOY1tKGVfCpfYGYgEcyGMYJxOaevcLXaQ_bZq7PH-0D4Y-zWYA0RA7MZU3Hl1KPn4frrl0bq4kfOuJI0z7TtdBbP1nUpVSkOcoi6MIgIfa_hpXO3NaN22kQkghAWyJKHPCQVVihcxne76aqGTLLM-OApUOBtTJWcsEakD1BLvHdvaz2AHPfF0DQlGjpvkx5AgsRIeI22Ytoj4dQG2JG0B6JIWJ_MhuM_ZxLnPzrSQuvRSZ1mkoDOS0iTXBja387a7-NsRsy4PV0dy0aaY1wGp7BPCT-kYrWZNiGZ6Q6gkRuPCAcp-iMhmJuBSJ5ZLbItkigH4Rk0aqEVEXgzxwBk_BpdLRmifqZB86kkdtqWbrEQXK_bzPtxu67KFMoQloE72WIE8b4lVKUkvQRayTCK96m5QOeGGSI2sB60Sro17WUOUtaGIoZJVddeXODsxkOwquwa1_3xhMjW5N0kx-83VEUZo-S4G8UMMqM2I
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: 7485

{
  "data" : [ {
    "id" : "mst_3eOhID92BPq2TMbwbuBMVz",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_2Qe6TVKtPJN4gGPABqfozr",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_3yG00fyR8kIP4OSVjnZ2EX",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_5rOZE2Oqd4KtHxjGEMwADt",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_3OdajMyJxhCEZ6sAjWIEZh",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_S0c8c1UenMLJJAAnDybA6",
      "project_id" : "pjt_7EoC9WxIjocRunv0HIVt3g",
      "name" : "Bnupw7TSdA",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5aSYJHTvycvJ7n1pTGXzyM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "YLFAtjnozl",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_Q8DHkCZd3Pt712D6R5m5x",
        "name" : "cD30hn9yJw",
        "email" : "WUN4zD5P@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6QBaZwboccOUENZmGm6aWf",
        "name" : "ED7QjO1Mxv",
        "email" : "HGtc9ZvR@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:39.649548Z",
      "updated_at" : "2026-05-08T16:03:39.649548Z"
    },
    "animal" : {
      "id" : "aml_6tGA4OFEw0IEAR76JPy6Zn",
      "study_id" : "sdy_S0c8c1UenMLJJAAnDybA6",
      "study_group_id" : "grp_4dEpVOeZqnQbWi4z7EbB5u",
      "cage_id" : "cge_10LJPPjj44bN9kdDDPutqd",
      "catalog" : "A0000001",
      "name" : "I603KJdWNk",
      "number" : 1,
      "strain" : "CHurxJkydV",
      "species" : "XgByOZKgGV",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "V7V78l4yok",
      "ear" : "m8EoIJiXyA",
      "tag" : "aYX2qBroSq",
      "donor" : "kCXoue1GsT",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_2H5dnPHPDMPAwSov3kYLHt",
        "name" : "FIuhtpfcJ9",
        "email" : "jzomQ2bX@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3quUzRs1GdeG0yNbRV6qE8",
        "title" : "Found dead",
        "comment" : "hIyFa6nIKO"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:39.845491Z",
      "updated_at" : "2026-05-08T16:03:39.845491Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_1Psug8yOpUg1sUhj19UGuj",
      "name" : "bPVeZ Overwatch",
      "email" : "FEdt63qt@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:39.629119Z",
      "updated_at" : "2026-05-08T16:03:39.629119Z"
    },
    "created_at" : "2026-05-08T16:03:39.917663Z",
    "updated_at" : "2026-05-08T16:03:39.917663Z"
  }, {
    "id" : "mst_3wSFmWJ5Fex5aPi2gluUbq",
    "measured_at" : "2026-05-07",
    "calculations" : [ {
      "id" : "vbl_35pWHEH5KzeJ0LixXm9096",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_2vP8jijXedX655wMsXFCoi",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_2XjnQPPQdLuHpGYsk6yiNk",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_4aH7iUGda8Vesz6pfLP1XW",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_S0c8c1UenMLJJAAnDybA6",
      "project_id" : "pjt_7EoC9WxIjocRunv0HIVt3g",
      "name" : "Bnupw7TSdA",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5aSYJHTvycvJ7n1pTGXzyM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "YLFAtjnozl",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_Q8DHkCZd3Pt712D6R5m5x",
        "name" : "cD30hn9yJw",
        "email" : "WUN4zD5P@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6QBaZwboccOUENZmGm6aWf",
        "name" : "ED7QjO1Mxv",
        "email" : "HGtc9ZvR@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:39.649548Z",
      "updated_at" : "2026-05-08T16:03:39.649548Z"
    },
    "animal" : {
      "id" : "aml_6tGA4OFEw0IEAR76JPy6Zn",
      "study_id" : "sdy_S0c8c1UenMLJJAAnDybA6",
      "study_group_id" : "grp_4dEpVOeZqnQbWi4z7EbB5u",
      "cage_id" : "cge_10LJPPjj44bN9kdDDPutqd",
      "catalog" : "A0000001",
      "name" : "I603KJdWNk",
      "number" : 1,
      "strain" : "CHurxJkydV",
      "species" : "XgByOZKgGV",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "V7V78l4yok",
      "ear" : "m8EoIJiXyA",
      "tag" : "aYX2qBroSq",
      "donor" : "kCXoue1GsT",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_2H5dnPHPDMPAwSov3kYLHt",
        "name" : "FIuhtpfcJ9",
        "email" : "jzomQ2bX@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3quUzRs1GdeG0yNbRV6qE8",
        "title" : "Found dead",
        "comment" : "hIyFa6nIKO"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:39.845491Z",
      "updated_at" : "2026-05-08T16:03:39.845491Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_1Psug8yOpUg1sUhj19UGuj",
      "name" : "bPVeZ Overwatch",
      "email" : "FEdt63qt@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:39.629119Z",
      "updated_at" : "2026-05-08T16:03:39.629119Z"
    },
    "created_at" : "2026-05-08T16:03:39.927475Z",
    "updated_at" : "2026-05-08T16:03:39.927475Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_6tGA4OFEw0IEAR76JPy6Zn/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_6tGA4OFEw0IEAR76JPy6Zn/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_6tGA4OFEw0IEAR76JPy6Zn/measurements",
    "per_page" : 10,
    "to" : 2,
    "total" : 2
  }
}

Animal Observation

Retrieves the details of an existing animal observation.

Attributes

Path Type Description

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.
`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.
`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.

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.

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.

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

Parameter	Description
`animalId`	The unique identifier of the animal.
`observationId`	The unique identifier of the observation.

animalId

The unique identifier of the animal.

observationId

The unique identifier of the observation.

Request

GET /api/public/v1/animals/aml_7fkxQYNH6QTMVjpkYAgPXF/observations/obs_4i4UFoDagQrXjlOHzL40uv HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiM2FmMGI5Yy1jODQzLTQ4NjgtODMwZS0wZjFhYjk3YzliOTYiLCJqdGkiOiJkODc2NWZkZC1mOGI0LTQxNmUtOTk1NC1iMmJjYTJkYWZmNDAiLCJpYXQiOjE3NzgyNTI2MjgsIm5iZiI6MTc3ODI1MjYyOCwiZXhwIjoxNzc4MzM5MDI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFxMG1jN1BIalpVU1VEelN3MUFhWU4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.CzuNMPRZyK_dHQcb-j1zVp5mhEWm0-aaSpHAXgZkqFucUe1VG4kHtHaEhfJAGWgNtYm3XNfykM5VVqwRDj2IItb0VKU2lZJArVfNCOzqc88uRocJ1jBsRHs_pQX9s0LcI253xVWMCmk3UJGdYd1WLUuru4L2FWf0Kn8YhunGPT7hY1O2T_zW29OTCDdmm5cepSxIxdIIs8O9-GZySG4rnZ8gUS1N1dG2S0_esswGG3PB2EPB9RUZzri0q7YT77rEeZ5cE7MPTTzviHYFsdXxfvSrRvw7-E94d_l_5uTk6gFNmRaulKtefk1xENE0BOMG24MY0qisUnV1AmmNXfN_dFJj2nk6WRHHEZkRaK-j3ze75RbLIRQbR8jrhlQPnamIo-X4Tyvl63l_BufaFdfMTgc3ONYBpEAq6I_0cmhW2Eau-Jfo4s5CudXpBC0_VQbYmoNn7OMfR78m9tNKwAFPKqSGINHuaXdsf3FtwPc7SacmoqLeb438vlgBxwDGGwKrQWGWiU99CmqbW6ze9AhBbEjLhR93ygli3aoqTndD9-UXU255zFHKAlAlffFk47nCiYwLXVxr5oj-zsP9sc1oYJWVQaZNOs_f3Trt3y6Knn-5V3CS4uTYrHmIwMlEUgX6TuTMjgDSHe_QqvD29r00rIc56-jiN-ciVqxL0MKd97A
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: 2778

{
  "id" : "obs_4i4UFoDagQrXjlOHzL40uv",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_v5TW0Y0fwP7A6K0i43QXx",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-05-08T16:03:48.195406Z",
  "study" : {
    "id" : "sdy_2DCXqaU3FHUcgzwA1WuBIk",
    "project_id" : "pjt_1qgckX2bA4LC8BClLQVu7S",
    "name" : "EVCAjcJvo0",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6cmRv3KrIMDuPihnVRiY2r",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "uJrzJuoBri",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_2lADP8i1A6ZIzbqGGLbpuz",
      "name" : "vcs9kDC88x",
      "email" : "P6WGmceo@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_L3Vskw3ApJ8tpdXQfAppa",
      "name" : "BQ7mE0LBS5",
      "email" : "QRbTEzt6@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:47.953474Z",
    "updated_at" : "2026-05-08T16:03:47.953474Z"
  },
  "animal" : {
    "id" : "aml_7fkxQYNH6QTMVjpkYAgPXF",
    "study_id" : "sdy_2DCXqaU3FHUcgzwA1WuBIk",
    "study_group_id" : "grp_5Ttu3BnEk7kM4MErLCw91e",
    "cage_id" : "cge_1uFl3OsIrcS87KYyl7lRcr",
    "catalog" : "A0000001",
    "name" : "ws3AtsIpcQ",
    "number" : 1,
    "strain" : "YCOM4k4LZx",
    "species" : "hd1kkHz77z",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "cPYZQCdfuP",
    "ear" : "bKVEe32xLL",
    "tag" : "nqf066XXRT",
    "donor" : "RbWJli7YlW",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_584sjofWWefXzhjaOkjXIc",
      "name" : "qhQNTT1K6s",
      "email" : "W7WE7W09@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1HngCnuu7uJZqcruhR9PQB",
      "title" : "Found dead",
      "comment" : "tJhMa6mbZj"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:48.105008Z",
    "updated_at" : "2026-05-08T16:03:48.105008Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_44DKgLE5WJfGEJcGIAi59n",
    "name" : "FEtGy Overwatch",
    "email" : "wI9CmIPB@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:47.928232Z",
    "updated_at" : "2026-05-08T16:03:47.928232Z"
  },
  "created_at" : "2026-05-08T16:03:48.195524Z",
  "updated_at" : "2026-05-08T16:03:48.195524Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

Parameter	Description
`perPage`	The number of observations to return per page.
`page`	The page of observations to return.

perPage

The number of observations to return per page.

page

The page of observations to return.

Request

GET /api/public/v1/animals/aml_3iwWnoNilnxJM9G1NZf1Sr/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMDlmZWFkZi01NDgzLTQ4NWUtYWFmNS00ZTk3NTRhYWUxOWEiLCJqdGkiOiJjYmMwOTQyYi1kMDRiLTQ5MTYtYTczZi1jMGQ2ODY4ZmZjNDQiLCJpYXQiOjE3NzgyNTI2MzAsIm5iZiI6MTc3ODI1MjYzMCwiZXhwIjoxNzc4MzM5MDMwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRWZ2ZIY2dHdmRBd2JkNDFNSUlsR2MiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.JIgxxSBpPo6ekYk5aXpJ6QGfic6QQNXXjvny-cBy1Ga4sCy6QxqRgrsnKYqyLDS1PsV6_DHIeKDGEs4BAxyymcf9GM-mynDdMSrRO-xo9MMfBrU33j7VzeJ5ny255mO4RoMIqOlbXRHtkBLB_TsokQB7qF6_rHDdWZYB2RiTwtANw9bcKoiG8uvfhD8bf3w-4zZoaCYRUfQYEOXLUhUgeyJFNO_xhMFQgO5sqrMxe74fvsZLmLeFAuNW2uaDDIkPv2h9tUZdCO9inYWmA37Lgu3TT8Q8f28_W7X6ECku4HYCOTdApfaHsNFUlHCsuKftAbOFKklpa_2aN4ws4m6fFgl6ZaJ7_7CS3lVVWD7nYBoaf1arHAMPM_-brVnJg6elyIoF3jjPl1i1iTUwSfx7MDKm8AMZ65h2qr3DljZN0VZbacWAPkGjeRSJb0E1XC0Jr3KqXr0mnlII9J7Qeiy-qTXAzmP4NV24dB5X28-_jY9jY4m_8tOq_iC3VxHUjxGDzR-PVF4VAXHZBvJIqwgoQOdtaKuIDRS-SxpuulUzmy3962-ZyqORsUfU12gkMP5X4gJukN8TBz-oZqoMFkwevFCaxFRXAITWVOlAbSi6caqc5DADXC2qD82EI7X0H_jywJArvG2GGGfDHdgMVb2vXqUkhDEYP2MhsgufHeXXFbA
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: 3482

{
  "data" : [ {
    "id" : "obs_227sLuX5Wy9Y2ZDtAq6LyW",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_4WZikQdfCKm6rk2I6odsi9",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:03:50.381786Z",
    "study" : {
      "id" : "sdy_4qnGSOYSBBkr3gkEAoOHcl",
      "project_id" : "pjt_5Q2pEdwgAqLfSTdZw5LJ2L",
      "name" : "nG07skdtyQ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6ISMObns4KdEg4wSpBxANd",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "OuGeByv06U",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2CdlrSyX2Q8EhEotD04ud7",
        "name" : "Wm2winiGxV",
        "email" : "wYOlNOKL@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2AcYlaKoRpQC2koVFBjba9",
        "name" : "pCFLGI1oP9",
        "email" : "PWHAUL5o@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:50.138650Z",
      "updated_at" : "2026-05-08T16:03:50.138650Z"
    },
    "animal" : {
      "id" : "aml_3iwWnoNilnxJM9G1NZf1Sr",
      "study_id" : "sdy_4qnGSOYSBBkr3gkEAoOHcl",
      "study_group_id" : "grp_4Z9FICE9A6nqvwMboJUTmM",
      "cage_id" : "cge_4gZywEaGo5rbZ4TKwLwzUF",
      "catalog" : "A0000001",
      "name" : "GDNwcJpwEW",
      "number" : 1,
      "strain" : "zI9SscvCZz",
      "species" : "zXw3wpYhP3",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "HTBg3TiaOO",
      "ear" : "ZhPLMbu3Uj",
      "tag" : "N4hNAEnV01",
      "donor" : "DYQTaChbsb",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_OdHLrMp1TrRm4RgsMswBl",
        "name" : "HZ7cznGxJy",
        "email" : "415ipakf@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4cSnqaUmEkj2iL9aRoEdiB",
        "title" : "Found dead",
        "comment" : "vd5wbdTbmk"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:50.307631Z",
      "updated_at" : "2026-05-08T16:03:50.307631Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_Qzd6mr0XHrib2bFXnvGSn",
      "name" : "XD6xM Overwatch",
      "email" : "SU1RaNxu@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:50.116510Z",
      "updated_at" : "2026-05-08T16:03:50.116510Z"
    },
    "created_at" : "2026-05-08T16:03:50.381804Z",
    "updated_at" : "2026-05-08T16:03:50.381804Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_3iwWnoNilnxJM9G1NZf1Sr/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_3iwWnoNilnxJM9G1NZf1Sr/observations?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_3iwWnoNilnxJM9G1NZf1Sr/observations",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Animal Sample

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

Attributes

Path Type Description

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 collected timestamp of the sample.
`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 created timestamp of the sample.
`updated_at`	`String`	The last updated timestamp of the sample.

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 collected timestamp of the sample.

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 created timestamp of the sample.

updated_at

String

The last updated timestamp of the sample.

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

Parameter	Description
`animalId`	The unique identifier of the animal.
`sampleId`	The unique identifier of the sample.

animalId

The unique identifier of the animal.

sampleId

The unique identifier of the sample.

Request

GET /api/public/v1/animals/aml_pQkMdNjY1DhS9flO9LKir/samples/spl_2swhyvt3ADeEzGuktvLG63 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYjQ1MWJkYy04ODRkLTRiYzUtODc1Yy0xOGJjYmMwNTE4NmQiLCJqdGkiOiI1YjA2Y2M1ZC03ZWJiLTQwMDAtYWM2MC02YmRkNTIwYjU4MTMiLCJpYXQiOjE3NzgyNTI2NTIsIm5iZiI6MTc3ODI1MjY1MiwiZXhwIjoxNzc4MzM5MDUyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdnTHVCMFhjRXNQS0l2RHY2bGRVU2wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.LglJV3Wo2hyuKNBetjk38dU3iWyXAiP2Cpuj1jcwLynGRPxhY4fs_ELAAef9XZ_PQcf2reUrh0Z6cymtU9Z92VTS6A7-9OY8iumHLEbKYdJ8ovwHXuUlIz0tXOJcBfpiMxaPnx--PBnOQFN-0SN0FGwwNXJ6WII9ucNOj_y874tu9LsBWI9uWrKCNJnLxdT4ka1uniOYwxUMObScD93rCQGjp_XmH112iwtZKtYgqYSulJ6pLUpFWCcTNhLy0_wKT8c8Vi74xLen_bqwAhi182w5SFU6hXTEyuSnk8bi6Ceu4OFnv7tOoA2UXVjyqqVh2gA5alyo9-tmwC2ql8k8sfb4I3QhY6kFVgmzXmJfvV8y-NADfjtI8kjQ-8ftlZs36Zt0EZAL-wmaHO3n7XRE2v0pEgOlrqcKj6L3dzLe8_SagPjsl38KJC-3imSj7p0RAaKG18vTC_clEPogTk5KOd4sXS81CEda9xxoDug26p6orFDdZqath9s0dIgCYr25o41pru_MpSDso-JUWosROgFFK-p_6wROrdCLASuvTexD4u_qvIssqQIgRe-ULa_mNlTfK-OxijWTYjpZXzB7piZWcfJGGst7qdpZGBkWFyEFlNfzGUiKnclpAfDgsaV-vk8GXeWxo0K2tp7PeZ97FI5aoVLdTT6JC6m4w1aHHT0
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: 2929

{
  "id" : "spl_2swhyvt3ADeEzGuktvLG63",
  "sample_id" : "S1846496496",
  "sample_definition_id" : "sdf_2MqsS8AB97dGBW2N4QtTSK",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-05-08T18:04:12.590454Z",
  "details" : [ {
    "key" : "volume",
    "unit" : "ml",
    "value" : "5"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-981739149" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_6Vezj33RH9FJm3Bg3rmaic",
    "project_id" : "pjt_4LsyHgwyjZxJTQnMj5YGzE",
    "name" : "1ALgsIACsF",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3fE0M860cdfVXdIkvkBjQY",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "1W1IuR7K2V",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_mQg1Ov5NZzPm0mVWJXdlY",
      "name" : "KfiitUpXuk",
      "email" : "lwJF9RlD@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5WfI1eOSYHwGQir1rTxbUq",
      "name" : "jw8OZn7him",
      "email" : "2VTz5s55@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:12.316027Z",
    "updated_at" : "2026-05-08T16:04:12.316027Z"
  },
  "animal" : {
    "id" : "aml_pQkMdNjY1DhS9flO9LKir",
    "study_id" : "sdy_6Vezj33RH9FJm3Bg3rmaic",
    "study_group_id" : "grp_Mr8NVpOqgyntJzQb9dRaU",
    "cage_id" : "cge_7Zjf47cSWvQmjUhgEQEOO5",
    "catalog" : "A0000001",
    "name" : "FpEE6Z09Rk",
    "number" : 1,
    "strain" : "Lk41aVKuHS",
    "species" : "Jd6Pb8FGkP",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "uKb91WlCEh",
    "ear" : "iS25t20cTf",
    "tag" : "YcUu6iH8Pi",
    "donor" : "4FyhwiRu1O",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_54MFhsUUhHxW93aKsWr5lz",
      "name" : "W4yT0CfGBJ",
      "email" : "eVkgbUkh@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_3NyONZMCbMyx8GlpaUhsEe",
      "title" : "Found dead",
      "comment" : "edBt9KZ5OA"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:04:12.459680Z",
    "updated_at" : "2026-05-08T16:04:12.459680Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_1hipPuPEWmuPAfYdFKUb0C",
    "name" : "VCC6F1ruCD",
    "email" : "FUUjaNST@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "Ynnc3vgaf2" : "RBKegEpEDi"
    },
    "created_at" : "2026-05-08T16:04:12.577865Z",
    "updated_at" : "2026-05-08T16:04:12.577865Z"
  },
  "created_at" : "2026-05-08T16:04:12.590558Z",
  "updated_at" : "2026-05-08T16:04:12.590558Z"
}

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

Parameter	Description
`animalId`	The unique identifier of the animal.

animalId

The unique identifier of the animal.

Query parameters

Parameter Description

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.

perPage

The number of samples to return per page.

page

The page of samples to return.

sort

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

order

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

metadata

Filter samples to return by metadata value

type

Filter samples to return based on sample type.

Request

GET /api/public/v1/animals/aml_5LCAzbZOhFDqd7tnSa5bL/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ODk2YjczMS04NzI0LTRkNzMtOWI4MS1lN2I0ZGUyNzRmNGIiLCJqdGkiOiI2YzhlNWRkMi1kZTA2LTRhYTctYmU1NC1kNWM1MjE2NjIzMTUiLCJpYXQiOjE3NzgyNTI2NTEsIm5iZiI6MTc3ODI1MjY1MSwiZXhwIjoxNzc4MzM5MDUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJUTURqMzk3RjliVlo5amJlTHUxaDUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.kRXepDt_uHaJH37yYLFdM6c9OG8gjFJKouwk-qiF_bEdDVnJdgfnqRS5cdz_XE19OZp4cOI4Abdl0aeREsq0qKBX3oL7FMWAcSUfW5aMwclwCtcpTIoQyhchRpMMSBaBQRIZqNAuI-JxF6-ZTEtH8rgZMZNv5SR0DUctfGEXjRWdtlEvsecgjgJe572M9AoeZ3WiyARMSTMEDF6_FFUMj9BRSxq-muQf6fyxuG5ynVIYNlVegtPimU-ivHAsDkg0N-qzq-eKSEIQks260hzHAs-WwMk_7zQFIkXsfWCgLz7foqw8sahWkE-QaS4WIwFZSuVIdqzm9X0hToYxyOiXUbbacGE1RRPOx-t-UOwkeBgIxFZ-82BSgD2ROaayDfy9HJro-occnMtOstZPBZ9F1NM3e-JAM0Y65j5g0l_tcr0rW3-NM5x6OyBprJA_ZDuR1oo8FNKJmINOWeQthW4nBV2hO_5ZQSgHez0ujDHVgmyepLhLB8bUi06tgucu8uU8bU4mw9csj-ePqzHQoxgmSxztgx4x5LjWn93LjGiHA-_D3kO8OBhTlR044QF__PC8u3ICKYbY8JSVYIaotyaBkO9i1u9kSJg9SfmWiOTknv9Uf5u08AStJIzxjorHjZA4wDU8mR4N-DivoOPTPXt7r5KtcjgtWPB9Ukw19isocYM
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: 3630

{
  "data" : [ {
    "id" : "spl_5nixHGgp6wHMltRcaCgIbe",
    "sample_id" : "S110976731",
    "sample_definition_id" : "sdf_aJt4PBX0nSvojE9R9uoFv",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:04:11.446210Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-2073720575" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_1j0YjHzdFBj2m3jlTbFmDo",
      "project_id" : "pjt_3Sh8ivx1gFJrCp26exRzuG",
      "name" : "yXDir7YMX6",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4NdZKD5xhFATLVl3tupoth",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "KBepu08hK3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7CkSGDm7gDiQrPEcrKPcfZ",
        "name" : "GRLAR88ZmN",
        "email" : "r2rUZhQt@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_3TusxMDKmzM6sEOI7GV1pc",
        "name" : "sE2lRIH75a",
        "email" : "oL4YPGmf@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:11.132532Z",
      "updated_at" : "2026-05-08T16:04:11.132532Z"
    },
    "animal" : {
      "id" : "aml_5LCAzbZOhFDqd7tnSa5bL",
      "study_id" : "sdy_1j0YjHzdFBj2m3jlTbFmDo",
      "study_group_id" : "grp_4yAdWGnjVLcxGkeNhI9s5",
      "cage_id" : "cge_24GSiOQjsV5V7gbFeJEF1C",
      "catalog" : "A0000001",
      "name" : "aphCruLbe8",
      "number" : 1,
      "strain" : "HVGpD7KuEL",
      "species" : "0900TC25jW",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "a8qDVENE6m",
      "ear" : "JtvKBXCP0v",
      "tag" : "EdBJkvSvxJ",
      "donor" : "1yk9s2Tcie",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_5cHYIcK3Lsfk61GUPKg99n",
        "name" : "AKPQB1d1mL",
        "email" : "eisMD2ec@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3CDVNTK8xxg5pFYqEKUvd3",
        "title" : "Found dead",
        "comment" : "nQOBKJFaq2"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:04:11.296261Z",
      "updated_at" : "2026-05-08T16:04:11.296261Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_6DUrZlxIdv4j4Usu004ok",
      "name" : "gwb9MfwXFU",
      "email" : "TAHoxar0@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "Z4AHFgLat2" : "IytpgQiNx6"
      },
      "created_at" : "2026-05-08T16:04:11.423812Z",
      "updated_at" : "2026-05-08T16:04:11.423812Z"
    },
    "created_at" : "2026-05-08T16:04:11.446263Z",
    "updated_at" : "2026-05-08T16:04:11.446263Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/animals/aml_5LCAzbZOhFDqd7tnSa5bL/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/animals/aml_5LCAzbZOhFDqd7tnSa5bL/samples?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/animals/aml_5LCAzbZOhFDqd7tnSa5bL/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Cage Resources

Cage

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

Attributes

Path Type Description

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.

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

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.

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.eyJhdWQiOiI2NmY1NWRhOS1iMTZkLTQ5NmMtOWZkMi01NjMwNDRlMjI3NGUiLCJqdGkiOiJjNDI1YTk3Ni1mNjU2LTQ1Y2MtODkwYi1hNDBhMjZlYjI2MWQiLCJpYXQiOjE3NzgyNTI2MDQsIm5iZiI6MTc3ODI1MjYwNCwiZXhwIjoxNzc4MzM5MDA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRqQXRmVmhxSUNVN3BSZUVnQ3BtODUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.ECvO141uEbOsBqwifZ0-quzqN_7U2p-eq518-kBjzWH9Jh4hIathScIiXS37KDR7N7yihnUxWeBuuLvSY9y1LXXKWqRKYe8UTpEb9Q5dSGuony3bnNj0M97kSgOG-fOG_8Tvt85MnLgutp9vyXtK-zRANSXt-QVBm3s2KKBMeT9c5q4VHVyVPqvixaB3jduv5EbuwbXjehc0uGBc4jgSYgOoV-mRcmpiooBDRJjgh632cd3iLWscP784yYOP7cKe-9yGGUaxNs0v3wCsbAbnpMWnodfQdUEjyNKPUmtnDUtkrij-ZwklvbBxFdshWSi5Si5naGUYfMG4S94HsGQKowYlJie_rOO7HY9hlFmOfP8_xhUk6ngGhOG_ncCagn7g2aMxR_mJyqkTbi9weUwoA1YE1GTGInXhy5pNJd2DEHJJczfk1crT05gRdEfGazNruwFX6l5LEq8nk5fUbcfWsiE5KjgMuQWRC1DQ5jmxjHnM762x8ZIyEDxUKcTwqW38PjCneq2mnw_6dp1ByUe2nsR6a-NnueQFDpxo44JB7TrRQwhvcOnaElOwG_Jnw0_L6HEDrYVuEzQSO_hiIqSVd_vq2sbgRC0dGuRo5UB6bLWLarQhzVPxlOR7uz4uqZzjvJ2LwLPr6t60d2mgQZJAYZxPuHp7lSbTVieO-p_Jpk4
Content-Length: 107
Host: localhost:8080

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

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

{
  "id" : "cge_7UaEKGhBZqArABf6tMc46d",
  "name" : "RGeEShvQfu",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : null,
  "created_at" : "2026-05-08T16:03:24.064560Z",
  "updated_at" : "2026-05-08T16:03:24.064560Z"
}

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

Parameter	Description
`cageId`	The unique identifier of the cage

cageId

The unique identifier of the cage

Request

GET /api/public/v1/cages/cge_5Y7HSAdPfxxnyYVXMSri5P HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjZjMwMjViNy0yZWViLTQxMmEtODA3MC00MzAzNTdkY2Q3ZjAiLCJqdGkiOiJjMzZhOWFiMS03YTQ3LTQ5YjEtOTc1MC1jNDliZDg1OTEzM2QiLCJpYXQiOjE3NzgyNTI2MDIsIm5iZiI6MTc3ODI1MjYwMiwiZXhwIjoxNzc4MzM5MDAyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdHcGZDUndwT1pSOElXM1lrMVlmcVkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.X7PMSBbtPjbC95dLLn-4zU1d5oGdfoZl4Gi6duqPsvtgFfsIPmbMHHwa0vRSoTQ_LJkE8IY75Qs5fco1OY4PRy7-P6lmQa1mfXcSDuz6tpa8uhcJkY2uEamXggVMNyhlT4n3TxQBlAlAz7EknY54EOD83o-nAomWxwQcHEDx2d_Z0iQf9HQALD9DOimKGcnpRWWE4ZpsZEN7seMnRag_9SwUSRN4cFBue_Lcz_wLs6PR6n5Q1D0-OdCezsN4DqZvb-g6a4ed_ypFqsFRzlhEdWM-7iBMTLH3vi0lttX-AIye_k0B9cN-6sovsN-QJywu2kQVFgjzf5pBTiex5552KNlkJtLRWc3JrzvQ2KwhWu20ngPuSaQJo8fOsxWT5FcM-YZymf2nN4SSI9yGIvtzbOvDiWhzfBQooGbwd56wtKcppUDzY0hUkwvVEU4b8hH1vhJZUCr1ThBv0tpTURQameXJsWee6USe401JZtuBhqIWjSrrTK7roVheVdFJGpxgcj3Z-GorJGe9Zo5-buplMuF45Gg0f0ud93DQy0mN5d5ax_-PuqFU654l8iggUWl2Oi01zWWrscNkwQfScWti7g4N1AdlRQm0oc1ZiYorNpHm8bBZcXe5JfkDsEt6BWRvmQGpIQQVMI_Rk-ix-4Qy8GGSGVHOCU7qtc-TDmvoYO8
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: 1166

{
  "id" : "cge_5Y7HSAdPfxxnyYVXMSri5P",
  "name" : "rSaqUhrb2z",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-1234"
  },
  "study" : {
    "id" : "sdy_4lK3gHE6oAI3nm0yIKtooN",
    "project_id" : "pjt_3RuUhLGCT2Os4nueIr6LBc",
    "name" : "0MFHcOR4Im",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3vG5H2LsDuQrCUfpVTBEJM",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "dNrWkaRp6B",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_O62NGymjdO2WPq1soibvb",
      "name" : "py3IZbcHp0",
      "email" : "EPAiUBtS@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5RHUASthZEPJ4DlyMD1i27",
      "name" : "BYJjk7ctsW",
      "email" : "ZTt4xRLF@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:22.330031Z",
    "updated_at" : "2026-05-08T16:03:22.330031Z"
  },
  "created_at" : "2026-05-08T16:03:22.478757Z",
  "updated_at" : "2026-05-08T16:03:22.478757Z"
}

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

Parameter	Description
`cageId`	The unique identifier of the cage.

cageId

The unique identifier of the cage.

Fields

Path Type Description

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.

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_5vZQvJu6MUeMK7aHzDKjUJ HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYzFlNDBlNS03NDBmLTRhMDUtYmQxNS0zZWYwYTgzODdjZjgiLCJqdGkiOiIxMmRhNWI3YS0wODlkLTQzOTMtODM0Zi0yNWIxNTE1ZWY4ZjgiLCJpYXQiOjE3NzgyNTI2MDQsIm5iZiI6MTc3ODI1MjYwNCwiZXhwIjoxNzc4MzM5MDA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZXREJZbXY5SDRsaWN3RmxTVklkcUMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.i4WIjOKd89soFc2X6iTXHNedeIZs_J91qcWlInFbzkFoEuitz9mhhuxJXp6Lp-QqwbgbwAJe5z3xd02W25LBPECr_ftUry2SoKEFcEj1QPhocvS_DayzzWGqjpawHSjgto-VkKYyMJHVzUzZVa4DEdrCKJfYc4aCY6Irt8r30yuyMdLtdcyBaYxiOuV-Y_wctOrrfVbvE1oXqMOTcc2wrgmqlUQ5fVzl82UrvpvGxObS_AG629xKfDWLNmY_rycEnCTL_7mHpJSBL1SdKwIMZ4umZ-6BUHiEhfMqYtVUZXHjZ6dQ8K16C6ObGp89QQEmf0vpW9-xp_9sSZNtTTh0ptPPfy7PReYJSiKHoxogrQu0ElFoXW_CYL6ynhaslzT_IiWSrqmDyuLDIddk1wAKdl-CZhUIEvvBA6Xh1WTEYq4QRebt-nkoPNaCiSWJtdTlcj8IwKnJKyLjKzy20i1Ju_vUQ-in2nEJnuI7c7qs6tXoeq7jhUQUosOCV8hFHG2fGHq1BKmdWbCLu5d1KFNvSPtVRadY_bp9N-hlV9yRcLmZYT_VlbXXVjE7tV4b1sd5M7gN0hU8skCtTeMiyO8O--PQz_Ry09nfISxQfODMuNcKSiNBFSZ2LhotZ8SPESDiZeFukRn7XhsjDvjRuWl264hLZ5rec8yz5t5OCeYAEjo
Content-Length: 143
Host: localhost:8080

{
  "study_id" : "sdy_3nZDyKni5qztseQleKVaPv",
  "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: 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: 1186

{
  "id" : "cge_5vZQvJu6MUeMK7aHzDKjUJ",
  "name" : "Benchling In Vivo Cage",
  "catalog" : "C0000001",
  "metadata" : {
    "cage-internal-id" : "CAGE-4321"
  },
  "study" : {
    "id" : "sdy_3nZDyKni5qztseQleKVaPv",
    "project_id" : "pjt_6qgCeKl2HHJHlqA5cIYnox",
    "name" : "2essbcFJ0g",
    "code" : "CD-26-446",
    "study_code_id" : "sdc_BOCIJ4sSaRKgPtvRIDjnc",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "qZIBtF1ucf",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "new-study-internal-id" : "NEW-STUDY-1234"
    },
    "author" : {
      "id" : "usr_3rA0zhJFbYCozQApPSH1uy",
      "name" : "jjxm9wmj7A",
      "email" : "jLXb1roD@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2X0A8hJnzs1Zi90FaDjjf5",
      "name" : "OgyYGCKOOH",
      "email" : "LcpMYSc5@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:24.775631Z",
    "updated_at" : "2026-05-08T16:03:24.775631Z"
  },
  "created_at" : "2026-05-08T16:03:21.921957Z",
  "updated_at" : "2026-05-08T16:03:24.948264Z"
}

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

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

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.eyJhdWQiOiIwMzg3Y2JjMi02MjA1LTQ0YzktYjcwYS04MWVjM2FkMWVlYTUiLCJqdGkiOiJiMDQ1MTgxZC1mODMwLTRhNzEtOTdiNi1kZmFmOTZkMzViNjAiLCJpYXQiOjE3NzgyNTI2MDMsIm5iZiI6MTc3ODI1MjYwMywiZXhwIjoxNzc4MzM5MDAzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJnSTY1Sk1WZEhCd1ZWZ2hHRDgzM0kiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.SegfXCNvTOsg_DDdWDs-2AQqsJIa_bfNmu_kGP8sfgCZ7TAmY9pQ8HSsrQO5pZaNyDFINFVXlHlhe30s7BJKz9MHH46dFKihxNVRXdekpkc05ez9xcIjn07TgwuHd-P_4ZIevRnKwVE1gFkxRqZSgLGngns3du0gK96v1Wx_bo_RqLABqn5Avvkx4LSFTXU1Q3TwNFjklZP3dJ9x3-kFN5loCccpPgoROD8sv98PZvinWmYDKRSpEnYKd9xoAUaI0ad8g12lm-NZTsl1mRqMcRB1rzRoQRLBUfBFh3eP4dFN-QzEtHE13mPgr9Mq_nQ1gdb3Vt4aL_niLxwo92Co6Pj9nphuK_cYGfNmBMqZvbqaJLnZgcAt-OgEO7jNi1bTmky5vrG39DYa19dYhkSYbt6wRCJeqzPflBsafKhPwdS9NCBLusdiqAVAjf1K6EyAl3yMMwrZlaEcDDW_5VKkZ5y-bhgK5xzW9sofH7EdmY9XEOvN8P9BwcExkPlTMjloKBJ7kXyUY9x3SB-QJlNDxWHiY4Gc_JwP9wU12NFNZI9qPzdbxWfd5ScELDzu84I0dxTOukZQAdm0VhG9-_2_9CwapPcmdFq0rQPe5b2VKtO_twv0i65-zL40NFyl38JTIaFmnpmvX5d5KJhMEYJk_pGfhwJdWUtx6-O7VOaHFm4
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: 1640

{
  "data" : [ {
    "id" : "cge_73ayXUsGoWuZjPw6oSoujw",
    "name" : "Q5wZlQJmJB",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_2FnH2UswfDRvpcx5bylTlz",
      "project_id" : "pjt_1uVjXWbj3ybuwrztn1g2Wl",
      "name" : "rJeTf8VdV0",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_rnQ6e5NDmu7b9QsaBZnuH",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "VLqDHqgcca",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_74IIKIKsBDH379mLJBtjXm",
        "name" : "lBOKU79khs",
        "email" : "B35QvFDX@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_46g8mXvwmnYRxqFjdN26w6",
        "name" : "4pP1vtdjSC",
        "email" : "fEnF5fk8@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:22.981225Z",
      "updated_at" : "2026-05-08T16:03:22.981225Z"
    },
    "created_at" : "2026-05-08T16:03:23.144966Z",
    "updated_at" : "2026-05-08T16:03:23.144966Z"
  } ],
  "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

Parameter	Description
`cageId`	The unique identifier of the cage.

cageId

The unique identifier of the cage.

Request

DELETE /api/public/v1/cages/cge_7WYNo5wTX3MMkSKm3ReiV9 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3N2JhODI1YS1lZjJhLTQzZjMtOWQzZS04ZmNiNTA1ZDkwMmMiLCJqdGkiOiI1YmMxNmY0YS1kNzJjLTRmMDAtODg5Zi04NWFlNDQ5YzMxYmUiLCJpYXQiOjE3NzgyNTI2MDQsIm5iZiI6MTc3ODI1MjYwNCwiZXhwIjoxNzc4MzM5MDA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZsNVU3c1ljcHZSa2U4VU1jVHRTTDYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.X0fc5OmxlKo4t1eGS5C5XrSluNBfHDac5Y7eIz8GSzbhn5wPSZwwOm1GfU7mz5WA4ndGuNRjWTFVTn-Moldo3iY5Lpxcoh1yIaCix_RzNF7ULN6ckstRlxmHMIEGKIQjgD9FkCg_SzUk3fgiElHtHY9W7zN8pgRjwH_SN5j7E_SIvp3xSCQb8jrLrGbUAWH7VpoMClEDlFc_8D2szIX6IWAO3h2L-1KIpFSQw99FvP3g1p6D4ZrywbR_xwxJr9uIu2FZfdwehUuCwFZ3VqmPtaTG5HaaX9EnPYQOYoLPL35V7QSZXY3yBy8CLBaVwhoGTcWBTCvu72wD4XRNKdU8eYC4CTniInikF7P3ZgYiAL3moe3u55a6wdlboBzjFdHVfYzPjaT7RpwRJPDZ1alsIERpOle40Lr1-xvJwEZKF7v9wE99SkwZzeMOS-8s_RPcogJBu3iC69xj9rqv7kgeRUIEeI_o4j-DJhlf4qIBHGWeF5jxhXEq5E7CiT-YQefJDQxFzgod_nLYWwVH6n9H3XgK2W-455GPGOPihsxa5xZsyq6kcC1nVXOp4wxZ6dpLAEoEmne5ucFWHvhbBTIfDITc8SnYzCwG0cba8QD1LIBbC6ZQKVEUorWmzIQ8fQRrp0cDM3cx4XwFlxuvPjknGx16VoJmnsIjpm9JwBc4Q1s
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: 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

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.

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

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.

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.eyJhdWQiOiI0Y2QwN2U4MS04ZTg2LTQ2ZWQtOThhZS1kNjFiNTNhMzMwOWMiLCJqdGkiOiJhNTE5ZjU2Ni1jNWUzLTQ0MzgtYjE1Yy1iYjk2ODdjODc5Y2EiLCJpYXQiOjE3NzgyNTI2MjQsIm5iZiI6MTc3ODI1MjYyNCwiZXhwIjoxNzc4MzM5MDI0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0Z4RDZVSFpTa1NVVGtzOEt6eVl0OSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.WTuQfBR-nlwHTqIEagWoFMemOpzsXYeDE-he6YB3RlbX8Vfz4b2wfROGwM9_HJ2dCH56Y2Eu92ku47JnUExHav1DvOE2231kas1RSMF56WNyraIQl_1mmVC7foajqxAr1eXCj9GVTXXQ6-ZhAOGtHDWXAVtPbyk4l52BnhMkXFWCrAUDsf1-kdPH3M0ircZouUY_XTrb-zfs1CQkB0_7TNs2F9Lwc-_ieAivx6tsNNbXK7CzIhvmFc-kXKw0R8uB5R0DPeQ3sD2y7EkT2pgq3V9ttN4898SiUaHMGdHd2pSQMxU2FHqh1UyD-1iZ_Xs8cu5gJLMbwBx8tIXuSmZyaAo3X7ABJCZ2BuCS_5EA3ps5a7hpxUKVYToI7QztV0Jzd9aMLyNZOEZLBEOfKeEA8esePdANOKaV2xqCpzZMbuhUycHzoHYcG8nSqSaC4VzwkJmd2ttkCxkmr31QugTB_sowJRysGtB9jSEEjyYvtsjkCvj48l8taUXn5O6w0oqqXcXeUVf81fJQnczzWK3dca0J0sWUFh5Wgh7p84goHMHyInUE1Jki-E9qVCeQjYtlclnG0CE4F2NmILDHdTi49XjOxtlTM5jw4lDlwmGqyZFLvJEceaLjQuh5CkxmrQomzSq028dQGW6DSL8ND7yqQvkr1ca1X3EyLntPBuJL2R4
Content-Length: 174
Host: localhost:8080

{
  "type" : "study",
  "title" : "TDrIvh3auB",
  "slug" : "Hc9kP70Mwg",
  "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: 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: 213

{
  "id" : "mgl_54LIBTynwKIlUuVZdFOVtH",
  "type" : "study",
  "title" : "TDrIvh3auB",
  "slug" : "hc9kp70mwg",
  "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

Parameter	Description
`metadataId`	The unique identifier of the metadata.

metadataId

The unique identifier of the metadata.

Fields

Path Type Description

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.

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_4eZhiA5zhqGldPjBJUPl0o HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkN2ZhODNiYS04MTVmLTQ0NzMtYTVmOC1kY2U2YzM5MmE1ZWEiLCJqdGkiOiJiOTA0ODJlZi01NmY5LTQ3MTktODFjMy0yMzViZWY2YWUzM2YiLCJpYXQiOjE3NzgyNTI2MjUsIm5iZiI6MTc3ODI1MjYyNSwiZXhwIjoxNzc4MzM5MDI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI4T0hYQjZ4YkFOREVuZlUxWE10cWQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.I_ImJAz09IPR4_9_pKgJcf4MvU6kLHzgjZFUlNdEKSucUdrZg6jsFkJ9RKAbftdX1RA_PvTaEni0yHRjjbB6zK0WAz3xs1b9enS9yzF9-c2Ir92gCGlEudVLTFIIe0ygvQ4lgjgqsk7nnFcfBi_tKzDjVw9zztWCwNLzeIdpI3Z5z-iqwoMH-v7fBo9S85R9WJHbwpsiEb2aPEqVujXRBa6G1LMz1JS7bzz5HRmel-S1kGNW7jfYn5au-mLXP-Hq4tqgibLqGgiZ-KO4sRDEdSeH3YBI7xxwP8Q-BKpMla8ayBkYYgAD_jCBrLQnT7CRqofX01wN6gFX91PZ5JUgLlTgVaMfNb2JS2KMdAzeHRo11F_LfeYkHWGuhwKxcOljA6fmSDnAnp1OXEYsmlOL87XwqtkzbKDoiwb-dyLoDpJcgyKfQb8ksOm36JGad4iLBWEPy-qo0tk_2xLlWBc6l-8JrVcP68WOJJp6q7TbBO2wveV8O7R_QYrXzaT8RAukILZdLbrmBV5MKTgVAOv0nfAFHTSbmGkIsd7Jwi6ZCtpYzm4HrIgeJFz6yiczDJFtv255ETPQK7c9Q7cBlQFMCbIX4JAn3l571wAmd_YrZfCTWx0kCtK_UNu6cDrVgf78VJRz08mMP8mOsnqaqwVe18HaY38ANYK-nXzz3FRfqO8
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: 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: 236

{
  "id" : "mgl_4eZhiA5zhqGldPjBJUPl0o",
  "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

Parameter	Description
`metadataId`	The unique identifier of the metadata.

metadataId

The unique identifier of the metadata.

Request

GET /api/public/v1/metadata/mgl_6k9D3ZBXWJol0A0IB5fg4a HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmYzNlMWZlOC1kMGUxLTQ2ZDItODYzNC1hYzhiNzY1MTliMjciLCJqdGkiOiJjNjBlNzNhOC0wNTEwLTQ0MWMtOTJhZS0wODAyZGViYmI0NzgiLCJpYXQiOjE3NzgyNTI2MjMsIm5iZiI6MTc3ODI1MjYyMywiZXhwIjoxNzc4MzM5MDIzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF0SkJrdDJyTWRUNHVtbnFCeDNYbFUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.PqakbI10Zi1xv8RL9Mf88txAk2S25Gu-UMdG5gK6xDx16LR72s1iuRmt_mV6xQclM-SM89O5rno-3wjD1hLuk7nWVD_i5ff48KQ_jqQ9KSAYDqdI9ZTlP1pt-2OAgwr7E7-qICSpupHqJS_u2hSJmJqPeKSNWP2pR4KtFYP3FrsVGiDNrMo0x8JH1Xtx_2JLVjoPrpSIiFL-tIzC4vbyK0-wFf01S9qudVCm_9kQl0zhGmBv6J82A138kQhB2KJc2qzO7TUtmpLbYatU48Hn1dPXhsA9h38QC-2PMHv9mMWU1b4AeDCZ9SYxI6TK7ImZGiOiTsBIpmpLkSlo-cR3g-f2ELJ1PSSnDrJ18vsZY05Pa3bvOKB4ZUUmdM4veKsc-S_gpCuby4tO7z19LdeRSN1bTVjsoG3dKAwK1IpjOAefVnKVDACqsfpJ-9xAlpfgV9vpZDOK2a9Hpif_FWDhafo3GEFra4eLou5W5sPggZSKAfYHwAWCCaJRHXFLhby7k_eqx7EhFgdCMRAdr-vvkb8McqjoullVDR37VNTKfH9wx1aK3gjay1-wnI4eLQzbBVYVilvLdz_brh6gM2w_aaSiVe3Ut9n0ZR4Sdg0NtkqiEMbotm6x-qoZuVuB445lP6gcuAtt_J9gvKhEfdJQksF4DVC6ofVFm0mq8Yrzpb0
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: 232

{
  "id" : "mgl_6k9D3ZBXWJol0A0IB5fg4a",
  "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

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

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.eyJhdWQiOiJiMDEwY2NmZS02MDk3LTQxZTEtOGNjMS0yNDU2YWEwYWRlNGQiLCJqdGkiOiI2Mjg4ZmE1NC03Y2NiLTRhMmUtOGUxNC1lODU3N2M0YjM3NDciLCJpYXQiOjE3NzgyNTI2MjMsIm5iZiI6MTc3ODI1MjYyMywiZXhwIjoxNzc4MzM5MDIzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVYRkVGcE56bWVzQm1CWlQ3djlwSlMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.go-a5KpGBWBWyyGKj5HCNQaZIrId0ayRbbVWNHzsFmBPzwtckM5pq_X3GgZuqkmaABnpJ8uaRZ6V9DrPhbk0Gj3tGMSv6yVJta1cDpw1h0eZcKf9kaA4IGwKFND1Je9f_zRbIDLYz5RSAFsDk2mk5b0p9yw7kEDL8jpa3Q3eoParzg4ospnHbxzF9s2NAvp-uBIrbJDGSOeQPXkGSlfeS56tTGUc9AyoxBlaZaJLGoSYJzRg_M3eZWVB5By6PhIwcyKOwDWKY6EmOjXBmCB77GR0HLoZuq2gx-K5cYAnjViw3QuPEQYLq2Qfuq5yQyqvQ7qfKNghgofPWk_IjqWMbjaL6swS5pR7UWJfmq3Wsfp7FOacOq3RiZa0Ba6Pe4rfY8eI_6lz0K65miHS8gWi15ClZkatszuAXdkMC58GUAfqhdsx1Dw7w5FAzHKtNcz16wCQCu01J8sP3z-052-o4KHX5LlXEMpZ1Npt_b5aCO3TPvfCQuZfLql4wLoL25u5zo8SIpr-Iqvvx28JcmpH6-z0GF1us7QuDP86su55j045Kb9R_aa2ybwbeSkpdlzjIQxVlQ8hLGYJUM2I0nV6EzhWjl4Ladi2xJa1GjcHcv17FWy0RllGfSmylNwG_h9eR8ZOGbeZY6NmaKYJ4FUny_PNMOVD6FtMWo0HWCtIdFw
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: 653

{
  "data" : [ {
    "id" : "mgl_7l8DleL3HgklPPkVu4KAyr",
    "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

Parameter	Description
`metadataId`	The unique identifier of the metadata.

metadataId

The unique identifier of the metadata.

Request

DELETE /api/public/v1/metadata/mgl_74ltHxnsBe7oviezfeQAQy HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMDg3MjI1ZC03NTk2LTQ1ZGUtODJlNS0xM2VhMjY3ZjhmODMiLCJqdGkiOiI0MjM5OTRlYS0zYTQ5LTQwZTctODIwNi00ZmRiZDM0OGVlNjciLCJpYXQiOjE3NzgyNTI2MjQsIm5iZiI6MTc3ODI1MjYyNCwiZXhwIjoxNzc4MzM5MDI0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzEwNzlFdHpMSnI2c295Tk5JcEdGV2EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.G-xShZM6BaxU2yQFcVCzuRZ879rYOUeJxGmgHzsbNyDHop5_68J2k15wygnTGXeTGgIwwP5pPvxEWiNDzxbxD7FPjWuijlEOPuO3Bes471KqXQZXI6Uqx-ghhkZhDA8wBqoHlcsGifCs0lQCWcpaptq0piWodXM72IGez9SH7Jg0ZgUz92TzmGAGYykFNlMGvM2tOlL1sxvXjgS2UUFTaRMOooWWnmdd5_-iHiA-DgEn8lLHZgCMZMMqKOrojhVNGD6B6LUk_zZkkSxvSS5uhFuDR3A9tqHI1Dvu3LxtEB3VAz8PENrSg0ZYNiapAcVbQ3stLuwf78EM_ukJ1haOUD2OyfcTvJJM_zCgjmGN3OOcFqdkrsrfbaG6vC_VVPgyjWKjZt2SYsPlUIDeld94Je-V0vR1QkXNlg6DDjLSG2Y2BN-XB5HozYjFN23AEtK5r1TnzNN1lUyhXJTc5X3kEkAbgweySuMDa19hcvjampumR1rgaQOXRy6w3vRk20yRc4KySfJ-ApFOhCb8OyI-38dBqE-MXIx9t1p039nNmi9rpTKa4KybrvRW8mzsiYAopzJwzwIDn7S2PCWrFvzSCHIfB-h-mlhhyxGQE0B2JhoAw25eoByixWUaHBUu0r7qQriQnWG4OivnqlCSAXkLwH94gG1FDV9posUlxaXXOYo
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: 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_3TFAEz5J8Jf5tVkKDsDJZ6/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwMzQzNDEwYy1jNjdhLTQ1YTItYTBiZi0xNDdiMzU2MzQyMzQiLCJqdGkiOiJmOTIyYjllMi1hZWNmLTQ3Y2ItYmNiOC04NWYzNTNkZWU3ZjMiLCJpYXQiOjE3NzgyNTI2MjUsIm5iZiI6MTc3ODI1MjYyNSwiZXhwIjoxNzc4MzM5MDI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzUzdVhheUhyMzAwcUFpbTNiZmg0WWciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.L9VxFUJ7Vp9DDN9mspzfqkmC2gS5irXGBNcj9vXt6UA6UOs7DOBrX3HaASL03BnkFKElpDSb1f8OuoHI_-tlp06sce6Ponu_OTgWDyVOSgklxvlUrmWaDAAjiNPqVg0Gw2-pVK2KupCrcFiZMV4FTxffcN6eVCXqUhj3mhUv2QYvfzQ6l5Z5CbqF5lD5TluawINSn3Q0OYPjDdYCaGhIZXHOmcuiZ7oCxOptUZ0Vpcr-rGzFvOPuxoQUoDC3cCPIqXrPEyNz67HKYo9LBbrWIuKSMbrbXmwZ-7KUmQ5OnMGCYi7mb4A_jkFJuLvT03vLWmhzIzRAgZircYNUU-YcE-UcVvnSxt5oK7HPk1KCFWr3b1cFzqIDx7WPk93i5ZOZbCvBA6yo9sWDupwlsu7SlY7m44292gpCzYFEOR2Ulf0cxrj3kLgcWMUDlxEe-0l1eBUK75h46RendL-YSK-ybrCdXvTE1WaPZmycYkoNRd9RT2uBKk2Jke1MC5TjO1s3LfTIwTAcH-SmZHCn_RDg68yB7mjs0s28yqMJG0o7Nsu7kDiG68MQPdlE0hwW8dEEUUpkfe1aKtGEBsCihMb5dy7syaylqSBGEYKIRjlxw7vtcmsaVIPelVxTma7IQYihhM2ExGD0-Htxf49EgdtPkJch--ZxVZ8TA79vy2nHsb0
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: 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

{
  "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_4gtYHcE2EKcSDV8dPTAYpu/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTE1YmE0ZS1mZWRiLTQ4MDYtYTRmMS01MmUwYjBhNzUyMWYiLCJqdGkiOiI3ZjkxNjk3OC1kZWMxLTQ1OTctOWZjMy0wMjRmNGQ0MDkxMDQiLCJpYXQiOjE3NzgyNTI2MjYsIm5iZiI6MTc3ODI1MjYyNiwiZXhwIjoxNzc4MzM5MDI2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNiN3B3SkFicjJ5Rk1PYmwxSWFMMlYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.mCo4ILYFQuOJ70wSdZCq_2SPXkJNmxVKG0C_iTiwxuzgHxvbbLEYWwVnm1i6PBBKJeatzm-Htl3t859JpQQCGQ2C435lNkTwOfEd5_HTEay5qFcHWQUi-kHzrQuKcqtcRoQq3gGajPu2AEkQBrowqBkktxqmq6dY4AySZY3tAPJ3Gs3N87v7ghZk_OcQGAo3teQ7iZb73y4wPGzdcvQBx4Ny1DB9YR1VP0j9WJjpKyCNy9Er7aewGSUeTnK9dOYaT05me64IN8gYjH0qTUfyhcdYXUz8lFAssXyo_m573wc1HZJIFppgt-oZA2ZIK5W4TiBTFWHqPuxKYnuwwuHf6IlDbPtGXJ-lPzUZfI-pEgL49gDIUJlOmqqhJyIjxV_dPv30Ob1sD2wfTlNZ1p6WkVB01B7_THiTNdoAm8GbgRM2U9mWI7AWiD1te2Twar61uH80jLw8m5XCBoSaTRrRJ-Mzgw3Uz9R_ieyF6SlxGd0MUcJ0U3opkkiIYlnmn1ve36CKtFya-SnApIBq7d24EMKBEI7Csgo6KPFevLT_39VR1Tm5Z2vaCI59bHa7A1Os-vI74Hq4ZLI6d94zeD_2SfamgF-KeUqhGuyQmTEmQJ8rIkfFAkag5LhuApM_pYUWIO6FOsbXsuU-r4a4rGR3j6K_Rmxc9mTbyJ8Pta784d0
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: 14
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22

{
  "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_5G3WjxQwzPD0wconFVuk7V/options HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3M2QwYWJjNi04YjU3LTRmOGUtYWRhNi04MDIyMWUyMDIxYzciLCJqdGkiOiI5YWIzN2IyNS00MzVmLTQ2MmEtYjU5OS04ZGVhMGYyYWExYTciLCJpYXQiOjE3NzgyNTI2MjcsIm5iZiI6MTc3ODI1MjYyNywiZXhwIjoxNzc4MzM5MDI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1ZjUzdQUEpLUTl2MWdsRVFmOThvUCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.oBSl2xl0IILpkjc6eGOKIz9wwG31T3Mv5bsxHdtXLejHZ8FCGmNsdcvWskHV11zF5NF_SSIZY-9JiLGJveLcKWE7F863Kg9O0Km_TOApR7ypT6QYPAs3gzJm1tqnGFFsbz0O5khfSm6hAvcVQWF40HKTCESoKfRdghT_5GvKctZNrBNoGrRSnHNGIG_hjWE-Hwuyvo54AD2xknlYZWA8V7eIUNux5GFk40XPAIT0ThtMSBJta1IZ24WDY4UwXz70QNw4DFnic1tAqMJFemFLV4oWFRSSRIiqOwzpXRdIQLN7lbU7MByFEWU9FwuADGY_s4gafp_x80dgW9WzgHVPdmMe_VjQ3Yz9vrHdx6EAnDWoBDi7gZmyD2eKfhs55Mg98QS_NSZC9haP6oY6WyKWBh4o0KoRi8AwhTU-Tq8GLa9Fm2uUw6YeYIfRtHgwMJDh5JYiyZgC7A8qVByxfQ94DaLIk7nfGzq40SPAfFQuLACqihI_lyEyQ6hUCrkE6zWLOQQCxWqT0soqW1lg0FpwErQmTzIdNxEt3MXqwfDMBUx32w0Wt07BIeog6THQv9xGAjEBI0IDefCMNiTeimNDFiqahNkXTzKipasQXI65v7vVrnaJ6-q017CKQxmVygvsBXaZj78oR0pUqePxNHSoG4KjfhhlsOy6pAZj-pVQFgE
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: 605

{
  "data" : [ {
    "value" : "B6129SF2/J"
  }, {
    "value" : "B6C3F1/J"
  }, {
    "value" : "B6CBAF1/J"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/metadata/mgl_5G3WjxQwzPD0wconFVuk7V/options?page=1",
    "last" : "http://localhost:8080/api/public/v1/metadata/mgl_5G3WjxQwzPD0wconFVuk7V/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_5G3WjxQwzPD0wconFVuk7V/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_2GKQZcQFk9BaJzWit8OJ2F/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwMWZiYTE2MC0yNDMzLTRkOWEtOGNjNy1lOTQyMDMwM2E3OGEiLCJqdGkiOiIxYmJmYzg4NS1iMjRlLTQxZjQtODczNi0xYjIwOTQyNTA0NTMiLCJpYXQiOjE3NzgyNTI2MjUsIm5iZiI6MTc3ODI1MjYyNSwiZXhwIjoxNzc4MzM5MDI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzF6VDNtdFNDa1JtdjNFMmlGTk9uUnUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.QdzXIHMG8q5y307cyEDorBYAERLv1PMRBJs6j8ZaOdZbJPXK9Yb0EpiYgn1iXHRdEDi5Ty6i2iXbig8oZm8dQ4B3fvVkpX-iKzJ26cg35JkGr2pko-wFTQfIdN8yx1EkyGbM30-uHe54W_bvFWGndT5bwQqwexKugp-qc2TJDVIt9w7irQBIa_mYk7_L5TGFlb3uSSpCqSIMj9qHpsWUQgbG3HqSXz1dMcvhbJeGCjWhaugOlI99qkGqSvuKm5nHX-2kz4kZFMP8qqgs7Bn_qlHC8dRfyNsDPnZpttmj7jzlGaDJGsClVLzmB5zflpHoDe6ID5vsl4Zzu1_4Bw_scRYoBX9rYlb2QeciSxIs0dY6_IYZzE7sqLPg6FX2f5d9SJtyvwEk3-VV5xzMOsP1ToOCj_yu3n_ZJKMbke0UPolR7O5ySVqCpai2OHnQTQlMZ3sXB08kh7n8d0_YChSYJkxbjz6PrtAZCrpXaYdjgkISiNc9SIOP3ZDWWIAw9B5Q1tSjSnT-vJRgbLo99tOn-Y5q_XJh-eDQ2-Z9S0dofYnjCerH2o2q_-pWj7pHKFWzgdaZUuN2Ev3ZxMtIAhp9pvQZ4s_qKvMGsk3cvaoxZRqJR7YIKeEP10gxIlto7RtMRUx0Y3Q02DLkj3gIItSULPu0r3oIqgyyQH0iUDvsSGQ
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: 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
}

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.eyJhdWQiOiI5MTEyODdkZC01YWEzLTQyYzAtODVjYS02NzVhZGQxNWQ2NDUiLCJqdGkiOiI2NmVhNDYzYy02MWU4LTQ3MTktOWFjOS1lNjJmYTFkNmY4NWIiLCJpYXQiOjE3NzgyNTI3MDYsIm5iZiI6MTc3ODI1MjcwNiwiZXhwIjoxNzc4MzM5MTA2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJhb0R5RXlqeWxTQ2U2QnF4bWNvTGIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.DEuZOrydc_S_0izLEdhrX-BPVlsMC-tuMKypSw3plYIfLPNOHBy0VQGIv3d4dGJ--AEFjm7lAT0NNXpQ5GHvrEdJkRSOQt7inGR0moei1YfgS-gLpkQzW7NloKCoQW7rR92gdL-_7IlgyNvb5MT6EB9smBMSjcfac8oHukYAV213aqKAfFjMxbHesiEIgmZ1Onx1N_UrA1gmxPEDZ-tyRHi9Te8Fry4updHy2gHIgcdAkMU8a-ezZCcYzDhn6d8BGN3TD2SFET1NMs__PVe0pSrpdam6TTtjBdUyfaGzARfDbKn4EVk7CELS_R7EsfudgZ9e95o5LMwYxhiPl2yYRuhaSRPCwcba8goTfvFcuL1HPInVVGNxTk7njVhjEDvhgXyfPKdDMUTCrSfjS1X5zUe-MK_mD7_VJs8U3siDznV7bQGMofFbw61RfAq8UxTpTf84H_6gmNsEJzwT7Gc6gbx2vMAnHeqRdOSV_zCiJkn_6K4gMBOrQTr2zslW1j1SQVALujZpPNRaY_3jjqsUgfOhiCN0UrUGiJ8pABWKKewXr1e5LzWP8esHVL1PrytNtKOyEeQgiwEMj1YFA28aJiE1EdLGJCrR5xoR-27q8TnkGDt7XfdO39cjabOrgo063QNVlUNHjQBnWhAbQOeXtSO9kl-NMkF5CKjpJju9nWk
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: 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: 696

{
  "data" : [ {
    "id" : "tgy_2aNM98ceGUAOLk5aYFoCx6",
    "title" : "Body Weight Change",
    "label" : "BWC",
    "description" : "Percentage body weight change from baseline",
    "status" : "active",
    "type" : "numeric",
    "numeric" : {
      "min" : "0",
      "max" : "100"
    }
  }, {
    "id" : "tgy_7kMYKIgaf73VuEosJjuq2S",
    "title" : "Coat Condition",
    "label" : "COAT",
    "description" : "Fur quality assessment",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_4WAbUQNX1vFKuwnjunxog0",
    "title" : "General Appearance",
    "label" : "GA",
    "description" : "Overall visual 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_3LSmeaqOzbqi6PanDruTzH HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3Y2EyMmFlZS04ZDZlLTQxZDAtOGVjZi1mZDI5YjhlZGUxZTUiLCJqdGkiOiIyNGRmMDJkMS0yMGVmLTRlNzAtYjZjYS02NDUzNjJlM2U0YjQiLCJpYXQiOjE3NzgyNTI3MDUsIm5iZiI6MTc3ODI1MjcwNSwiZXhwIjoxNzc4MzM5MTA1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdNVEFpRFc4OFRrbkpwTEFXYTF4TU0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.kZs5XvHAEOJKkDytjA4ICsCa-2sFqtzKoYlASs72mcoF3WC51mvT-grEIsMp7Qy1QHxLvoEDQ1VqYhUQi9HagXa1WQoFCjhIpFEmSTuvoMGVCA6V45IQXh2VF1QbrPpO5gKULEOBXjCPo8mfXBc6n49whDJ6lsPX0Fe8Y2f9wT7V4E5IDG0Nn3sA47nJlebK6ZGUtDFQw4vLICHqV1vemLqLB82jcXhWoRgzp4V8bjoY4CfAPodAsBHW3zVpJfqWXuhTYuXeygtf6zrH8Jfkqd2VqJmcSvBkkQOHUZHnrhNJSQLt5Hzw1Fbbxnv5WfV10YRouzOIWfNpXEajXc7-ovG20qzUCKRvKtFQ8MXHPQaFpt6WihqhS9QAaiZbMDx8Qgzt_Sm56RVRpsE4ZD3p3uigt86UC0QVyFNDhbhCggsNl75Y01fcuCVduzwIGlKxDwgMu8En-T-HI30Uv8-wGu9r7dsfUGgBW32GzmHDY91aqKZrJnOUyJUY_zqCA4cZjJKfRHVvc2dOV51wGDqgwFwpQsvwddrhmHCX9ZGJL0cqnRFz4VxwKu4H4fv17igXsKm5rnAFv_nmJg7EnYHxcsKNz2pMxyzutuFCcc4hJJEBTCPc6TcAiloYnvGyZWs5xtvMuUkQaNWH_XgW8T2lcYjXt-3bpDbJEPIb9MOJbz4
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: 225

{
  "id" : "tgy_3LSmeaqOzbqi6PanDruTzH",
  "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.eyJhdWQiOiIxNTNjZDdmOS04NTgzLTRhNzktYjFlYy03MTQwYzY0NmJhMzciLCJqdGkiOiJhZjI3NzgxNC0zM2E4LTRhNWEtYjA5OC0wOTk4M2NlNDY5NDciLCJpYXQiOjE3NzgyNTI3MDYsIm5iZiI6MTc3ODI1MjcwNiwiZXhwIjoxNzc4MzM5MTA2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFLMVRMSW52bGVSU2RoUDd5NnVUTjUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.lE7HyBzDj6ulUuMRabQk5UzQJKU4PQnBvt0jcA5ucCWh179dyEEHQ254SwnI8wN0CBkTeavEWgG9g-LzfjrlgkJvytnPM_K4kUT5h85HIhB2Ih0Cx-17nkQPKYMGuOHbMQdxBqb_fFMh_9UAOp_g3-KHSr-EPog2UT-4uC4-c7X7hw5PVmA18DIwkAQb9AR3cVXSwaXHdu1Roh6bXYh8Jiv2azKoDqBhlDxK5N65iq4fVApV1-s3P2VIgiKCDTK_lyuiuV0GOhXsqY_Le6KUmDokcvIZAb5rxhZlQl1qJVXMAw7as--SVV_Y8zzvu-u3KKZAf0U6whRYPkYvB4vGwlZoNnZEgjwdJfxhp560p0SkW0hDsNIMtVurtLSQKkruriUc8bQKVrUBJ0AeFXTxjcCRHzxw1309DOTCDCaVRV7bodQAhy-S8JJEz8_qgUiKxIYsLjkT4r62uASlKtspE8aGuN3ObU8bhq2LBAJVC18fK9RBNO8emrhKjGnmT9qsb40zCuFpJ7NRaZaGMkF9uCTDHgnhYUW0gRw6wVzx9A5yzZ38JwoAtcebe8yzKBd0GLlzu9rAXmt75AP4NOrwTWrdNevtSWFtz1YbCvRlvP0gPYJaSaUU6aV5eQh8BXFn4-zF7NjJt17pt5xuhzeJL_DSSqCbEBc5sQP1O1aaLHE
Host: localhost:8080

Response

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

{
  "data" : [ {
    "id" : "tgy_4LaCQmVz9w1ceRH03LYB9B",
    "title" : "Coat condition",
    "label" : "COAT",
    "description" : "Assessment of fur quality and grooming",
    "status" : "active",
    "type" : "severity"
  }, {
    "id" : "tgy_72et1tbfE0q3n88yNQiA0G",
    "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.eyJhdWQiOiI5MDVkNjJjZS1iMWM0LTQ4YjgtYTlmNy0xZGZlM2FmM2FmYjEiLCJqdGkiOiI4OTFlODE1NS03YjdiLTQyMzktODg0NC05YTBkYmZkYTk2MmUiLCJpYXQiOjE3NzgyNTI2MzYsIm5iZiI6MTc3ODI1MjYzNiwiZXhwIjoxNzc4MzM5MDM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzM4RExrN0t6bkZoZEtuMlN3NFZjSGYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.mKSnQvO0aSP-XpuQ8j3DhacSX898Ns6AZa23Rf0BluWZwbV5cdhyT6WkMCG1xF1b_nDI7XYnCdL3h1Drrz3Tw_cmj_jFEx_6saTjQUjUjfCEDxICduCsbCcqD5T5270D0v-pkO3kdoGGk_FYOpOvj-b-PwGm_K6WuAF8fWtCr_u6Z63mNpIFK2JNGbo_cQUO85zjD83ypQUwoDo4GxUWe184A8pe_mjxXRUfkytMqhQwj0ox3deM2qNxGHR6YLjLWUt8tjj3_dsNc0xQN3mX2dZHQVm02aOpnGnyTMnQZOONKJJ9ZrXI4RBTj5uznJQ7rj0zYH-Pg9M-q84Fg-4eBxMQ6yUbIlWmUuki8ZfCJ792F03KaMhydfHiIAwoiv2BYugKC7fF-ihDb359BvdiRPq2nGZPFEEXo-fNqYHTIoJZXbyzQaKbWkVe-a16WNys9NyoK20elF4uhj3Du--_R2idLsr4Xm5Rmx3FtNDSVi3lF1OdFh4IlPyekpQbHLTkbPzbrurO5hb7S2r-w1sKRbA9HDSDWywB8yNYkufma3V3y4P0r-_e8kIMQMK44NAnodMh2VjACQkYq5ADanLWLDI29C9Y5v4tKJ0xdjVUXDBiwGMGo5i1zA_QFUgA_RXRD0G6mFuehiKqYh6ZxAWojUZ49bj4ZJhEyzqdVUDUMro
Content-Length: 89
Host: localhost:8080

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

Response

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

{
  "id" : "pjt_27YO8YtkN5mUK7vGa8u5tc",
  "name" : "2GoLJAnv6e",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-05-08T16:03:56.222587Z",
  "updated_at" : "2026-05-08T16:03:56.222587Z"
}

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_2hEJsy760Dq1QXIuz4oklf HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkNTEyZWQ4Mi05M2NmLTQ4YTMtYmQ1Mi1jYzI3Mjc2YzkyMTEiLCJqdGkiOiI4NGUwNjE5NC00NTU2LTRlNWItYjc4ZS0xYWI0ZDFkY2M3ODciLCJpYXQiOjE3NzgyNTI2MzYsIm5iZiI6MTc3ODI1MjYzNiwiZXhwIjoxNzc4MzM5MDM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVhb05pWllKZktTSEpqaXo5dmxheUYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Hi16uXoBeFcQ53l_BhmuB3JjHTJpghDRUxEG1Ad58yAy1iSt8a8S2wqyJJiyAIzF3x9WoI_AlhOIrb0ufgWNPJRdI6IB6B8e1Mmcte4ZrmL629G4iP9SZ_ljXYZoao4pT_pvB9WK-Nb0OEvmON3XUTwY0LqI7jCb72LRjn2QtRNHSzqAyUWrbxTWUD-0QGJ-LNRloWEEs8prAWwohuouaNotW5_Zzs7lTe_fWUjOJ-OkIwrieGFuc88EZjVhWiW3cqcUGFpzWG8Rx7mXv2Ux-8bt_R63rruhLa68wEDjDNUvE6111OtQzBtFun0Wx8Br-ih8sXC4SEi3Ia-nx5huyLFfoiKHGD2zOKwEtC6ji8ke7Z3nnrPv4mCRfyQEOYPwpFfU5WXvRnnHfkaDoJ0ZaJn8WqyWkejNT4zxIJzEBUBRCz--797-7LhkmCkki5DOZKb86PSnInU9D2DvryQdUSDUmYDqaFDoQAwsk8znXnZcXmrx8f8DiKg0gjDWrK7XGFOnYiakKWImr10VkDxdmxu_D2Mq_w5CRtl2m0qy8FE7Gc585eGnpHMR21AMRMHkCZK9ucQV4NpbGIr0_Fso04EyoSbDj027gBqCFPApAMnrgqtga5ye2P4mH8I4GMYIo1VroNFFKuzPQUYLs2PPoiZyZtCZpLqJLpU6-cUXWI0
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: 224

{
  "id" : "pjt_2hEJsy760Dq1QXIuz4oklf",
  "name" : "Y9WZNGYWaz",
  "metadata" : {
    "project-internal-id" : "PROJ-1234"
  },
  "created_at" : "2026-05-08T16:03:56.117110Z",
  "updated_at" : "2026-05-08T16:03:56.117110Z"
}

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_MpION10LVqUPLdBnlZPp HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ODQ3ZDRmZS05NzRkLTQ5OWItYTZlZC1iYjQwYzE4MzMxMWYiLCJqdGkiOiI1MWQ3ODNmMS1lYmJkLTQ3NmQtOTVkMS0xYzJiZTA5ZjYzODIiLCJpYXQiOjE3NzgyNTI2MzYsIm5iZiI6MTc3ODI1MjYzNiwiZXhwIjoxNzc4MzM5MDM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3FwUGZhenZhSXp3RGJUN3VoS2NDWiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.nwmXygABe_qTsuIRYJ2JK09EkMUh9wz4Oc2ezBpS0eLHAHa6vyGtLoPenkKr36RFHk-FLDzJqy5YP-hW-3xJwhyFmIYQ4TqcYDiRKV8vMZynTmHnhOsSj0agpZ4kwDNVgQ3Yg2rMi9o3_vTZh7AUsW_-jVpDI8h5xh4cEfKVM4JJF5ucMaQasRra0QOCYV-35ay6JS9NEyR_D-UTAPej9g_ZpX2ZY34c6NotVAqKopLp_dy8ls_P7MNONWLBLiD_aictt0_IX_q-idAxTYmkXNoE9m1rgs0sL5aE6FxspIlRsFl8nlWADd2_AoVjizqHgybD9qKqxuqubTW4PZuw6TidXQ57svaxXfMjgr7EpGYkADsAElgpeXI9TlyA3c3sd-pHV-I85M0-NdtdIgJSYFU805j8ACbYEOJq9um4-1CJpvyyCPEv419jHjLxIt2STyVDmzIB_shlMpZ8hBoMy-Z6GTjgawaTdjW7BeGGotGt95m5x6Svbw3d7h1zoOPS0UcUrYSz3RtNxavqsoEoWaJE3ulCKhN-mw_SbwSsVDB1GS8ECjsxYX1d47QSvj7nJVnCfjjqREJjpIj8-2TXCtB9FTWITWtkUv3B7rwxete88zyhgLVONsnt5S2OAQ_lvhTOvE3wHb76wZStvkXd5dN1-fhCQaunxAKLWnYMLOU
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: 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: 237

{
  "id" : "pjt_MpION10LVqUPLdBnlZPp",
  "name" : "Benchling In Vivo Project",
  "metadata" : {
    "project-internal-id" : "PROJ-4321"
  },
  "created_at" : "2026-05-08T16:03:53.296198Z",
  "updated_at" : "2026-05-08T16:03:56.320321Z"
}

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.eyJhdWQiOiJjN2Q1OGI3MC03YWFlLTQzMmYtOWJlNy1hOGUyNzg5NWNjMTciLCJqdGkiOiI2YTBkYmM5Ni0wYzUxLTQ2MmMtOGFjMS1kZjI5MjNhNzMwM2QiLCJpYXQiOjE3NzgyNTI2MzUsIm5iZiI6MTc3ODI1MjYzNSwiZXhwIjoxNzc4MzM5MDM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZZZEJCVVBFYk9DMDBZdmxjTDZFdGciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.lYXMQtg4FhdFtMtPLblmuMKKNYg-m5g5bN1lUT4-GE0b3t88q5Z_lLdMvygv5bAT45ViQ-_hxTydtoFkrXM0P_hrUeoQ-4NYNH7Nv5K5EPhz1CqGq5uf2fWT08JLFXLE4HN8j8ugqYBkTmQ4FHIZ5n__LtPyv42_T3uoXI1Q3gw7AEXNBOcAFfoL35OPF637ktWe0EBRXtVlGHhTDfHTUc7rY6aX4438PNvT8f2-mApljo03_AkXe628gbmbwFWlTQF5J1-VS9sYdYl_qYoeS95wnw1TgpN46aJEfCkve5BxwO6fawThZv-NdDrnVets_I2FBI8Z3hJE8cAKxuwklIszlStdAut1XkjpcrpzPbrf7JQ14dTaZF-I_ZA3Qzldt8epEFfdkdGIkj4gm1Uq-k-_nNAnudH93tFq6TKGwCDhkVFMd400jSolYv6WO05tsmnd9Gny9Cta7emHKOPiH5WAn2TZ3RJXci3eU5G40RjpkplZxwG6vVh05KzPTloceRzUNM1bgERvDzqADCeFv5ev4i9hTVRMepoqqm7lpJkxbBLtKUvZ_4R7xZMyNL2ebKds_A1YfNnMl0RpxdRIJzAJClTHtwsDz_EO0e-KwMFevfaRwZvnk8uBFfcDvBvPxCURQdwqC9doZJNLSXDC9hyfaSvatUZ7RAW8SBfo-l4
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: 643

{
  "data" : [ {
    "id" : "pjt_5RYqe6GoyPRyFT63xcTcrf",
    "name" : "iC1QigEFJk",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:03:55.291667Z",
    "updated_at" : "2026-05-08T16:03:55.291667Z"
  } ],
  "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_2WWn2wydMRKyy4kUdCDBse HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZDJhMTA0MC02YzM3LTQyNTAtODQ5Yi00MmVmOTYxOWFjOTEiLCJqdGkiOiIyY2YzMWQxNS1jNzE4LTQ4N2UtYjdkNi05NzMxMzZkODZhMzUiLCJpYXQiOjE3NzgyNTI2MzYsIm5iZiI6MTc3ODI1MjYzNiwiZXhwIjoxNzc4MzM5MDM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE5Z2lPZ1NJRlJYdlVkRFFXZGhEWGkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.SCysIiwfmoRYLfFqHxV1AT5kvjLoCAZ9b2YHsM_28l5qZjA_YoexdA7E8abIAkLme2lf8-DdC4lzzy0MNelc44l-pq-N9e_yuNhiC92HYz1oTiQnIg2XoS4b0b3-36TDMHUq8_vSKKCDjimCTANFbWdg7sUMndZORBsGzqwA1kpeaNZVpO5L-Cc7wPrGoMd3916H1ll__iYOB7bvC6qXLoD_Uinrae8vImxEqTut9Zddh6eG6rDYgCOiRWKtBl1SmoGWzvOq7Gm01GL9fN9xDeKWJXs0XhrSyEZJtHXFgAkfQFn6mLOyLcG2nJXqW13vd8Tw4WS48lcEGoctqTjgoXJX-A58rFnUUOjL14p8IMSuE1F2dMLUtoZlOHfa86io8p3ftSgMWwA4GtlRDsV3f9G8Z8jsdUI5eylg6_P-HFlA3lxaGmOEg2kBYPxcphmVg0SyjegNcuJuoOWNE8vqDHy6jqi8NH5rOBAs4QmGmCZLhnXhCaa_dxsRxWpM7BpSYXF4TjSxInJYgCMSDOOW8rp4cRdmZeCdDpkl3uNb9ZQZEBMVeOmt-kYYRCGVSka2yRCF1EeQSPnJWB4qDb_YeTLrFTKgmuw9uYQuPQ7ZBhB7hQpZMBH9YZoMmMBJCg0rbjG6M2p3bcChKOHUE2YKdgUeX5VudOEiKTZM94rx2eA
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: 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.eyJhdWQiOiI2ZTJiYzJmNS03ZmViLTRiMGMtODYxOC1iOGQ1NDdlYWE5NzciLCJqdGkiOiIwNjAzNDM0Mi0xNGY1LTQwOGEtODJlOS1mMTBlNjZjYzdkNzgiLCJpYXQiOjE3NzgyNTI2MzgsIm5iZiI6MTc3ODI1MjYzOCwiZXhwIjoxNzc4MzM5MDM4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX0I1aXhEQ3N4ZVYybFNhbnE4bDk1WCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.OWmZlmCH6XhgS0xoYQa-PjVVD5luM1_M-ZBVccerANBXBiVbJlBi53w7cr2wwYUNwE1VY_GB6iaUnrlRRuAFQ7WZHK2lIyF2mcqWayDNRAyqdUrS9bLeweXYzEES82viVkWu9V2tp1X6oTHQVQalZ9VEqGc-SsT5JGZxtybHFsmrMrFLWd-DkcSa57mjZCAUkEHlsoNev7vRGR0HRyx3j31pn2cs_saYc6diL1ObrE5wownL5rRFX2iX_Bbd88b3-UgUcteR19yepz12l7yrhdMGWXQj5EaEfx48pNKuIqX5mnA9FARh2MsAv24e88CdI8XVBqCJLcJh8kmpKrqz1z9UPtl1v4c2RQHMyR4ffuE82s8kxB5zAy5_QivN__eWzqTP2CAbqlw-6bqaH7NOiqDv4zF2vTJz7NnwVatIRABT0SD6aY_WAx-QYczHEtLSVTxd1MlFO2uqJWPfYsCbTfPfuyMiJ5VD8HGQIrneRDoow7JfTLNpKOK4KGvrSOyEAkcudLuX7YGDyyXxfL4n-KUMts4-dDqbkMjxDwcvcHvkFCn3L_B8mFdp5uBgx3NU-mw0icu585HZ0Vkjabvyjrsw8YhmD1Oa_GuUnCIsFypHeIqAmchbwf20o2MYFiKB7YXowWA7hVQLTqxmR3REdU3e0Zx6pVgOmv1KeUwSy04
Content-Length: 99
Host: localhost:8080

{
  "name" : "WwKpNplB8P",
  "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_4jiKtG8UvWUkoUE9e1rC3B",
  "name" : "WwKpNplB8P",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-05-08T16:03:58.216541Z",
  "updated_at" : "2026-05-08T16:03:58.216541Z"
}

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_3oapxNqTrMkTCMfZKFIAR3 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MGJkMGVmNC0wYTk4LTRlYTQtYTljZi1kZjgxOWQ1NWQ2NTgiLCJqdGkiOiJmNmU5N2QxZC1kYTRiLTQ2OWEtYmFiOS1hMDRjOGY3ZDFhYWYiLCJpYXQiOjE3NzgyNTI2NDAsIm5iZiI6MTc3ODI1MjY0MCwiZXhwIjoxNzc4MzM5MDQwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJocW41blFpa3I4cW1NUXkzaXVWYjQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.aowW6FDIFXpZP4vSDkPbIZqg0WchfaLEPx4hH2BCIDEEBbRMGmn7w_CNh2x7iuD0yLucGsykO0jObQL1yCjylAI1W58nCOAcNO8MdSymh-X_YXp9aYDdz2E81Z2qEHC2WEJaug76KI3L0lIBmN_xIzR-v_Wfk1Lv63DGT65u7DGQWnPF4rUfFpKCkwIbZtL9ZO_tX1F8ha0_Rc0MwmfHtA7ZwJT2JNNi0MI-ca9Vk6jcsrPTFHdwnnMZrHYjpfqieF1brFRaVUafTwxTiCcFgV2EVF9-syVzOZSkB530NXws13_XvENOOhSjkxJ8IsGICPCxUFqadT838uWtJE-n1-stp2YalOywghrV72NtJsAlikrqRlv2s4-b3otjHAIxwqtGkK8_3fJtDtSlJy_RpJPNPOLrURkkqdmiZUOC0QRcU_I6qbzKTniswyPfjBLgPb82Mou9DPR0kHSj1sfhBGBwHQSDmJF23rmKTRgH8vRt45M4peSodQ9LdJWVe5TGQjd1mp2qAgcpEGkexjEajvJUCwMnd499ZxVegm4LCeBrGHvxXlDNfhEvGmTCNQag36lqgd_sutesEbO9qk3UAUPDFndAOdhe4XeUu29ytnLST1iwtSnSYy18photGN77w-bODUNGu4PR6hSYcUwxzL691WW4oN2adsaJ-REy3YM
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: 234

{
  "id" : "prl_3oapxNqTrMkTCMfZKFIAR3",
  "name" : "7XTdGq7HDG",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-1234"
  },
  "created_at" : "2026-05-08T16:04:00.453713Z",
  "updated_at" : "2026-05-08T16:04:00.453713Z"
}

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_rVAQoYS3H5zLkP8izMA9L HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NTAxOTQ4YS00MDMyLTQ1YTgtOTY5Yi00ZjcwZWMyOTc4ZGEiLCJqdGkiOiJiNTBkNzM2OC05NmEzLTQ2NjktYWUwYy05NmQ1NTIwM2ZkNzQiLCJpYXQiOjE3NzgyNTI2MzksIm5iZiI6MTc3ODI1MjYzOSwiZXhwIjoxNzc4MzM5MDM5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJIZlR0QzZJdWFOR2pzWXc5VFM3N1QiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.BmCAtE9p8qz2Y7VgggvPsZ9X_hj6J_3oYM91UMD3ExS4Z7Fi8lBgWy-RSb1J1FmV4o8893dHIS7GDKTYARBahXQAq7BwfNRiukJwU1rSCSw8Go3oOUMOFvreqzUb_g0pvKLczl42eDOjxQ5CBjPaqFOeU0pJKSmyIRAmznf8QaIsyyMpSwYCXBt0UwBedKCmMYvXFJoK8ZNAC8eSnS3X8zbURJ1R2KNhDCxlgzkuqa9JFE8Q7x7lsma0IHygNLls-TGoRgw9ul9iwtUHDcz9-F70HjzRK2dnNjirIPWme2du7TqUQ4S1p8JyZO5B07kg4IClS-aRRQxVzmSFg1OEs4F6AJtDKwM3Cr2itQNgntE2WyVYttl5_I7Y7yhd3svAdGJ7lEe-jyRB5JPM6nc8pQQ-pi0KaNpQ4jYVP_PeBTr7ZjDOS1L8MBtCvXl8mOY6WjFQEOb98_ky1aAtx-_Zyt8lqkWFw0gDDWfuTJpait4F5023jqqnNrILaimGJGX1zAXnPfpFlS8Kd1H_KnLGdt5wUqkRqRcpjgvNs0S-1OSOhQevGJR0VNhtlZZ3Q5iP339THkABK066ZWS-qdmaOeH5hPO4618x1-wQh9uNXjYgxnQxsKMgNzUlGRcq6mdg2zU4YUrFZbpBumS7Ex10tfrYJ5g7cNf7hOAtak0DR40
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: 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: 245

{
  "id" : "prl_rVAQoYS3H5zLkP8izMA9L",
  "name" : "Benchling In Vivo Role",
  "metadata" : {
    "project-role-internal-id" : "PROJ-ROLE-4321"
  },
  "created_at" : "2026-05-08T16:03:59.486912Z",
  "updated_at" : "2026-05-08T16:03:59.515237Z"
}

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.eyJhdWQiOiJkMjA4YzEyZi0yYTQ5LTRlZWMtODczMS1lNTE4ODMzNmUzYzAiLCJqdGkiOiI1M2M0ODYyYi1hZjhiLTQwMmMtODgyOC1jN2YwZDYyMTNhYzEiLCJpYXQiOjE3NzgyNTI2MzgsIm5iZiI6MTc3ODI1MjYzOCwiZXhwIjoxNzc4MzM5MDM4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVaVEdRdElvT3hYSnhIYzE1R0lXWFoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.LmtGYsxUsTd96zBs9GQuJLWOxhJD2-G52gma_fQLUBgBrfDWiKpZYeDvBUNhqrFyI7RPXXMJsMm08uZxKYhoxzfcFpeqdo1CIxoex1z8Rhkp9cr8UzGjukNxtb7jT9o0ZTjwpJhlxVLvC56Mgip6B_7WAQIqNUzh233R1IYhfVQd9r4scSMgBFTAin0a9PNHjXm88kPBONJYLu8gFFnqC6PF0sqKglnqyby-pZi4e7QER1YuVQA-4KS46aF6mop_4hFLH80rA9ayLqpaQ0pvbArEDkCd2HRAUpY2hH4g37uRD6RNjhKwzXgpoLf41A0jo2UoR8v0bETEn-WGwJBlLeoQRGDwSzC6C3k5ZO7zRDJ3H2dJxWf44OnU1ijifGX9G0riUW_76xIU3p_0x2NB5rWzxYGMQnxvXX_-cs2Vjd8f2SunvVYyaUT3mWvmUUZy1a22nKQI9H7QSsdMbNOaZbokB2b_1UGzQu5Z6Up6Ydo9NdZ4vPtnVdEap8tBasSqT3K8voObIOM94DmGohQI26CV_-7qFtIVrF6q8vck0GfGxY0u4eZHYbSJdL8RkDi7tckRLejFYD-dhE0QxQZ_x6ejud5Zw0Jh1tQ8Xnnp012I-Dm5VbnLAJ14h1bkQkZvMLxBn75j7bk_DEgOGPZoVzNxfnUmDdt2YEn6GjixE8I
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_6c10T55UwHHz8rJA5k7BHp",
    "name" : "X0qax75kCQ",
    "metadata" : {
      "project-role-internal-id" : "PROJ-ROLE-1234"
    },
    "created_at" : "2026-05-08T16:03:58.157467Z",
    "updated_at" : "2026-05-08T16:03:58.157467Z"
  } ],
  "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_4qlby9IFNPOOGeErwfCVgU HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhY2E3ZTVmMi1lYWIxLTQzMzAtYjZkNS04NTUwOGNlYzUwZjgiLCJqdGkiOiJiMTljYWY2MC02YzRkLTQ1MDctYjgyZi0zODJhYTQ2YTAxZDQiLCJpYXQiOjE3NzgyNTI2MzgsIm5iZiI6MTc3ODI1MjYzOCwiZXhwIjoxNzc4MzM5MDM4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzR2c3FpMFR1UnZhZ3h5ODc4bk5OeksiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.WernokTVLbmJXGyZR3aCHoRBbYgv771bCdC9_xSb6us6n9-a6NOCZiwIoOdTyB1GA70wnxyEP5cSFGxypO4bKDNZSkJyblOtuDrnYg_SM98XDt5Z3WorWEzw1Lml8zZsZba2btOxlLQVFDBcOK2tfyef0Td55k5FswIbCv8SsdZRa4fh97m1QjFqjP28iBmoDZ7qLAnGw1IMiD0xmJ5kBtYGqv7nrX1Xq-1IA2O0UDvC1E9tMu8dHnOmr7nZohKbABCA1Uch3bE_GaNXC_ib8n2FrNwA2qb4RzjeXTh1ICmYk_ahJv5KkbjI4l08tUlhRCoiCBxXugPFmTFMQr0P8H-2gbEDtIdrzquoYydqnNiEaiPz1oOgl-ELJLG_gVCuGxyAQ4BkRYLle399V3K-Rmby535vzYgmJ9JMSAZP-1lMZsgSTha4_QzrcAN4IR2jPyI8CmlkrTLYundc27mm3Q1m54xaK2CcGGhvxDVuNgif1ckKlc_eZnmwm-aB5Ak6UKl03-Ir4gJNJTet887H25wdQsRHQu7H5hpsuOXNYbPmNDAx4cqS0q7LrWd-_hrBIxW_r8WUM88U05bUer3iXVydMWV64s_CQDZn4lZs6ifIX5UPp39sg8qqemSKpGC9iOAbIYsEjqkd1DeHP6ex7BHp8e86sLTEDCC9gWPcuW8
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_44EWwFnJiDejtKL7yPwgxL/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1M2FmZGE3MS1hMjY4LTQ1MmEtODUwYy03ZDM3NTgyNDUzMWEiLCJqdGkiOiJjY2UwZjc4MC0zMjA1LTQzODAtYjVjYi0zZWUxZjViMTdkYjkiLCJpYXQiOjE3NzgyNTI2NDEsIm5iZiI6MTc3ODI1MjY0MSwiZXhwIjoxNzc4MzM5MDQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzV3ZjRYcDFpZ3dsUWUxU1RJVDJqSnEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.VIYffAV5WDFNOJoN4DhgPYrV7KnTSUlXzTIWH5XLw5n8YYvb_J05qGxD5yWHf-nsWboPtfMEKKex4wg7xVgfO1rMUgQpSVaqDyyeCxNlPKeE1Hv-69DOcodw3XFPOMaiMc9M8ejtrij5wSTfrXl7Kexhi0t_MmRgnSlOfOVtnkCfkUBoL1_QHF7Zn0p9n4E8bBgWw_kaocPmzmxOC6Vq9hWolvNZF-AnqZZQyzz_lDtuDc1XSN_IIcAaEXHaiv46Q_jc5OLGhFr0Mymh1DIZU0VEPLXQd8ZMKYX7530uL3-DnPs_mlE4FktsjKBIw0TRInGb7lknyfdnKe4PrbuXdWcUAkzEsq4WRFmXenTuDojRiaN5LVBaSlRfAdhyXGoJnhrY5LuiYV_YOJ8baCs4mD6wHxOa-GxokKz1c71jM7n5KT0bgP7gLSe2cDIvCoMztjalNe2fSGFqyykF9oaHH7DEnJnVaY-ONLPp_rTjOVLfULYf0tx-5OXSkUGGE7soXDW5Hc-r9MyWZPpbDSZI7T-osjkzggriLO8fQHS0iPiw6UkjAEuLmL6U2zQOco2g4eEfr6_b8tpwRnwZOQsG4HudVyYJcLtD4HVlmP6CyYxT3Z5yyw2C69Mzql7KHJ47uohoJblcNtRX4wIU_EETTNLIpE9CpGoH-0P-giT5EI8
Content-Length: 98
Host: localhost:8080

{
  "project_role_id" : "prl_7Puejd9s8WA0rntIaejdLa",
  "user_id" : "usr_54EcfPit1Pel2U2CeTjvly"
}

Response

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

{
  "id" : "psl_2J7U82UZjJ9huotB7kt5ii",
  "role" : {
    "id" : "prl_7Puejd9s8WA0rntIaejdLa",
    "name" : "scmP3mDyrk"
  },
  "user" : {
    "id" : "usr_54EcfPit1Pel2U2CeTjvly",
    "name" : "XwZYHMOd5k",
    "email" : "B2f9tdex@benchling.com"
  },
  "project" : {
    "id" : "pjt_44EWwFnJiDejtKL7yPwgxL",
    "name" : "YwsXifNoE8",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:04:01.411041Z",
    "updated_at" : "2026-05-08T16:04:01.411041Z"
  },
  "created_at" : "2026-05-08T16:04:01.512322Z",
  "updated_at" : "2026-05-08T16:04:01.512322Z"
}

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_Z5C7Mp0O1aPYomhWujAwW/roles/psl_59H6HMXFk5c1WfX8Hgf7jH HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmNTgyMzQ3Mi0yZDkyLTQ0ZDYtODVhMi03Mjk2NTc0ZDRkZDYiLCJqdGkiOiIyYTU0MGM0Yi1lM2EzLTQyYjYtYjIzMC1kNzE3N2VkZTJlN2YiLCJpYXQiOjE3NzgyNTI2MzksIm5iZiI6MTc3ODI1MjYzOSwiZXhwIjoxNzc4MzM5MDM5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFZbDNzUnZvZWpJQjdweUpFbXNlTGciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.MlBTLKeNjj861-SB5NdAPXPKDUttLRxkO5N0gvKZ_7vNhlk8iuL0xFsSpku8DXNiT4-gTQ-RW5yMPATbOLWRtxziSmKr7ehn3aCrL3RuFzZwqUME__NBnPCJIa1CblxSEnrazhcL8Zw3bhjpkQxojJRw29jbcDk0DthnUg6QEgtazYQ34sadjXJoQfJOrMSF-7uZYYFXrzQLSRtoXxF8MqT8RzrihrJ6U2KSaPUWi64UsQPSX94wH8FNzidewp4nGnMvc8rinfsV-oSBw9r92Zyu2Frcx2USWk7PUFmcBDt6ovQxu8kWpPGenem6Am40T9yxTMLv5t5vG2fu1zlschFpEmLAJjTiRoSNdZABMTvyomM__ST9T3pnqFfl3WiQTLmaEhgUNg9yXqSU7Hr7_eCoiY1cBvP37R1vL0lZmmHfOLWwbKbSjXREB43QB9AF5tQr_-nidRSlZtd3xALSCn7o0ZqNhcxWna7J2rpNJSEgprFTpVbasOFvQYvx2VmoNhDn47PJlBH7QaedgSMEosLk0bjRSI0k0vOeLUCQaFGvcQIabbEHSEYp-Rg_KmrGyMxvW31BL2FfGp1mXn4ptZIt3-ZxdUJnXySmSvpXZ2lRnOA3BIt0yk0pnrlmy73jt7Sybp-peC0i4YYpZMm4xbmBnTYGauGusOVFU6YrCgc
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: 602

{
  "id" : "psl_59H6HMXFk5c1WfX8Hgf7jH",
  "role" : {
    "id" : "prl_51jdOH33x9yBLnmdV0RAQ1",
    "name" : "1atYpLxJfe"
  },
  "user" : {
    "id" : "usr_3XtS5dy0i7Pfn4vbouBAse",
    "name" : "XN11shxjtK",
    "email" : "jUYTBBkf@benchling.com"
  },
  "project" : {
    "id" : "pjt_Z5C7Mp0O1aPYomhWujAwW",
    "name" : "73JD7dUN6k",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:03:59.541219Z",
    "updated_at" : "2026-05-08T16:03:59.541219Z"
  },
  "created_at" : "2026-05-08T16:03:59.612764Z",
  "updated_at" : "2026-05-08T16:03:59.612764Z"
}

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_1IqnHFj1UqGSBGjlikTkX6/roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MzczMTM0NS0xYzI4LTQwNTgtOTBhOS05NGRhOGYzMDBjZDkiLCJqdGkiOiIwNWNmNmZhZS1iMGEyLTRmYzUtYTQ3Ny00NTZkNjEzYmNkYTYiLCJpYXQiOjE3NzgyNTI2MzksIm5iZiI6MTc3ODI1MjYzOSwiZXhwIjoxNzc4MzM5MDM5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVqTElHT09BYTJYdVd6UjlQblBINWkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.SHmYItaMHqPYGc9ZAf5MkuguWUNE7GYye2xsE-nEVIQs5Hp_I5A1eRPgPtTfCL3ejpuv1WVMLqhyqu943QrOPp26E5G7wTIOwHA4-SzN3qitrUSHTpEO1F6knfBtSa3CyvysoFsKRusd_fxp1Qaa2BgRpUznjIgY3NftUnFoXhbLYv8WkViv2Mhovny-4U3Lp8NdpFweTONdYaC5_XgrVfechiyakFBQoXBaMOHX2WzqNU7xZ65ZB_dPIro6Y44No2uKgIXS6_8f8JQazvQa4ThclbaPYVqd-3TmHh3Rltfv1E7Am2QSN64O5KkfPocfZ0k6r2peaI1mGzqv9MDK4EAOAGrkFa-pSsIjweGKWyjMZ0rix58XqWmlKAB_i8E9r_-7kAS-WVyUshlZSfIB3FyD21Bff81BvzIw5pGfF6Nv5rT311h2y1xADjlMlxxMqumZDgM5UC6V13JEkHCosVoFxSeoliJfrk7MiGqRg07rRSL8e5SC5YQlqvb1YSaGrdnJD6nabb-ai8CySYTorga2uPm2Nb5AmPsVTBy9y2scHgqUAi9I720AdkjsBEX-DMflYPLfLbKuPGTt8-WKM6EwW9uHJt9YNAJf67GazNJDI9DPHnHaAJzukbrRpJErRyBYDtROyhDujhRLdi6KgkeXdgS5k6Oks5WC2YvZ3Hs
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: 1149

{
  "data" : [ {
    "id" : "psl_5YD1NLNCqxoePb8ur3zgB5",
    "role" : {
      "id" : "prl_3rHSeYD2vdwMhMHOKg9GZT",
      "name" : "8VHmjq1PYu"
    },
    "user" : {
      "id" : "usr_2qBco5YwE0HBbvZCJkW1Pj",
      "name" : "HZn1zOcb2X",
      "email" : "EofJOljT@benchling.com"
    },
    "project" : {
      "id" : "pjt_1IqnHFj1UqGSBGjlikTkX6",
      "name" : "lTVkBLetOM",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:03:59.847229Z",
      "updated_at" : "2026-05-08T16:03:59.847229Z"
    },
    "created_at" : "2026-05-08T16:03:59.925095Z",
    "updated_at" : "2026-05-08T16:03:59.925095Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/projects/pjt_1IqnHFj1UqGSBGjlikTkX6/roles?page=1",
    "last" : "http://localhost:8080/api/public/v1/projects/pjt_1IqnHFj1UqGSBGjlikTkX6/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_1IqnHFj1UqGSBGjlikTkX6/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_4VELXnLT4kvhCaKiR5B5li/roles/psl_7YYvnqPFbUk6YGw76vjuOx HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MDE5Yzg1Mi00ZjM4LTRkMDAtYWE2OC0zNDc3NTlmOTZmNjYiLCJqdGkiOiJmOTc0ZmQwMi03OTg2LTQxZWQtYmIyNS1lM2YyMTMzNGQ5NWIiLCJpYXQiOjE3NzgyNTI2NDEsIm5iZiI6MTc3ODI1MjY0MSwiZXhwIjoxNzc4MzM5MDQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdWWG1RQzFxRERRMkFaYncyRUhVR3IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.HnnIVxN8nC63kaJAhg_AdpshCek9bNMxT5SrFyO3sJ5e8Y_4tWmPIKdcl5iz0drnX0g4O3XIAAmN5Bv9OrliW-u-6jqp7VRWXZaRQCLi3Fw4GjLeILSqQy-QuC0QkoJgrpEw_1_QNswCWXOaoM6bRu2yBPy3R5SntppKFmlzSSVvyZTUdEeXqasMnhW2iSXA0OsTiqtAoeYhrwL985TEjxJEqmP_x0oY97_EZfOlHoHE7Q2PXwQwl37uaubL_olfLswDdCaRNrZhBQfxoe-Xlg9IFm5mq6V6zLXp9-CC4wGTnQ8wNAr9aIxPPM94EUAN4H-GDFhqS1EnFTOk4GX5TDmXCoVtavlViprZ-X7juOkb0avbNoZG3gdLkyRPJmvGFijGFw0JAH3CbfxymHhtG9VAddWJhr-qhTPboVYvKv1bohAB912fKVKitQTzDIKo7zQjc9TJDDfSV3LD7j9KKutZSmoY-DBUAICTW9JgbEg7aLtDu4FN94fridwwI8WfYxnfErAlu8xAToUQP4zGNCGFltiQop4uap3GY46ZocWE1ZWCJMUAXYj7O4LuGms2oa6mbXQeRMNsE9Qv1Elaw0u0iJiPH_IwVkbjqlNFxzNDoAJEr41D94kNfz5KUjPqem_Bvmbw5iI1NCIld5i0CsdFapjTCdPvuKS17OyA39U
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
}

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.eyJhdWQiOiI1NGQzNDVjNy04ODU5LTQwN2ItYmVmOC1iY2UyMGZiYTcwNjEiLCJqdGkiOiIwMzczZWFhMy1mMDk3LTRhZjAtODQwZC02MjU2MmJmM2E0MGEiLCJpYXQiOjE3NzgyNTI3MDcsIm5iZiI6MTc3ODI1MjcwNywiZXhwIjoxNzc4MzM5MTA3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdWVVBCcDE1TTkzaXMxeG9kcWRCZEoiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.mnL98VIieHzvp2nPKq9-BISm0GMRlpW-f2UTqkzY3sZuwW5N8IErumgEJvQB_wjPtAPWNjpAUwDAHdZdVx8_1ULze7EBby1m-PvVtMmV3sNL8diizodZe2kSZ0NHerWFM0_8-KzRYz2op5X3ZEOWlwZE1kCcqANBN0pQeF_a7LGnSocyiMu8gX7L5dJAGW1sgqPrPtei68xZSlraUGiJvP06CDW0D2RqMm-VF7KyYhLQeZIPDKzF8IeTQeyG8ulNyCrxe9aHjOcSKSLOITNVv9Mw_JkrETnPlx4GbYZx1N-NUCI10FBVprQj6KADu56qeQvtlfFMI_fuzyn-RqRz9YvY2ZTPtYWNskancFuoA-bQnZ83mdLtvIxH9dHwK_J_ni29znJv5W5malG-9n-9_mNiHbkUTYvyLyby2XdnghfAM9ApbjAR7Aky1P00hO5yiYCb1BCZEYcWQh6wLS8gpFfiEX30Jte7-ZMvg4yFhCLifPk_361hTJcwn7TmStjcztRlj2qrD-d5NXYudu-cTaavbBKizlg3lVNPeAO1UNOD24eRg5VvcOgIYhQLdQO0sro103YZOWsoSMRBtn17xQ2GkTRaVhYmGvccLKiATVkXZwToxEYTGA7Vpu1RqRmPUh4fmjee23lQoKEs8G1TKXdSELMy9p8zlZ6eVa2vA3Y
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: 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: 399

{
  "data" : [ {
    "id" : "tgy_6Q0Isk086HEwzrMIdC2gXa",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood samples",
    "status" : "active",
    "details" : [ "volume", "weight" ]
  }, {
    "id" : "tgy_1M1fH2txGRKdcflJ5sRZ0K",
    "title" : "Tissue",
    "label" : "TSU",
    "description" : "Fixed tissue samples",
    "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_5hr3pjTtj7sKsTUnfrU5J9 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MTJhOWM1ZC0xMDY3LTQyNjUtOTNmYy0zOWVjYmM2M2UwY2UiLCJqdGkiOiI2YjNlNTc4Yi00MzMxLTQzMGEtYTc0Ny00MTVmZWU2YjI2MGIiLCJpYXQiOjE3NzgyNTI3MDcsIm5iZiI6MTc3ODI1MjcwNywiZXhwIjoxNzc4MzM5MTA3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRsSHpMbGxickhyejIyTnEzakY4QmUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.V0T_Wei4RqDnNRGAKKiby8fhIsoYW9WXBgccc84BL3LTJdy6iqYkrbYMG7giEUNWY5Ns_NXl2XTSNQmwjSip8pZVdAmKdSplA5VKuOS1H68WHcGIw1HewISWSoRIRvgFWzzglXGHKJuN8YI5tAA5VcaHbk1yZdnwY9pEkGm2RtbMtyEt6zRY7hhk9Rlr47g1epXeURwuilGtVT9JAeoa6j6qXYGcMXNvsHCxs-qobWm4td7y9ZU1xins9xt00-mKQpqo9bdNt9mP2CQpraRtvMwa-vgeVrhMYeRTl4wX9dwPL5R3EyBMoG3_kEfzteVid1Pe0S30tpuWAOfL9sqj8AQQiLRMyMysM95JxOyAK-XGPQ82-L3azZhZ56eebBxoeh2eyGZvrkJWyLv2jpqjZWBSjuM3JgkRxxf7_jp7Gq6BCBwBysoEpfTwgpEp6rbYRuEkqCZQsxnG1ioI9QcY8rkhaB3QvMkzMTX4QvG0Ooge64sk_R1WDqtqkG7v8jcBinKed0IrLJjdm9tnMdGv-cE3WHRJeNSo90vTQOkGX4VjET7CDviMWejUjyaz1oLavmnPdGTHm9W8m7HqlI_fQ-mcEMUPBYL9eGNx5OBaMME7LvveS519oBR7IC7Vwj4Wct2AV2OE6MfdHxcnqTeT-IYbVm-EkTS2clvvODADwvE
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: 207

{
  "id" : "tgy_5hr3pjTtj7sKsTUnfrU5J9",
  "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.eyJhdWQiOiJjMjIxZGYwMS03ZTMxLTQ5NjUtYTFlMS1mMGZkNjc1ZDJkOTEiLCJqdGkiOiIzNDJlYTFkMS1mYWFjLTRmYTItODU4ZS00YjhkYTc4NWIxYmUiLCJpYXQiOjE3NzgyNTI3MDcsIm5iZiI6MTc3ODI1MjcwNywiZXhwIjoxNzc4MzM5MTA3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1BVY2VjUXBGaW5UN2c5eVJ2UFRXdCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.jYMro67F8VlLZZ_fY95hRMwHsuGgG03fmPrsy8i0k0R-52LKk_lYOLtdlTgG4gpwQgsN0T7Dt9I65ZR09W74AJsD0Ag5xxIycVVno-ycvaNbDR8WTtxxNcs-O7Yel8N4mQdafWe0RdKBDfJ89uGLrAmrhwh_u9i1sVhnwzX-C__Fhy9UiDRLBE4og1kp0AzIaJS1wGTui3A8UFLqmsMyPKbD0vaZlHNPZUmihczjyXfaMqDIXkT_6cN0aJDI6pVDGzWHn36wUdf6SWmTW5WGp79dTWAWvzlWq3UiSobG3IjwhRIW7K2r3pc2tG-DGGXVlXERA-ppuz9Ch92mDVqjioHoakR5A5-s9U2S_cFnddfVCmLR0yjGjLAh30qUHIEhsGU6eXWbbyYM8cNy30L2yPdtBnC3dC63O_LqfFAagVa1cjq5zNAYYoTTQpFGSbadrMexNOyaDfVxFP55-NAO9i7yNcIn5cKgY58RR2w5nh1L0OXHfrICGjPVUK-tbDIsFrU7DGKWwMOqF3rl-M_QsL54oSWmGuhW8uNO7o7tlUS8CPlKs5FOHlPBiEPkFB7szqlwB6wIGIdpXtz_7Bngi9-tZQZzEid2_8U5eqQiSD1N7q_YkZFIoTu5BTjbK5RpVsvWUAE120VCBeM936WfscH4YpCo9vKSv36RWxLid0M
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: 888

{
  "data" : [ {
    "id" : "tgy_66unf68ARFhmPpVeBAoEvm",
    "title" : "Blood",
    "label" : "BLD",
    "description" : "Whole blood and serum samples",
    "status" : "active",
    "details" : [ "whole_blood", "serum", "plasma" ]
  }, {
    "id" : "tgy_7fi6DbmhoWhMXEEqvP9tXR",
    "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

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 collected timestamp of the sample.

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 created timestamp of the sample.

updated_at

String

The last updated timestamp of the sample.

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_28ETREzvv5SoT5SrTJlSGZ HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZGQ5MzJiNy1kMWI2LTQwMzMtYWY5ZC05ZDI1NDJhNmI2NjIiLCJqdGkiOiIyYmEzNWUyOS05NmZhLTQ0OWUtYWUzZS03YWJiYzBkNDAyNDAiLCJpYXQiOjE3NzgyNTI2NDgsIm5iZiI6MTc3ODI1MjY0OCwiZXhwIjoxNzc4MzM5MDQ4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZmeTBUMFVHeXZTYmpoTXBSbHpCeU0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.i9nW2lpUwNtolRe-S59OUh4MvOAG4QzsaEEFqgf8WaV2_5n4HTE7slWWQIwSi44tT2VxRV2VJDy-S8EmS09lYWw0vDEB33ks8bbT3-UyLdgTjD2u1vCCZE6kAJHBI7STSqQZRD975LqrcfrP7p_Eyv8BmWGNSlyBK2v4VPSkmbkhh0_kEZ9DICvJKH12oUij3nFaOZU4ZvRQhQxTNaKQjaNNVhWirsMJI3HqPU7OGaCCVn3QBdIb4-5eSt3po5t4R4yNphDQqHGbqzhmlLQdGlos5D-e-LYOBkXEaGdlmya0lBFV-G1n9JHexK3DYcZH7X13yYm-iiEGUH-r2ZxvuRmKAB08I_Zc0qfWuKKdp6MALmIGE7nnbBvvL1cXspzKH6KNR5HdHSwsA6L4q-CYcbFN2My05sNejL-cZ9ygBcBng0ztR7kjV1AeoLXsKZW7WcJNFZiot3TX2UGE94iqvjQAQjK0f_5Wg4QACHsrtso0mw9-3x9HQbUwp_uyW204lAbx3LEYjCsGzQbV2mFQMRIqOa0Bwg3m7z8x8-YgGbTxibfiEiMYSaKY_t6mFQiz59foiJH10LSVEhFY461PRBLfaBbzn64WZKrUti9eDSood1UDsw3LLHno2ahVslViL4RApTwjV6PY2F36u_xkygebGQ1rw76hK9GwhTjHyvE
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: 2931

{
  "id" : "spl_28ETREzvv5SoT5SrTJlSGZ",
  "sample_id" : "S106969313",
  "sample_definition_id" : "sdf_3GWQQ1IRBh10xJOkw0nw1B",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-05-08T18:04:08.404472Z",
  "details" : [ {
    "key" : "volume",
    "unit" : "ml",
    "value" : "5"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-721956588" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_6CLmqnDJcblxNESQUUGppN",
    "project_id" : "pjt_1wbWyqg2V8bSOqfsGF5ABj",
    "name" : "wfeW4THGDl",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_55brQtcCYi5mHIh40bsK0E",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "3QXakdATBK",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_57j16BXXTTan2DOka2BLX2",
      "name" : "ugb57fS0gL",
      "email" : "M2Qbwyl3@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4DXPYY40botWfDQHT5cf9d",
      "name" : "5804RbEysx",
      "email" : "z041BKEE@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:08.017788Z",
    "updated_at" : "2026-05-08T16:04:08.017788Z"
  },
  "animal" : {
    "id" : "aml_6i81HzKc0bF4M1j8L8dGpL",
    "study_id" : "sdy_6CLmqnDJcblxNESQUUGppN",
    "study_group_id" : "grp_79rqClUlwOrCZ7oJOvzJRk",
    "cage_id" : "cge_1Lfjej8UF5iZDx3qTak5B7",
    "catalog" : "A0000001",
    "name" : "ciiFsYzmUB",
    "number" : 1,
    "strain" : "kguzC5E8DV",
    "species" : "j42z8LJUZO",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "RyMFeGCh80",
    "ear" : "xtzrn66UtB",
    "tag" : "gNbpw2Il1T",
    "donor" : "jlEHxfbwXK",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_5aYmWIjqkv1iuFW6iocSBI",
      "name" : "rHERtkCcOb",
      "email" : "6u4H8eVb@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7llanC8zD2kBigRXw50ypx",
      "title" : "Found dead",
      "comment" : "wDKqB0Ri7l"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:04:08.241221Z",
    "updated_at" : "2026-05-08T16:04:08.241221Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_1Qrqaslbw9hGG52RfaPiyO",
    "name" : "sdK9rI9tPF",
    "email" : "oY6506M3@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "O7iEJFkH7O" : "dsPzQL7hI7"
    },
    "created_at" : "2026-05-08T16:04:08.393074Z",
    "updated_at" : "2026-05-08T16:04:08.393074Z"
  },
  "created_at" : "2026-05-08T16:04:08.404564Z",
  "updated_at" : "2026-05-08T16:04:08.404564Z"
}

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.eyJhdWQiOiJjODM3MzE0MC00YTk2LTQxZTAtYjhkMi0wNjQwOTVkMDc5NzYiLCJqdGkiOiI4YTA1Nzc1Yi0wMmQ4LTQzOTItYWY3MS1iYjhjMTE0ZWEyOTIiLCJpYXQiOjE3NzgyNTI2NDQsIm5iZiI6MTc3ODI1MjY0NCwiZXhwIjoxNzc4MzM5MDQ0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNrQXhYOHVRWTROcThTaGVJSkkzQ0IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.K3ISa90hkGmrFsjh6pUv-Msj0M6M2hqNRI6ZJwa4_1Gr8q8CM3vXedfXSLqojxmgxXQRO98HOejh1aexqXCHvbg_eF8Fx5tyis5U8CHdRVov4OkF77dBbZE9yasDOSWt77_k6AFWeDXSzvOLBWJty_1EMndHkFCSXs8NoBRSvHSUoURmKW5K0suXS2p-WbrjMTayIwSmaFAh1i76MQ5q-Z7lc-teg7peS49hAlEGc9ghRDyvPjVx_VTZucSkQG58i6o0j6QgEjllSO2o3qVxzcBGz3D8CxdgX8XARB9MWbfmm8x_FEty3fm2m1eug62wGv1kMh1ZTgso8HK0Kyb2aycU3egzDFHD2wjKuuwjXMjR_Bn6iJk5a0plciLLxmYurXiMo4uLmgH9Q40Zb1co03y-wtsCKQkG2Ul5hQRj1SvnKglsRM1hUOuigbV0tTSZLtCQGzHmY-DO5zpsIkh_otztX1pGPJW0NX3HtvANy9Huf7iZaJPK4rhtFFKPXlFrb-vw2C85AQpTaFrSmTiiPNPokAGdFYSNDr_juZCWqgOhK6BA3iZc4XGOdDMqpA5pbWnhw0dvxuTSnLcqUCNtSjd6h9pPqgelP2lgflXPi7ySD4DPzQweShm5mEQUCNDvIV71LLHgRAck00flLNqr2Lqd4q5PvPYiHCt76mpaBdE
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: 3531

{
  "data" : [ {
    "id" : "spl_7krO0hidwI001GhuBEBaw6",
    "sample_id" : "S729206200",
    "sample_definition_id" : "sdf_2dGVBpztfvkjBhZkPOqrSU",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:04:04.204263Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1342982441" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_5alBpy2dXPrt8JnmHpGGZC",
      "project_id" : "pjt_58o6reOER0LwrDgEwF6ZQS",
      "name" : "wUgcqaONAR",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6IbTf06ft9opgRMxIlQwTB",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "aRZ3xCtA4X",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_21hQVw6TMDcBCTQkyHTbxA",
        "name" : "IjwfprfZL4",
        "email" : "8EdXLWOF@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6EEeM2kaaMbAlz9yRjTZfN",
        "name" : "V0Vv3KxKEw",
        "email" : "1s0XRxHM@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:03.898229Z",
      "updated_at" : "2026-05-08T16:04:03.898229Z"
    },
    "animal" : {
      "id" : "aml_3QPrpS88Yl6AbTQVel7E5Q",
      "study_id" : "sdy_5alBpy2dXPrt8JnmHpGGZC",
      "study_group_id" : "grp_vaBoQTGtztlqKgs9o6Deh",
      "cage_id" : "cge_7TKReaTYfD7aD0BHQxea12",
      "catalog" : "A0000001",
      "name" : "0YAeogOIAb",
      "number" : 1,
      "strain" : "ttNsWBnSIv",
      "species" : "mmWBNvn01T",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "fIiozmCp59",
      "ear" : "tinR8Fjq9Y",
      "tag" : "vFoHCZyQgN",
      "donor" : "CvJDjSz3w2",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_5ht6QMfF3vrAevn6QFunNl",
        "name" : "UpSxgbTU58",
        "email" : "0uYVoqCL@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_2vqwdzIdECJiXDkGCBXvYh",
        "title" : "Found dead",
        "comment" : "In0UXIPyLb"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:04:04.062768Z",
      "updated_at" : "2026-05-08T16:04:04.062768Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_3eaO6cGq4jIYYvQAv5jNnm",
      "name" : "fnGh4AooE2",
      "email" : "BY4HThCD@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "4IUOrdIhQJ" : "caBw574qLC"
      },
      "created_at" : "2026-05-08T16:04:04.191324Z",
      "updated_at" : "2026-05-08T16:04:04.191324Z"
    },
    "created_at" : "2026-05-08T16:04:04.204344Z",
    "updated_at" : "2026-05-08T16:04:04.204344Z"
  } ],
  "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.eyJhdWQiOiIzN2YwOGJiYy1lZGM3LTQ2MDMtOWM3Yi1kZWEwN2I1YzljZmUiLCJqdGkiOiI4MThhYWQ3My1lZjIyLTQ5MjMtODhjZC04NWQ5ZjI5YTQ0MTYiLCJpYXQiOjE3NzgyNTI2NTMsIm5iZiI6MTc3ODI1MjY1MywiZXhwIjoxNzc4MzM5MDUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzE0WUtoVlIwQ3VYU2U0MFlJSHhYZEciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.D9__LWwBPqTjoVEDfvVKqZ934vrdlDGFa73B4amBISqIvvv9H_5b5H71CNXk8UTIS0hw4exmmjkYtgrNPbN25s9PLdCunzrj49wRb5sbtm4hJxUAxd45u_oRPRskGfC3SOGvjZeLRctc6r8niCrXdYdjwCIgsEbPM27TmwFpwcDTRxbkQ0-BABV8TD_W_EZWWRx-NduswuGHrEIH_QzwWMaTEAqjrd_UYBb2bFvHCpxVQ1LqTStGBZUQyA91gkquu8ixzW5-2bxPUVKnuAgQK-pGIAfMWt-eB04vVgSKXw3q-fWSpUonxJI_23FFaMMMbil7qietmFvrsXTfQ_Q62Ha4ufILZk8gRIYyfqRYJwt4e0xjOzOsQX76hcLR2EUlrWXcvC-ETjJ0HI0yVKnd57Pos0Ga1EvQSwnj09Br7Y9PR710ver5IPHCUrHra5Sa2vWPmp-C2GQc9NtShCxcpK0wcYT4b9ck7ECWqd1aEK7zUVXpBuJ2k2mFdzzuqdlfGFhf5xH_FdgXKeMkFQTQpTkI84VuWIbA5frg1O2tnuWUTCW0HUPIeM5ANOTDUtwG2acaJ8Hd0luCHK9bDPL6aexya2d-zuFWvqAyz1Ndq612y0aQIF-8iCufUoo-Cg93pP6P5xasGZrZ5fvDiq2k8R5EoyX8ip-sFUtxRU5SwPg
Content-Length: 46
Host: localhost:8080

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

Response

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

{
  "id" : "spc_2sbj71xaSle4CzZnCenfAl",
  "name" : "ZW3Myu9kDV",
  "active" : true,
  "created_at" : "2026-05-08T16:04:13.577614Z",
  "updated_at" : "2026-05-08T16:04:13.577614Z"
}

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_3e3Oe9EwZrtAV21gnwFnnU HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MjhkZDc5YS02NjA5LTQxMzAtYmJjNy1hMWExNGFjYTZiMjgiLCJqdGkiOiJkOTI5ZjQ1NC0xNWYzLTQ0MmUtYWQwYy1mNmE2MWExOGFkN2MiLCJpYXQiOjE3NzgyNTI2NTMsIm5iZiI6MTc3ODI1MjY1MywiZXhwIjoxNzc4MzM5MDUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzMxRjRVbmdPYnhTWXdvcjVWTkxKd1AiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.iyhfbZwayDHw8sXTLmt4X7twL6y1CMHz5uilrWZ5et8fFdhwPSdeIub6mHlpux48LyjBxiQvkdYDbblhwXS8nhjM800bug2Bo0_M0_KzQp0rGy1nAZegF2mYU3YTMFxh_L1z_A7XrhImgcq49HT2nnUoetlSfOK3VbkvoDj5QcrnmsNIojsnLHM1utK2ZGjeCMNS6P_V-CkJd8Z62tiRW00Dc6vpNz8Tt_DVfEr8fbBSa3f_Xdng-FK3b8c04BGhG_9k0bR819gKJaUDYOkE8pmB1ta8SPzbfgJpWntaVbOckxUE5fbB49BjwloyPuOD_LMtHvqY54ma2P5Va6xHN9EWymEo_emOKdkZyv0aXXTXLOiYlocOwxXDYSk0LD1LwkTVtcVbP4ieWWL0S1LTZxgKkXtifKiC2N00UBcw5kmzO3yqJEECMTlOMi3GREdH0nO_Ta5J72hfVMg9SFuLXv1BYjV5mHZBZt1ykgrbaw1_HEE3GTnE7mY_i7KK11CV2Jj6dD5T27-JAt5lVvkSp_00lvYNP1E1wLNSDfYLIo1tZYXm6ozjgb41k7ymtsU1cDpo5IEaLFXEKvMhyIJQmvgrwjCROP9qavSU4uAoDPTAtRx2xGhLlsuP2-YszvYsCLbev7_ZoEW9q1_iodREfPmp3FCd-RWjuXdB_FlDrxY
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: 181

{
  "id" : "spc_3e3Oe9EwZrtAV21gnwFnnU",
  "name" : "iiA2Kikzh4",
  "active" : true,
  "created_at" : "2026-05-08T16:04:13.592059Z",
  "updated_at" : "2026-05-08T16:04:13.592059Z"
}

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_7iUC5LvA7GwEp9dEk84aax HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4MWZkMDRhOC0wN2ZmLTQxMmItYjUxOC1hNjIwOWM4NWUwMzYiLCJqdGkiOiJhYzI2ZWE3ZC1mODNkLTQxZTAtYTdlNC00MWMxZjBlZDI5ZjEiLCJpYXQiOjE3NzgyNTI2NTMsIm5iZiI6MTc3ODI1MjY1MywiZXhwIjoxNzc4MzM5MDUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJiSHpqOG92S2l6SGhxcWhJckRJZlEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.JDKJBWNrK8DuIj2JSFdqdeVpewWhxT0pt9rImmhZ8j8tp-scU79EODfVUN4PXo3YItLYHCrvVOGAaZQhhJvYfmVDCB56kX7edTIHL4GR1Z4ibp3ulDzA1yYzhmZwmqqMOZLg-Xrp-mq_jXdu1Kn388FuXWVYfnerKgNqnNOl542F9-0ptd5gb3TupEfc-KBB0iYZH2LffVipQrQXBqZRjE8UoYMhNNzGj73UsySfmeeB810I_o4TaQytJgY22zrDWkOsrLsBC88krpIMBdgDztxWKhQbDTuZ-NeCAc5VeFHvTSqZgG6anyfM55P3yBC6HgT6HEpJJXt90JBaxlgpzH7M5riPslglvwNWNcuK_DzfLgUZRktQBwbTDpLv5dZqqxrAwFt0zB3m5IgNhxR_caBm1e_3mPUVOORucnkzXS89k5BYIinpFq5C_sN2TQx5JyGwgwxNjA4ox5c6ptYCLDm06mZPlQbdSSCp3yw_m3Iy1lmJoNvnFfucWHm7bMGAIBEJlz8ntgy3jQwwPo3eIeAbasV5n1HPq77qPFDGT53t2SCtB1HUtJxexpPiE58F3dkchhRVOyvycbqh6pN9-tVZ8pfeP6jSZ3U2SF-BZEA1xMeOn4A35eJE4EIrRGzEv9xAHjNjI4BUXlJqaTjYeBXcu1WNdCABJwOAgV8tySw
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: 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: 196

{
  "id" : "spc_7iUC5LvA7GwEp9dEk84aax",
  "name" : "Benchling In Vivo Species",
  "active" : true,
  "created_at" : "2026-05-08T16:04:10.667438Z",
  "updated_at" : "2026-05-08T16:04:13.687963Z"
}

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.eyJhdWQiOiIyZjVjODZlNC1hYTNmLTQ1YTUtYjc1MC04ZmNjODRlNjJmZDMiLCJqdGkiOiI5YTJlNmFhZi0yOGNlLTQzZDktOTEyNS0yODkyOGMzNzZmYzkiLCJpYXQiOjE3NzgyNTI2NTMsIm5iZiI6MTc3ODI1MjY1MywiZXhwIjoxNzc4MzM5MDUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFBb0Y0WWc1bG85RWJidzJYUEtRQUQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Fk1H0i2QenUViM1ncOq19CmMX_5SqevOJ2g2kpAYc-QFF8NU5Ol-Xu1ime7lj48xx2knjR7-GcOp-uyVSig3ayRTqLSGA0MEeb0rEG3Fx9egYjrLm-MFr0RZ3rd6b3FOYoOfVN8kFOF5NJh1BdiiQnSD4rpi6i9QCF2csXMXBcQZWt1g-P71wz4kW_REnYFWK5uXjxh8HdK67BUGRpY9rxDkl4X9EMtlJDa3d78JxRdw8FW0gh1D3S2gV_i3yKM1KbYMdg4H3zs56OvlJSKglgYwVJGeapJ2mbZijXTYHHheqWVvi0Gawhhq6V2DF2frHJqsU-0DGQOk7gZi4B3FAADs2esQLlpRwPveva9OMuBuo3Fl5FnA0T-1580dkrmzQHjBZ5sVD5KZX_D9RpPN-XjNQq0G1yIyNj_5JMIbIKujxC99pMsy2t1rtYv9lcgM4DseJs_Yv6fmIFOxgTmaFw9K1WrG9hEXps_GFaYdvx39XcDf673K9YMole9b1btKuNE7S4VIC7zWkLVsKmGrR1Z5S7KcKtEoqtCT5nHcPofbhsvXhfdE-kEy1cuAD_F15ioLhR-A_U3hvgtsBbBM1tg-55WOtnZay4Ciw5fgUrZxiishQoLd_-ddmN2-TrwjiVObTzI37MaLqfuK1wMwviyFOuVoeGngdXq11u08iCE
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: 593

{
  "data" : [ {
    "id" : "spc_5bXEHCA9vyHsI1XgmvIsiu",
    "name" : "P9MchbxSLq",
    "active" : true,
    "created_at" : "2026-05-08T16:04:13.313819Z",
    "updated_at" : "2026-05-08T16:04:13.313819Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/species?page=1",
    "last" : "http://localhost:8080/api/public/v1/species?page=1",
    "prev" : null,
    "next" : null
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 1,
    "path" : "http://localhost:8080/api/public/v1/species",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Strain Resources

Strain

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

Attributes

Path Type Description

id

String

The unique identifier of the strain.

name

String

The name of the strain.

species

Object

The species of the strain.

created_at

String

The created timestamp of the strain.

updated_at

String

The last updated timestamp of the strain.

active

Boolean

The active status of the strain.

Create a strain

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

Fields

Path Type Description

name

String

The name of the strain.

speciesId

String

The unique identifier of the species the strain belongs to.

active

Boolean

The active status of the strain.

Request

POST /api/public/v1/strains HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzZjRjOWI5Ny1hMWMzLTRkZmEtODQ3Mi1hNGJhZDAzZTYyZTUiLCJqdGkiOiI5ZWMyNWQ2Zi0zMGEwLTQ3Y2YtYTc2YS1iODFjMzYzMzI4MDQiLCJpYXQiOjE3NzgyNTI2NTQsIm5iZiI6MTc3ODI1MjY1NCwiZXhwIjoxNzc4MzM5MDU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNJZHM5aUxmcXZBeWNTWDZWTHVFTlAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Aoq3I4juCZ8h-gItVN0Oe6ltctaSMCl7p3a2-O7l_Oh8psdjX7s6TD2y-FJvYfm0GU8suV5ZuEwGbEguHk1UnjdpLJj-Z_dr_sWBDqVCatr6UlFxPoWjnWvp0QNzDorCOUInOxsTR7srBj17BdFGERd0wun5TbJRILkCKcT4WymR0Dbujq2YTXBiMoDIV1GPyEaHRHL1q7C4v7JA9baDBB_vyA1whXK8vS_C_-vRYPmAQ7sJIHenai1ty7I2XeVmonnod2xZqGWaN5YWJ2yjK_kzBT31lG60YJ6xGhNsVDltV9vZYi8vJ6YWkQu0BgEIefT42Mi04wnJGTfARdGL-BvMpRGlIsyDSrYRofCbTabnDKANsyXxL94zZBGLp0Ad-px4anLmuIfW6lE6EZb5LkKol_tNfiv4kMqQH6V8C2PHEU4KNfJCL9y60Gxu4XiZnNQbOaY4dF3MDxkSzg_KZArOtXXfnKUOfbAtK-srPvud7lkLch8fEHn8QNuARaTTs4Gkf2uxP4mlZujGPapH8DxvlygcGt-srKjUUehYoN7y_uY8N381hjkMDsbYFy2n0QKij2NwCAn_5tkJ4u55j_rvU9ac8QVz1aSJEi-ve8uTZP07ySbrxvd7yLRzUfFX5deqKcpxrb8pvKjsnKdYwToHzbMQWyy3UFfaT7uHmrc
Content-Length: 92
Host: localhost:8080

{
  "name" : "ySKxUCUO2l",
  "speciesId" : "spc_527Usdg1liRECcz9ZFe21V",
  "active" : true
}

Response

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

{
  "id" : "stn_4CiTXxXcW4KHRF13GSzoDz",
  "name" : "ySKxUCUO2l",
  "species" : {
    "id" : "spc_527Usdg1liRECcz9ZFe21V",
    "name" : "WQWRK5nx1x",
    "active" : true,
    "created_at" : "2026-05-08T16:04:14.483230Z",
    "updated_at" : "2026-05-08T16:04:14.483230Z"
  },
  "active" : true,
  "created_at" : "2026-05-08T16:04:14.488787Z",
  "updated_at" : "2026-05-08T16:04:14.488787Z"
}

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_3QMdR7BB7SsmbYVQec4t3h HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3Yjc4YmVkOC1iYjk4LTQzY2UtOGQwNi1mMmVjYzA4MzkxMTciLCJqdGkiOiIwNjdhMDI0My0zNWViLTRhN2EtOTlhNC04OTVmMzQ4ZDdiNzAiLCJpYXQiOjE3NzgyNTI2NTMsIm5iZiI6MTc3ODI1MjY1MywiZXhwIjoxNzc4MzM5MDUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzYxTUNoakgyM3B6T1RQaWdZNFpvd1UiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.PL4RKfVPWYg8aeOBjTW-y_zzGpun6yWk_z3k1R1kVHSsVUPD_FOYqg2CzZ57s07PzarzINSRDHfPwYz3gkyepcXhs0zJqfwsYnfGArtsAtRS_j02VyXOsxUjIZIVigtAKGijp7APv_Q25BPRz1Nw5omVUmq0P2jIyr8zzLYbnRnFOCOLECghhusk1oNWeyIsYcnyJKA2JW2eb06fowC5Go-tzcIVKKLtncudIJX2qhjBy8Mq6rfZBWeZQZYV_ub_6nU5RpEvYbxKKJWAOy-B4wxeuhgfmvEiZb8YjbZos9XO0i4RxOpTE5ihYCqAw-w8uWRMxvRXWxDfKI8rbDufm9svV-n3e3xHuMXREN_s7UXWyMQoEq6Gppvb4U4DxP0n6b5R3wXXlYnqKM-WZamNmhkK1D5kEEliTGBGYMnx5coWZZaUmGx5jiuLRdZPBK8i-VnRiYsf7gGytcO62HnsUWSPiaN9RWl751YTpEsT-V8v6cWv4oFfDbdZvukKcXoSZMLIy83Y1LIHKNitmOVTsRXFzV4cO9B-_PHd63GgE8wHaan_wsXtwTrDqR84zwiWUNcEyvfIZ3WeiPs8ea_sPMp1V6kLHW4P_8bCnNLjlBngAzAQVpdya49qV2BysY9NqWdbE_oob5Dr0SVr_Mcl0OVHKrIrPmYvt61syHdcat0
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: 390

{
  "id" : "stn_3QMdR7BB7SsmbYVQec4t3h",
  "name" : "SrB8vNOnvG",
  "species" : {
    "id" : "spc_2tbS46pLttXVFX0VP3SVUV",
    "name" : "BtrNNsanxC",
    "active" : true,
    "created_at" : "2026-05-08T16:04:13.981332Z",
    "updated_at" : "2026-05-08T16:04:13.981332Z"
  },
  "active" : true,
  "created_at" : "2026-05-08T16:04:13.983493Z",
  "updated_at" : "2026-05-08T16:04:13.983493Z"
}

Update a strain

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

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

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

Parameter Description

strainId

The unique identifier of the strain.

Fields

Path Type Description

name

String

The name of the strain.

active

Boolean

The active status of the strain.

Request

PATCH /api/public/v1/strains/stn_5V98kpxQAgNdfdiwbVyVeb HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNjI3NTc3Mi01MGUzLTQ2NjQtYTE4Mi0yODQ0NjQ4MTQxZmUiLCJqdGkiOiJmMzgyOWY5Yi1hODIzLTQ4Y2ItODA2Zi02Y2VmMzVhMGY2YjgiLCJpYXQiOjE3NzgyNTI2NTQsIm5iZiI6MTc3ODI1MjY1NCwiZXhwIjoxNzc4MzM5MDU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVLRE1CS0pSQ1F2YzJObHoxUE45YWUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.EEa9xhnipeeSVIXUlXO8oWVPGzojDRnLospSruww_cAr97cWOm5sz4uUX1cbIzZiH2JJ32xlGcXsT7D856GkLuocRFQWnAhWHs8GRSKTdlSX0LMoRuS-W3cYy_wXj2WJUhlGEjijMcQj7yNBEgTJahspfQkR7SAssVSf8X0H_oV29moozyBeXSjoolfycJjeu3z65Jes11tjmbTW_WvcMEd3IcSldJSm3qEEjMjlxhxvlLfjS3Edr28Cwo_rtac7x7hDadAiEC3HHabCswnDnZN1lyHiowVVcBqxK08Zk9HkO0875ldTetlMMmnh54TOFeyLlDmsaf7ydpuFK2cGhD8nntbTTEg07iUsxqh4iw1V-bdY9zyvqbm4Ro5YGGyW4pUYF-NTHMRaj5ExiMMN0jwid9L7NbGjL2WDv6Mlzn2b8-kbiGonOsl6R7pDIozHTIOnQq3G1hwzcKdohSGnesAHMo1dxcVRrtN2ZLvHsKYikMPaxr_HShTwI2irYb4m8n8S5OGRMEYvhGtbHRtw5HjgaUm0g8MWUJNitc4xfPSJCeZR-KCZRwUAHwsFskV5snKD13E2QYESs3ZMI0bgBzcg-y2MdadTjHbQ2p6lEnVfW7oL_AZpdn5ePIZO52qvn1q9LRhHv55W90-tASGmyGA5vPllfvYtvyAQMK6aA_A
Content-Length: 60
Host: localhost:8080

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

Response

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 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: 404

{
  "id" : "stn_5V98kpxQAgNdfdiwbVyVeb",
  "name" : "Benchling In Vivo Strain",
  "species" : {
    "id" : "spc_1wJyoRFP2dskrv0lPpvHN1",
    "name" : "G7rgI4Za0s",
    "active" : true,
    "created_at" : "2026-05-08T16:04:14.499194Z",
    "updated_at" : "2026-05-08T16:04:14.499194Z"
  },
  "active" : true,
  "created_at" : "2026-05-08T16:04:11.502117Z",
  "updated_at" : "2026-05-08T16:04:14.517898Z"
}

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.eyJhdWQiOiIyZThkNTUxYS1mYWRhLTQyMWEtOTNkMS01YzYzMDU0NzVjMDMiLCJqdGkiOiJlOGY2YjUyYy0zZDhkLTQzZjYtOWEyMS03NjhiYjcyYWIzMjAiLCJpYXQiOjE3NzgyNTI2NTQsIm5iZiI6MTc3ODI1MjY1NCwiZXhwIjoxNzc4MzM5MDU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1Yydkl5WEI4RGltZ3J4N3o5VzVIcyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.MdO62e60pgtUttY4MY-SUPmsQts8MkVIpnvr1feLbT1Rng194rlPqlknrL6wqwrbuzlaologboLUMhZSsOwmxhH0AM_aWDQuBz0j-LvHtHxg6hOI5MBB5FT0K-M9UzyspHWnd2C53qTDO0IvoMc1v3_N4jJLYrLMFFvB2P9r0LjQ-1DpdRuY2gr_ZbOX06DRLv26DQOZLweWD93KAW3xpbtOthvyurl-sLbUW3KEVHB4hMtH-zRcc4LU2Ay70PreRN6hIPr0pdLv2qfb_K2T1r_DwtDUy92zqcXzalLZUXhYX_pIJhF08YuG6HSByg55elyNrh5_U4aql8BQrNqMVQGg4UMAjX6gvG8Iqk2QRFJV-fTiPKVG5JlmTh7c8l1ZfWzzdrJdo-Kx_t2Mtm8nQcP1cn3GsB2Vm0soqPIIdvFKdRN-Jx0GRTCmSGG3wLVJH1iwFJXag4M2aZylGgzgdzO2kDs-ctPpDhQg0ZGhVbf6QjXP0FG3WqGPYQaZ5Mb7c-i5N6cpsYnKJdtYnJuDzFqzGVRAwKJCTfJWwCxXuCjcKaC2NTyNxbXSdTv6IqHW-T7viUPyXnpzxK1dSdy8joilfEJDof5cfhJFpKoww42vcYjyusfVUn3PwL-tZElnWj88X5d5WDNP6eLtgQxCaBeaa0UVGQdXLxU2PFkFcuY
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: 816

{
  "data" : [ {
    "id" : "stn_4WA30NTLMozRsBZs7ylSIT",
    "name" : "CcWBepQPM7",
    "species" : {
      "id" : "spc_2xd9ENyX4nl7BsyBPr4Nf4",
      "name" : "WxxcfPNbm0",
      "active" : true,
      "created_at" : "2026-05-08T16:04:14.533223Z",
      "updated_at" : "2026-05-08T16:04:14.533223Z"
    },
    "active" : true,
    "created_at" : "2026-05-08T16:04:14.535573Z",
    "updated_at" : "2026-05-08T16:04:14.535573Z"
  } ],
  "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_6z8GL95RBuHLybRmvTcf2y HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0YTQzODNhOC04NGU1LTRiZjctYTZhNS0yNTY0ZjY1Y2QyZTciLCJqdGkiOiIwNmZmYjI3Yi0xYjEwLTQyNTUtODUzMi1kMjVlMTI5ODFiMmEiLCJpYXQiOjE3NzgyNTI2NTUsIm5iZiI6MTc3ODI1MjY1NSwiZXhwIjoxNzc4MzM5MDU1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fN0hUMTR4eGtKcGh3NjJCWk9wZ2h0OCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.kpeWS-z962g9VnG6p8JmB-tr_jstCk4wulVrpVraJ1c7Orz4dBMslGSVcsdvFvs92b_QmyW-9Uzlyh_clkBPB-i51UPyEQr08vREkQoL0qEKHEGXVyiuLFUs9llwzssSmQ_1ksqtsCj-VA4kkgXqwASndcBu8syITAlMBuLDXVXiFUAb7iSXf6q30KgLDO-4jSrvw6XQDH7m9_GSq09KKnqOCmRgF6ufijZ5NzXL-gx_7Z4Gvi-zFQfZ4ihLEyFGNG3tc3nbdYtPLZdTbS7JPsI-I1AJ7HsYDvVXsG3oppLIx6jkIvf7F-vdmgMkuQJCFzP8nem3X59dkHKcNk7jeVLt02LOe0gtpoIJ4XbVgMTkLG_CYx10J5s19Zu2ZZUjAWoyl1_sRbFVXSlDwuGkIcMb8JuclQbE5qzqWwEinplMi1D1Id5kltMqSF4nIeeNh_bbEyS9Tbu5xT_w4G2w8wvF9RREuUQxSmpuf9CzTzRfNmNYImguuNvMCu9g0xqGBY6LRS50lXMhtZ5VSgwqWVpqm6fFXHkmrV_JVK80IVtNpevNug5JlxA3NyJ1ZlPGDpfF9GpOLb8NwPTqJLToU9u1m8mcQF66xaz5oLLRoAQhDfsbRR3YrAdJcAeVtvWsNlFt87Uf0lCNuaLNhD9BxEC6KS5mpeo_KwCim2Ar_Js
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: 162

{
  "id" : "sdc_6z8GL95RBuHLybRmvTcf2y",
  "title" : "test code",
  "created_at" : "2026-05-08T16:04:15.201647Z",
  "updated_at" : "2026-05-08T16:04:15.202640Z"
}

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.eyJhdWQiOiJmZmQ3Y2JjOS04ZWVmLTQ4ZTktYjJiYi0zYWFlOTQ1NTM3OTQiLCJqdGkiOiI3NDkwYzk5MS1mOGRjLTRhM2EtYTJmNi0wYWUxZjRjZTVjN2YiLCJpYXQiOjE3NzgyNTI2NTUsIm5iZiI6MTc3ODI1MjY1NSwiZXhwIjoxNzc4MzM5MDU1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHlfY29kZS5yZWFkIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNmJRUWdVbUFmT1JEc05vTlJuejdSdiIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.Ipwj59Vjxvu3w2EhE5TdWwpOyivcjvy2g_EUHwUkFoLqp4hG-Hf4_hYSpDlOiRoDkuQGlCxQ0tzXoGJDSCN5A9S0sf4EZbKagNvBpb6QFsj0LZFNu43bPCKrwHZUyjOrvkMFz6ke_ghSSLzUhTkfeJwSVycBifgGF7yLrw39064ui_gXSTC8tcoimNziHbqLNI1J9wlRgOhB4R4KLGPeZduUkmIBlZAZ-YYZfgUpmub2kGSPB71RUNEP4f28v5TTmOMQazEtJ-eL2C9K9GWH_OVCo8N_o2tEnttI1JseZv6vqbuDv1c6C-rtTF_vvWczNn2g6s2zCwX1rMEjtaGRlLiuxPv1eQ_58n9H90CNCG9lmeFBiPgyxkwWefkbO0sRMX3iNJAD-yI-fjRxav3PSP-LD5ciXlKqOZcQWyg8EfO11z8PV8VraOogxWxg-nLLvJNVWMNpi-6aVY-6K-FcB5kIJR7j-gPdCa9wTwAbR4lq8haQYOygMvYdrnUhZCiDbZx989pBOB9tO-PCLoDVqgHZ9Yz1brgr-6cvmL3jyX0NWys-YkAvC3xG0CT9NYXEI35F8VRmHpYhqnxCZMrt-OT9dz2WjH7-uyY3Z5IuCs5SuP7Xsqkm5WblwFe4Erf9eMXXyyMpAeBoMbzWDmJXV5HQJvg3kU1OdM_Bt-50gb8
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: 599

{
  "data" : [ {
    "id" : "sdc_1f9isr0YDraY06gkCiTHwR",
    "title" : "test code",
    "created_at" : "2026-05-08T16:04:15.412312Z",
    "updated_at" : "2026-05-08T16:04:15.413695Z"
  } ],
  "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.

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.eyJhdWQiOiJlNzMyNmY5NS0wNTk3LTQxMmQtOGZhZC1iYzc3YjZiNDI1NjciLCJqdGkiOiIxMGUwM2FjNC1kODc1LTQxZjYtOWYzZi00Yjk5YTE1NzcxMzYiLCJpYXQiOjE3NzgyNTI2NjUsIm5iZiI6MTc3ODI1MjY2NSwiZXhwIjoxNzc4MzM5MDY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdBNURxYm5HalBDNG5zY3VSRXZzb2wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.OVbFMy73FeaiSlzOxxXZbdlhz-_oYI_w6A48l96MgufoRzK7mVI5NqQnxWs8qGWFUnNHN2NNTtzuXg5kMG7HzuqYFnth1ZZRbTktfJ9ydV-DcP0YoH2d9MZoFnr-YAk5p-DQ4fORS3LF2VYYJOYRF9sQlYP6Ob_bYUGu_oaYa09n7z1aTldmxzXy38t1XJ9IlDdDRPGvQp-MPh6zhH9VPiCDaZX_rspTm0xl9WvuskDuOHqgT8UpbccUkSFNSynGBhl2YKvhkA2eKgH_ko_gKrsY_bxa80I4X_lhExo6_MKuk-6aJb7VBof9JI-4p9B8Vs2A274k5sFahUeYfyeMdsf8kp11fZ2LVnl6RTC11kkLvk72TyjZq_fMv-q0gdCZ-nA0UWStd6Z77uOaGR3uvdAAhu-YPssa8gLoQSPaibQZBVSHgAS_Jf-eObLdbWK5nosc_YAvN6ljVnBS5udEtB7S9UTYNCXK8ePiyoKRcttkM2U0c_ORM6LZxWo2DonRK0Np1hdDloIzlLnFK9d3glAtFmvJF3w3ZvePjT7Ji1xzi5Sk_EpMqFBUSBidZwhzCMZyEnX2UxwMMdy-lu6lgF4r_dZNPv3nwNk6gzlNKUF6XUlA-PXG1A4qc3uEMmFyc6NhMBQBcU_B25EFJBRMlk7rvWAhj_vI5opYd1-jW9U
Content-Length: 457
Host: localhost:8080

{
  "name" : "CQpRMiBDuU",
  "type" : "internal",
  "study_code_id" : "sdc_1EsXvR6co42p59Lbf2ju1y",
  "started_on" : "2026-05-08",
  "project_id" : "pjt_32WOdFoJaNqIoDwRJM3ccG",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author_id" : "usr_1RMQwOSVl7yWZwQLbyrack",
  "owner_id" : "usr_SrMqyeK76uGOh63jP2fRH",
  "team" : [ {
    "user_id" : "usr_3Uxc54XQcosVDLY4rqFsOv",
    "access" : "read"
  } ],
  "timezone" : "America/Los_Angeles"
}

Response

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

{
  "id" : "sdy_6X71zXkCPhtqSMdXLpYpra",
  "name" : "CQpRMiBDuU",
  "code" : "OW-SQ1-26-F",
  "study_code_id" : "sdc_1EsXvR6co42p59Lbf2ju1y",
  "type" : "internal",
  "status" : "in_progress",
  "description" : null,
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_1RMQwOSVl7yWZwQLbyrack",
    "name" : "V3kEDHVBMW",
    "email" : "oBruzy6Q@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_SrMqyeK76uGOh63jP2fRH",
    "name" : "Aol7sJ87lf",
    "email" : "0W1bfMVU@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_32WOdFoJaNqIoDwRJM3ccG",
    "name" : "onTs5wHyEM",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:04:25.002667Z",
    "updated_at" : "2026-05-08T16:04:25.002667Z"
  },
  "timezone" : "America/Los_Angeles",
  "team" : [ {
    "id" : "usr_3Uxc54XQcosVDLY4rqFsOv",
    "name" : "XgtWvfW9mq",
    "email" : "hk8LVA0z@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read"
  } ],
  "started_on" : "2026-05-08",
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-05-08T16:04:25.245678Z",
  "updated_at" : "2026-05-08T16:04:25.245678Z"
}

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_6Tah8rf4NcuCgdbcUXut90 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZjk0ZTA4NC1kODYwLTQ2ZTctYWNmMy05NTNjOTgwMzBjMjkiLCJqdGkiOiIwMDgxMWUwMi01ODlhLTQ1YTctYjhhZS0wMGUwNjg2ZDk0ODciLCJpYXQiOjE3NzgyNTI2NjQsIm5iZiI6MTc3ODI1MjY2NCwiZXhwIjoxNzc4MzM5MDY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVZOFF4Y2JwSlM1aEtyT3ZQeXVVVE0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.NZD3O-D5BPspFwbTk2D5KZvSSttoam-5EiTFyfQTBeFl9fMcX5Avr4jycLnt7kGrV4n7ggqKIvxA4c-m-YUWMiFBJ0Qa8yKSUGUPFSmaCWhAwdc3UTdWk8oqVT_sbFqEUcO7ADFpKbOKM3GL3PRfSh4RBcQGqFRd1di_iQuz-yoBonDsaDN1cDQCdyNMf9fg3xROvfvcjB97ovs5wECbcSvzXQu8tYa_kKsUzs-O0fAcheKK9LQFHXrDf81YVhvL_tC0Tky8FeNXiJiflS503szS5AiBw7B4UMNEGtr-rYZlIPfH6DCQU9fFT5ejj7yWJ7lSmpaR0tPzDjltuUY4Kxq-c7U5duIoauBgMPIbfqFLBigcj4YVCDojDFkLN9SwTpDjjVq9gSIoV735LmXDS2tsUHkB7g28r_VJOv8VyKX3VhjzAUVYqOi-oNCohkOnxAwG4EngQq2mUHXLGLW_s24-aB3HrN0gHRe1M2KziPTvZTmiUhScEoA6AASvR9_oNP4UFYo7pBPKYfOf-ec-1Jq-sUidXi-TwFuyVPtDi2h2z2BVLQck6BweaC5NJyG8tn92Ec4Rx9wGnRxQaQ35B_eqmvf6mImSBoMnvc37gyft9f7qXqpc3j7nc3KTAG4YtUfVGKKaaUWE1WGvpsN2uIs8DW8kPljDFhLQwOc9zC4
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: 1054

{
  "id" : "sdy_6Tah8rf4NcuCgdbcUXut90",
  "name" : "AxhUmG6x3D",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_HaiNcYjJXoYpPIpFBoReK",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "o5hcqVvXEo",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-1234"
  },
  "author" : {
    "id" : "usr_5rpw8WJMqWanYy9VptJ6Mr",
    "name" : "2LCGhxcmRf",
    "email" : "TaLlmUiw@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_3xb6VrIdifONXK2cypSEiE",
    "name" : "u1oFvLfAOF",
    "email" : "5w8FOGbh@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_3IRCbEZTvXV112j5XGZ6Ph",
    "name" : "9zFcnHtioO",
    "metadata" : {
      "project-internal-id" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:04:23.957818Z",
    "updated_at" : "2026-05-08T16:04:23.957818Z"
  },
  "started_on" : "2026-05-08",
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-05-08T16:04:23.965239Z",
  "updated_at" : "2026-05-08T16:04:23.965239Z"
}

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_2SZXrMBvkWUSTLI8sxHIH9 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MmRlNjk1Ny04MGE5LTQxMTAtOTFiMC00ZjMxODczZWVmYTgiLCJqdGkiOiI1NWI2MzFmNy01MTZhLTQ0NGYtOTQzZi05Y2Y1OTg4OTYxOTgiLCJpYXQiOjE3NzgyNTI2NTcsIm5iZiI6MTc3ODI1MjY1NywiZXhwIjoxNzc4MzM5MDU3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZFc1RFQzBzMmNKa2hPeHN3N0FSQzYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.cmgOZVardlM4qqGgt33uBB0FMSEQepth642Z0Ggyix--8NWCQ1aQSW7FNPcDgkAa44v0S46hj3ulGAzDayGI3XFdCiNFhotw8lZa711qfEm4Cgn4qRU12wFh82-Trh6594r4IXJLprsSs9u_rwD0djdGjfBVPPTKZatLieEgOZyjI6NDd68fymta2gjxcRrYcBjbYbsiXIwqsizu4G8XGjbhdhMXAEqfhnLXfl0gcEnP3iIA3ZqI7_h5Ltodg07GbLDTTBfuEBkaNqzCBQxY-Q8AuEXIBBtrSUq9mvMVtrUSuoX07vO3Ce_ql22Ay7u7AygaLLfsuExFpoeNax-nZWY9bi-RYDVSxf8g_pXyc1s_00jFBa4tx64g3NoVNA_v9LPQQpU3NJXG64NzJge1MDZ2xGQN8DqXQdQk6EOO4cYa1YfWYTkhmmAFQ-jYX_LIreTbFfEB0UqwvZd0ISsmGvSwigKmahf0EtOMvQp2ms_5lNcedLIreCwLHZAX-KXirBIiIcEfzIlA-kbbNtBBY-2_Y3VlrLS6MQ8a55w7IYxyM0C5NiNMtoAb-gfFeOsJyrSbQc8hJYdlReQn82yu1AWje-hdtrQx7ok0dSz6yZZnzTOZTB94N5MgwNi2nP9gw4WZPW8hmI6Y7Y1KpL6aI0xkvgs6wzNUP1XHsP4U-lk
Content-Length: 277
Host: localhost:8080

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

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

{
  "id" : "sdy_2SZXrMBvkWUSTLI8sxHIH9",
  "name" : "Benchling In Vivo",
  "code" : "CD-26-445",
  "study_code_id" : "sdc_buzXsDlwnSIRIqZEvVJKA",
  "type" : "internal",
  "status" : "in_progress",
  "description" : "HYe1YrbJKr",
  "timezone" : "America/Los_Angeles",
  "metadata" : {
    "study-internal-id" : "STUDY-4321"
  },
  "author" : {
    "id" : "usr_6ByvSyLaxFB81E8Yl6NNDx",
    "name" : "dSE2ow4CsS",
    "email" : "stufQzWc@benchling.com",
    "timezone" : "UTC"
  },
  "owner" : {
    "id" : "usr_5AeaVLPPUeq3e6wnLvpCFX",
    "name" : "uNcDBNOtun",
    "email" : "0mE7zeJR@benchling.com",
    "timezone" : "UTC"
  },
  "project" : {
    "id" : "pjt_4zKhNUM00juOdNzKjCUB4e",
    "name" : "28Szokz1Kb",
    "metadata" : {
      "project-internal-identifier" : "PROJ-1234"
    },
    "created_at" : "2026-05-08T16:04:17.629708Z",
    "updated_at" : "2026-05-08T16:04:17.629708Z"
  },
  "started_on" : "2026-05-08",
  "completed_at" : null,
  "canceled_at" : null,
  "created_at" : "2026-05-08T16:04:14.755794Z",
  "updated_at" : "2026-05-08T16:04:17.798813Z"
}

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.eyJhdWQiOiJkZmRhMGVhZS1hNGUxLTQ4ZjAtYTY4Zi00NTM1YzRiMDAxYzEiLCJqdGkiOiI4ZjYyYTMxYi01NGZmLTQwNTQtOTllNS1mZmQ1MzFkYWU2ZjgiLCJpYXQiOjE3NzgyNTI2NjQsIm5iZiI6MTc3ODI1MjY2NCwiZXhwIjoxNzc4MzM5MDY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRmQk1uSlNZMWh0ajUwQU1JMTZXSHUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.cokhXknJjNpHbMrtQH_-mp3yn0BHjPCZuFZEJ6GL4ldqVQrntVTmMVcfbwXg7TQtiGuQG09ezaZ4CJmS_8m0wqit0TVtAob-W1Hdg5Hqb1cHDvLkduVI_ClKjVD_srKh5JdMGw5-rfLvQHghzJUdLZHDNyHRvmWqvfUAWD5in5Pw7iXdCzvGD83usRv3NWZhc793OrIA49rC_QFVBp5HeIrfh2YbgXnoRKzIDS7N7o1b8YQmGYUvkj_PgpQvN5fy4oOl_goST7GNo4W2RD3fQDb4l7C5FfK4Xm22Y_6meQupsE-oFwiSR-UMaEm9a632vG9OO8S6jXxso_ntXZQhBAfdY9OqPBVkQUrheXT_ybaeeR-gDZOHS-gOk6aXyy7jtwuvXzKcEcUI4NKGz4PKECDQLUHrdy7VJwIoMBUMMwdhYbKJc2zDug6fNo5W5vHKGIqcEccLMxmvhB8DI8LSWXB5RiKZG0IQ6LRqjaKbh566hRAkBDKeuCsOZNRq_fxcMmG6c4NQkbXXgJAJFwvrEgoA1CnChw31ZU_9SEHeUcprcfNbODeb5ZfFv_A21iWMGDciGn2t2RNakqbWsAClHqE1qLgD-7c-2v2tR9e8moVfZVRQkZWKzS5eXvHxbpwoNG-D8cQ56uJbE0QpgseLaCW7ehk8zXziocgyxvs7zrw
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: 1531

{
  "data" : [ {
    "id" : "sdy_6S54fWpM6vyRL5DEDJuWcC",
    "name" : "4jyAVx6ywm",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4HQhJTUJlipbYy9Uhubiab",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "WGk2o6kW15",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_6jfPHrFzvjAG9GPu7OAULz",
      "name" : "jGc2JsRjUr",
      "email" : "owcWyfx0@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4UzuViPT8VM1kaHLmzR2hp",
      "name" : "ArGdA9DJyN",
      "email" : "UbLCXoaB@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_5bTI45HsmJAJYwQKW9Tzyq",
      "name" : "o9JwHTJxTl",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:04:24.436852Z",
      "updated_at" : "2026-05-08T16:04:24.436852Z"
    },
    "started_on" : "2026-05-08",
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:24.448840Z",
    "updated_at" : "2026-05-08T16:04:24.448840Z"
  } ],
  "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_7hyGWGsNmimwg5R0jUihGL/animals/aml_10N48LEEYhJKvxtKuV0ecr HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0YWFjNTk5Ny05ZTliLTQzNTUtYTI2Mi00OGNkZjY2NmY3ZWUiLCJqdGkiOiI1NjVlZmRmZi1kNzQyLTRlMTUtYjYzZC0yNTcwZWQ0MzAwODIiLCJpYXQiOjE3NzgyNTI1OTUsIm5iZiI6MTc3ODI1MjU5NSwiZXhwIjoxNzc4MzM4OTk1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVCT09RTFpja3FEcUZVeTZ1UG9NalMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.iEKq0YoHNikttEfCrKDDzsHJGA42jnDaYoz69q23OSUsvm69pxsKzsuKpEEC33xGEjwPzx6c4N8os-xAQLqRO-HWKHL3j2rBUIBiT9pdgds_9YVLK9qb6U7P9QDSiylXLFjK-N2YQA9NAbaK-Dk_-796kDd2eW7keYwV0PyqMscgkTWw9zZsxDirqMe6V37CAJLCWXrYN-a5EleSsVC7rxleG_1JcbsfbVPwWs5tWJI1u9g4bSvhZh3BiJ4Mjn-IaMACC5GAO1CZ3ft0mmxf0wmo1AIHitDRqt3UEe9_1MTCimSTasgRyz7Z838M0FGqzt-AJY0ufX8S8Myy8PbD5gXN7-uMjrFfW34R272HgsN81HkUXg8ztAgr5M6Rqj9f7LPiJw6Jfx7LWi3FiClRa748ny2O7H0xN1Xx8RCgj9ugLGX4VYUEYOk2D_Qk0F-f1HdlKEvRWkmgtnvsk9AmZ3Ve7sHbphJfin6Tkp_aKT_LmoAxWZkR7ByoQIurtiN14B-1SAuNMGp-zUhIfOFpAoiGwDpScEQX5yaDLMaZ8sPwSWx4x5D6KS79xpzNEnnQQIFEbACvuGwKHZZC-52V_No9VEs3QJT4SBU3C9FhQwcwJG4IPpYHcRhwf7ddQCFeZsOK43DwFTGG9f073j5evVgd0ebWX7mXyK_w6M_7-HQ
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: 2550

{
  "id" : "aml_10N48LEEYhJKvxtKuV0ecr",
  "catalog" : "A0000001",
  "name" : "wOaljnIItn",
  "number" : 1,
  "strain" : "zLDrRe5WKh",
  "species" : "IEwWnHRnd3",
  "sex" : "m",
  "dob" : "2026-05-07",
  "tail" : "I4hlFo1PFz",
  "ear" : "0IpjpOEFpm",
  "tag" : "JpSs5p72OF",
  "donor" : "isuM6phgyY",
  "tracking_date" : "2026-05-08",
  "disease_induction_date" : "2026-05-08",
  "terminated_at" : "2026-05-08",
  "terminated_by" : {
    "id" : "usr_4FLuUe2c94pwvOxalUosDa",
    "name" : "X5oHn79Nxa",
    "email" : "3H4eb3B1@benchling.com",
    "timezone" : "UTC"
  },
  "terminated_reason" : {
    "glossary_id" : "gly_2h8urYTczUEsTMy1Iv27p7",
    "title" : "Found dead",
    "comment" : "iQguKmlmrw"
  },
  "disease_survivor" : false,
  "metadata" : {
    "animal-internal-id" : "ANIMAL-1234"
  },
  "study" : {
    "id" : "sdy_7hyGWGsNmimwg5R0jUihGL",
    "project_id" : "pjt_2yTqFzorm8dWYyPYUQ5uJG",
    "name" : "v76nLqNGwf",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6M602eS9UKr0aijgQVWshL",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "xOr1Ev0LYR",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_4g6K7REU3zWR62Mk1CrwOm",
      "name" : "MzKvIOvmKx",
      "email" : "9TxnFrH8@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2mOmZ3AuZXorDfTnMeJulv",
      "name" : "eFXFyBC7Fc",
      "email" : "m5bMy6Mo@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:14.787874Z",
    "updated_at" : "2026-05-08T16:03:14.787874Z"
  },
  "study_group" : {
    "id" : "grp_3IncR5X2m3kKsf5MJazSET",
    "study_id" : "sdy_7hyGWGsNmimwg5R0jUihGL",
    "name" : "j1cpDwldiG",
    "no" : 649766221,
    "color" : "IBqafQfZuQ",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-05-08T16:03:14.945221Z",
    "updated_at" : "2026-05-08T16:03:14.945221Z"
  },
  "cage" : {
    "id" : "cge_Ax8vBbw9hmv9wiyHinvQv",
    "study_id" : "sdy_7hyGWGsNmimwg5R0jUihGL",
    "name" : "SfHXemxQSX",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "created_at" : "2026-05-08T16:03:14.933326Z",
    "updated_at" : "2026-05-08T16:03:14.933326Z"
  },
  "created_at" : "2026-05-08T16:03:14.950377Z",
  "updated_at" : "2026-05-08T16:03:14.950377Z"
}

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_dzaLWh5dEEIRKyJuKSAC2/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MjA1NmJiNC1kOTRjLTQwM2UtYTUzZS1mMGFiZWQzMmM3ZjkiLCJqdGkiOiI5YjgzNTMzNi1jZjJhLTQwN2ItYmI0Mi0wNzNmMDBiNGNhMzIiLCJpYXQiOjE3NzgyNTI1OTgsIm5iZiI6MTc3ODI1MjU5OCwiZXhwIjoxNzc4MzM4OTk4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZvMmNRZVBBbkd0ZUtoT0poVGdQZG8iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.IoXgTQut4xfxN9T1uyXKx0dARLujeV0H6PPja_BrVbbrGZmLcQkMzkFBy62PFyJ8Wqp5-Il_nvqabEwNoG5osailAyLifcdD2rg0ODDWnWBHZi_yJdlBqFpAXe5mzPwNM4DxiTEVUhO2R5ow0jw9xYjs4lD0BZ_D6vkezoacktbqBhBGsnow3qp5XmTtGIE6jGQoYhFA6DhbXJ91OKA3_02Uwccc7tcZ25VwLoAzH-PilotM7_ff3ZuO8q2DmrgVTXpVwVAshjvKuY5sf-BoPYRZjpBNu2Y0R3fqsm9l5I4FY2LtkYRlfNNH7l4ZDnXGTLqYdMcGcF5Zg0AJHb7vPGDF4vnoE1dDQA1kc7AZiDNUK_lGltD84vcSUuqdzsxDM_g0SOSMLVWDEN_DSx1d6S7vR3mhlYQylobjdgTM1OxPZNNcbtEGDRTDze283CXFGupCbhkgBnR4dZJqIqWCri539Ed_kfT5-Tjz1z61MVIhSw13n-QQ1RO_bM6wURMX0goKKfzm_0Kcv_TztCLVO21K0XXG4de1MeNedxRO4xVikeqjvtE3PntiaSdhafsvYr2gQBaYRUeh5BxmZPng-Gvgorl1h9sLQ8lpnVLjvi4YshPEsE0ypSkfuAwiH_NwWgyeDhNFNIqvDOZdBdDFlhzyOaN_xe9Pirmq6seQwwk
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: 3226

{
  "data" : [ {
    "id" : "aml_d5wmXtEsLQ72tWTk6HOil",
    "catalog" : "A0000001",
    "name" : "m6LE0PMWxE",
    "number" : 1,
    "strain" : "eV5wO0FE6M",
    "species" : "AdO6idfBfJ",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "5Y6YZkDcSS",
    "ear" : "RpS3b8fnIG",
    "tag" : "SpYLYWGn2Z",
    "donor" : "PyAEVFIQ6J",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_6D0XSrUsPtILDlVXp1302T",
      "name" : "Kkkm0zxFv5",
      "email" : "7jJ0yUYF@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_58Lv60aaXRPqaWVN5ntRKm",
      "title" : "Found dead",
      "comment" : "MOTzGN2VgG"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_dzaLWh5dEEIRKyJuKSAC2",
      "project_id" : "pjt_Oks3Zs9hcn2gf0EbzLUe0",
      "name" : "MfulMGDLaI",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_7BymUIVd1rdA6t6blmB7Bp",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "dVHtq8lNMy",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_4CGTw2uhnLf9KQ0bIzdVb1",
        "name" : "DPhMp7Ngj0",
        "email" : "cTKNGSfk@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_23wIZb7a45Idt2UpkaBm0D",
        "name" : "9lhfDHyR6m",
        "email" : "p42WSh31@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:18.065847Z",
      "updated_at" : "2026-05-08T16:03:18.065847Z"
    },
    "study_group" : {
      "id" : "grp_583RFmvnxJAEnn5lIXGr7W",
      "study_id" : "sdy_dzaLWh5dEEIRKyJuKSAC2",
      "name" : "IQoXHpG6IB",
      "no" : 617097506,
      "color" : "SIGYbdVW31",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:03:18.227678Z",
      "updated_at" : "2026-05-08T16:03:18.227678Z"
    },
    "cage" : {
      "id" : "cge_7BbPRAg8qWiaWzxDzPY5R2",
      "study_id" : "sdy_dzaLWh5dEEIRKyJuKSAC2",
      "name" : "IHhS2ggTpJ",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:03:18.216593Z",
      "updated_at" : "2026-05-08T16:03:18.216593Z"
    },
    "created_at" : "2026-05-08T16:03:18.232473Z",
    "updated_at" : "2026-05-08T16:03:18.232473Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_dzaLWh5dEEIRKyJuKSAC2/animals?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_dzaLWh5dEEIRKyJuKSAC2/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_dzaLWh5dEEIRKyJuKSAC2/animals",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Terminate study animals

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_66hTdVWuNx5XrYwYis7TnY/animals/terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMDE2ODFlYy1jNzI0LTRkMmEtOTA1MS01NGQ5NDFiNDg1NmEiLCJqdGkiOiJmZTc3MzliNC0zZTFhLTQyZmUtOTExMS02YmIzMzFlNDAxZGUiLCJpYXQiOjE3NzgyNTI1OTcsIm5iZiI6MTc3ODI1MjU5NywiZXhwIjoxNzc4MzM4OTk3LCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZKMlFFejhDMnFDZVdUYU9PODE4ZlgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.lAuCkkDXKWgQELfkwjH04_CgQkLTYPqtCd1bLYrztYFNEsaCiw5tM_C2J4Kn6hsp3DU99z_6BX-M1xwkT7-hQsUZHPz8UN1UsiCAMPH4PJHFFsC0DlUdyUTZQ82ySVfCPzC4z8CZyHs50MKlvqipSy6UM2UXY-tABkPBnXauQWemlQO3cXsSpS_ey4UBpFVSI41HtLKq0g4wd8tRdhCl0crvdVNJ9LCGodY-9uYu5UmnaEPRA9_i_jaZGjTvJFwHvxgstl-OpmL_xEVm0MKDDN89bSJJdKVJ953rvMJsWWIB6koj1kVSJsg1GuYlxEesGdBZh0P25vtrEBJrPrgxfAGMQXD9ucBAGDA0OIzdTpiDzzTW3k5SircAvNW31i8oYRStL1KpNPXfkP3qwzFOFPJObrcErByBcnIF_71hcke2QJUS57kF7c2kDUFRxgMk0EPU1TLUC7APwdHHvFPnfGpBATiSOQW65h8zQl6hmrM1qrvVrFEfILkzXbkKQyTgssoHQQjP4mjdO8LQUO0cH1glukRSHPt2P4TsunWWWeH3dd5rzQtn8tZWkMcxDRqB5zy3TOHynQMAXivoYcDB78Wi5JqVUXOVXi0gk2YrgFBiVGBlG3ZhZAC-ur2RkMNuei9qq4KUynYZ4v5QPY9FQGB9A4y3mSciwi4cH8ctBu4
Content-Length: 211
Host: localhost:8080

{
  "animal_ids" : [ "aml_5M16HtCmgpI8l1OIuct8ky" ],
  "termination_reason" : "tgy_7HEFk89Y68GMvRTCDpEZhE",
  "terminated_at" : "2026-05-08",
  "disease_survivor" : false,
  "comment" : "Scheduled termination"
}

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

{
  "data" : [ {
    "id" : "aml_5M16HtCmgpI8l1OIuct8ky",
    "catalog" : "A0000001",
    "name" : "vgeZLoyc3M",
    "number" : 1,
    "strain" : "sLhp1gwwi8",
    "species" : "ytbQ3lqgOO",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "Q1haN20tNC",
    "ear" : "acYwzTCdXE",
    "tag" : "qlfxvh368d",
    "donor" : "tOn4eJpM78",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : null,
    "terminated_reason" : {
      "glossary_id" : null,
      "title" : null,
      "comment" : "Scheduled termination"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_66hTdVWuNx5XrYwYis7TnY",
      "project_id" : "pjt_3SR0ZXxobGRuir4ijW7wIE",
      "name" : "wbLCtgzK64",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1QKCaEWLWGMJH3qa8EogGe",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "ODmQLdNxw3",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2yPN0Ut8htUU2BHWxeQIlr",
        "name" : "AJofeELgen",
        "email" : "0tlXNEFE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1wQvY9ValTd0w01Nrsu3IE",
        "name" : "R0I0jVyQUo",
        "email" : "qM92zg5X@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:17.795230Z",
      "updated_at" : "2026-05-08T16:03:17.795230Z"
    },
    "study_group" : {
      "id" : "grp_3KGLUf016brIcNBpO2enR9",
      "study_id" : "sdy_66hTdVWuNx5XrYwYis7TnY",
      "name" : "p7WmpFWlwt",
      "no" : 574820002,
      "color" : "H0W1MdX13I",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:03:17.962294Z",
      "updated_at" : "2026-05-08T16:03:17.962294Z"
    },
    "cage" : null,
    "created_at" : "2026-05-08T16:03:17.968897Z",
    "updated_at" : "2026-05-08T16:03:18.011352Z"
  } ]
}

Undo terminate study animals

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.

reason_for_change

String

A reason for undoing the termination.

Request

POST /api/public/v1-beta/studies/sdy_1AirOahrMzZ1kSwu3JZNbu/animals/undo-terminate HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3OWNmNGY0Zi1kNzc2LTQwODgtYTIyNC1kOTUxN2RkZjBhMjIiLCJqdGkiOiJhOTM4OGQ2Yy03Mzk0LTRmZGUtYjI3Ni01MDA3ZmFhYmRjMmIiLCJpYXQiOjE3NzgyNTI1OTIsIm5iZiI6MTc3ODI1MjU5MiwiZXhwIjoxNzc4MzM4OTkyLCJzdWIiOiIiLCJzY29wZXMiOlsiYW5pbWFsLnVwZGF0ZSJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRORUIyalJrSHd4VVVldzd3WkxUQyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.nR90DQU4bprUN09MTCT6LjL0oRpRcBKJ6cEaK39yaFkPipkJNPW7TgQzXzfaMMqg7iWZN0_Rn9JRpBLx8BwnykzqGMV40AeyK4vkEJb_WHPnavs94A3uv2vw2xdEmk601gKwBCiKn9mYPFf9pOfUsWt8Wj07unzfbKd83_VPl4bs8quXIGNa7jmy05XuuEbRUCAl6unaSmiqFVs55tco4OReC314gcmdvbcVGTUwQlWWJ4StHS3ZtOUuuX8JOkhXb56ZJpbAtaDlbwXwY-4a0wLcvj0YAZ9Jn6Xngv2jF3KWGjC_-qunzvdUXDQazOWy_nx4fzofzc35E3J_F3PtwZEIR9EWyEZBOeZT4186qttYcllP5nQcjdaw6tSC9mv9IbdFfYQOKyhSNf3kI3JTLUPcZyiv-S2DoiJQT4HtSWp_50go2z4uFQyIWDYAMms1HCotHhF4WvYKl-m2IgvtGqjCrykX-9HbRpt4duTstJwsP6cQQFTKVqgggPMPEtpZGXl073tMK-EZARTALYYA-Axek_ufyJq1HesCRhdgOMh6UtEMdR4425JwNzwJprulm2BvjZ8pYMY9Xj4XHwrXqZBS3JxuKqg2cKKJbLaoJ0GkTYvBb2FY9hZzR2e7c6CeGeGWvViQCeckr6LCV43agJZ5k_0IGuo1xP9id6ZyFbE
Content-Length: 146
Host: localhost:8080

{
  "animal_ids" : [ "aml_5bPGTlsENIoYd1i1qd4z7s" ],
  "cage_id" : "cge_1FMIgKlm0ztj7g0SQYTBcU",
  "reason_for_change" : "Reverting termination"
}

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

{
  "data" : [ {
    "id" : "aml_5bPGTlsENIoYd1i1qd4z7s",
    "catalog" : "A0000001",
    "name" : "SQVyiu04Wm",
    "number" : 1,
    "strain" : "N8oT1rSKft",
    "species" : "o3LJYgKF2d",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "oQEVRfZv7n",
    "ear" : "xoRyC5t0gY",
    "tag" : "TBm2xUnEbk",
    "donor" : "YlFFUPcvJw",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_1AirOahrMzZ1kSwu3JZNbu",
      "project_id" : "pjt_5Qjza7pp7Anj0XQNIb2lQh",
      "name" : "1lAUVD1A65",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1Xsakg2YLE0FoE0H7MnIp9",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "hOUyGHAHU1",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_SCU3SlWEHcobfMiqvaBea",
        "name" : "j9Mgo0PGtg",
        "email" : "0vBmMBSA@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_FFkee398BW5ETqPOnaMuY",
        "name" : "Xyq8XUwmDR",
        "email" : "i4txD54E@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:12.490505Z",
      "updated_at" : "2026-05-08T16:03:12.490505Z"
    },
    "study_group" : {
      "id" : "grp_11LhJTUbE1y5OAYUtsk7oX",
      "study_id" : "sdy_1AirOahrMzZ1kSwu3JZNbu",
      "name" : "Yehjs3DSwp",
      "no" : 1327761964,
      "color" : "lyft6q1A6I",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:03:12.702364Z",
      "updated_at" : "2026-05-08T16:03:12.702364Z"
    },
    "cage" : {
      "id" : "cge_1FMIgKlm0ztj7g0SQYTBcU",
      "study_id" : "sdy_1AirOahrMzZ1kSwu3JZNbu",
      "name" : "3V4KpsvBD3",
      "catalog" : "C0000002",
      "metadata" : null,
      "created_at" : "2026-05-08T16:03:12.722347Z",
      "updated_at" : "2026-05-08T16:03:12.722347Z"
    },
    "created_at" : "2026-05-08T16:03:12.710680Z",
    "updated_at" : "2026-05-08T16:03:12.970343Z"
  } ]
}

Study Animal 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_18GsgtC5Vaj90ByAJRQV80/animals/aml_3tp7O6VxSdg5m3bDpt4Oyb/dosages/dsg_9fgCAT3zG7v4HbmK9drGh HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiYjM1N2JjZS0zMmNmLTQ0OGMtOTYzZS01NjRhMzI0OWQwNTEiLCJqdGkiOiI3NGNiNjRiNC1kMWRlLTQzNjUtYTkwNi02OGVmZTkyM2NlMWEiLCJpYXQiOjE3NzgyNTI2MDcsIm5iZiI6MTc3ODI1MjYwNywiZXhwIjoxNzc4MzM5MDA3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzUySjF6V2lUNWRQVFNxMWNMVTY0dTQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.UWMSb-BO9obEy-K8R4XxA3isWlYbVJ_BoPhSxjl_Uzbv9SQ1sDx1NCV0HWoTgW4t4iKE-a9YF7vmLBRagFon2_wP66N6QsExUqmNysU4rNVzR9Slb16IqJFXZppaaQqYKF7lI-ttMacIexr3AvQKknqsvbNM6c9RciQHQosFxA928NYEAaYvCky2PTgmHV1XUA9-Kd-peBZoc1oMV6KXFsBu5qHfdqy-hs7-fKjuZhU5d0XjwoCDYmyYP7ECn7WGO4-SRkbqnRW2iZXlVbc62lIwU9lLcWl6vKJKJWXKLAN-gWYBQK1XlInXY1dgj-V_YdBdyPjjDmAwA4Nfm_uLX8Kpob2is7EXfjQN4U5TDNg1o2yGcuwqPX1xV-uPbK7mdTRbhFhnj3ZM5oC9AWuL3oJZG48aIqqKD3zSd1B2d9NPSDBd8oDUW2R1lFmMWJ73OILpoYK6iEynRK6CU5ywq6cYHBAwdCA1oJc2C9jilCzf-H8UJxGWjn-jWaszaNM8WKxsMauB1OVHFhaApVYl_-kPo37O1Euj1j3gdZbZWdA6Mb38FH4yYEh7tofi3YMfvZnw51d3Ze6WuwhvftscFZEKUuxK-e_flv2UsVqwhJrc0pINC7R7ypV9_xGIseg8YAkdfFzvDCeSMEhzamHIr5YPFEdJE52iqV9J_WGKjYU
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: 4624

{
  "id" : "dsg_9fgCAT3zG7v4HbmK9drGh",
  "name" : "Example dosage",
  "dosed_at" : "2026-05-08T16:03:27.269757Z",
  "comments" : "nZIVprdBFl",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "2.22",
    "display_unit" : "mg/kg",
    "display_value" : "2.22"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "11.56",
    "display_unit" : "ml/kg",
    "display_value" : "11.56"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "21.33",
    "display_unit" : "mg/ml",
    "display_value" : "21.33"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "32.63",
    "display_unit" : "µL",
    "display_value" : "32.63"
  },
  "study" : {
    "id" : "sdy_18GsgtC5Vaj90ByAJRQV80",
    "project_id" : "pjt_3LH74IcsvjBMi2X5edaR4X",
    "name" : "NNJUyUT7I4",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_38gRwlvImceaPeAVHNS4YP",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "xbfWV3Exrw",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_3eU2z9eNj7BMgisnCH0U3y",
      "name" : "piZ1UIVLMm",
      "email" : "04m7yikG@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1AIkyILZoHIiG2EVdKmJbr",
      "name" : "3rllvGjo5e",
      "email" : "ACW7awlT@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:26.998543Z",
    "updated_at" : "2026-05-08T16:03:26.998543Z"
  },
  "animal" : {
    "id" : "aml_3tp7O6VxSdg5m3bDpt4Oyb",
    "study_id" : "sdy_18GsgtC5Vaj90ByAJRQV80",
    "study_group_id" : "grp_6MLp0iR0MGDxgAtOFrO5xp",
    "cage_id" : "cge_6TSLfHP9vhjnrJQqyCvIJU",
    "catalog" : "A0000001",
    "name" : "lPV5o5WgHu",
    "number" : 1,
    "strain" : "57tsQJZR62",
    "species" : "lXs6cMGAEq",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "ZsixvYrcbF",
    "ear" : "2FIzBvrp98",
    "tag" : "LnuA26lNdN",
    "donor" : "xjgz8irc2x",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_52gHHgoSJH2i2TFs5TZzgT",
      "name" : "pk6tto4SKE",
      "email" : "KI7nhegK@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7QwUCqIJXwmceHchfUE4Fu",
      "title" : "Found dead",
      "comment" : "QPx0j3rEeO"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:27.158504Z",
    "updated_at" : "2026-05-08T16:03:27.158504Z",
    "disease_induction_date" : "2026-05-08"
  },
  "measurement" : {
    "id" : "mst_7B46YbUfsoSxM9wLotJvSw",
    "study_id" : "sdy_18GsgtC5Vaj90ByAJRQV80",
    "animal_id" : "aml_3tp7O6VxSdg5m3bDpt4Oyb",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_24Zconebko3aOcwKicuqWa",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "created_at" : "2026-05-08T16:03:27.250176Z",
    "updated_at" : "2026-05-08T16:03:27.250176Z"
  },
  "user" : {
    "id" : "usr_6D60O7QD8R9G8f0M672T49",
    "name" : "JsgfU Overwatch",
    "email" : "DtwOA2Zc@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:26.979958Z",
    "updated_at" : "2026-05-08T16:03:26.979958Z"
  },
  "treatment" : {
    "id" : "tmt_4pvtxuwAz188WzbkcFFz6o",
    "study_id" : "sdy_18GsgtC5Vaj90ByAJRQV80",
    "type" : "volume",
    "name" : "7hB1xXLYTQ",
    "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-05-08T16:03:27.258719Z",
    "updated_at" : "2026-05-08T16:03:27.258719Z",
    "external_entity_id" : "5eRijTpcRE"
  },
  "created_at" : "2026-05-08T16:03:27.269772Z",
  "updated_at" : "2026-05-08T16:03:27.269772Z"
}

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_2DIZoWO1u1nHaUEBPbPLd9/animals/aml_2YQ1UECEjYlOIWJliNYhe7/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMjA3ZGJkOC0wMWYxLTQ3ODgtODI2Zi00YjI1NmZhM2YyODEiLCJqdGkiOiIzOTYyMDkyMS1hM2MyLTQyZGItYWQ5Mi0wOWI4NTc0NGY5YWUiLCJpYXQiOjE3NzgyNTI2MDgsIm5iZiI6MTc3ODI1MjYwOCwiZXhwIjoxNzc4MzM5MDA4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzY3RTkxVnBsdFZwVWdmUDR0OERGcm4iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.edTe7yW5H1O1VQndImyUiAfw4WniWQSBSIdtMF9VP50u-yiQJeB3Tfiqf-kkZk0MVgy-a0vuP1fW-HjZB1fPKbtVJ5eYy_F6bPNOaR35Y0q-B88hegsmDCNLZZSslxu9KcsgXQb6Sq_k8YxUbfX6mj6VUeVuNorIWpDODGa78Rf-YMkcO8tSNN2HObTALPCbN7eHvijj2mPK4B0WQMe7CInHKVj9rjRYkRF0U68BOlQtGY29gEDikcCuueafsdAz_dky0qCUngd-n8jJU7PqtV-Ow7nKh4NWDaVcaYqk_tEiqXGxR0aMhxD6GaL8lYYp013HoJSsEFIobpr_z_5hrbzn0c2VgitIIefdfuk4q6B9vxc-locjL_B2lTgrQ9BCzMOk4S0mFhCosB8e2qituEct6V-0mRj8OpcjsTS95VI8vEOjHwpq1exhDPNKNOG5k6WAbRunNCa4tcw8sI-7jM9YX9qFgUoKetgAJAK_z69w4Aa0AozOxLv52m9eMSjQP79qISKbu_iFGzuwS7aJlI3Vwi2QWj-xtLJu0qCHyw4niJgRtSPmvKnXAgR8WaZL60QuTKox6jcXgNx7FYM_ULeCPJO7ghEGz-Y0IgnMbXyt8FdLBbNJtT4WBYcltGBu_JaP5y3DKXRwUE25ZHi3DEZDa_OaeZpY3glNCQ_qDxc
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: 5568

{
  "data" : [ {
    "id" : "dsg_4FkR0pO8DHYz5jh6AcgfeM",
    "name" : "Example dosage",
    "dosed_at" : "2026-05-08T16:03:28.628055Z",
    "comments" : "jOeeBuAaen",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "5.18",
      "display_unit" : "mg/kg",
      "display_value" : "5.18"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "12.36",
      "display_unit" : "ml/kg",
      "display_value" : "12.36"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "24.23",
      "display_unit" : "mg/ml",
      "display_value" : "24.23"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "33.22",
      "display_unit" : "µL",
      "display_value" : "33.22"
    },
    "study" : {
      "id" : "sdy_2DIZoWO1u1nHaUEBPbPLd9",
      "project_id" : "pjt_5ADRuHEIXgjlNQlkEMvZ7Z",
      "name" : "cdi1TLIylV",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3Pz1iLDpwJEQl6P0WekmFR",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "8SPZCemPjt",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5USYDFdRJl9g0hhnxyGEf1",
        "name" : "2Aomp9vVj6",
        "email" : "Am0ScwkC@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4BFKc7n8Q50gmqcWO30tAe",
        "name" : "kMWEmq03pz",
        "email" : "02cOw32L@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:28.317653Z",
      "updated_at" : "2026-05-08T16:03:28.317653Z"
    },
    "animal" : {
      "id" : "aml_2YQ1UECEjYlOIWJliNYhe7",
      "study_id" : "sdy_2DIZoWO1u1nHaUEBPbPLd9",
      "study_group_id" : "grp_3A9DIcdAiQBv0epkThULXf",
      "cage_id" : "cge_6fonYmo1N2rkEcMBlcALSS",
      "catalog" : "A0000001",
      "name" : "5s1LJouCZP",
      "number" : 1,
      "strain" : "pzxhGQgZZW",
      "species" : "TjAoHaZVse",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "84Rspzvezc",
      "ear" : "MTHh1ubrNP",
      "tag" : "9Vh2zilutS",
      "donor" : "ddiHWBheNW",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_1oKCH56AABaKQ7K5Vza8Lm",
        "name" : "iFE9K8g1jX",
        "email" : "TDNKTQ42@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_o4R89Yh2ZS8diQB0qeFjx",
        "title" : "Found dead",
        "comment" : "Rzrl8vai52"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:28.481774Z",
      "updated_at" : "2026-05-08T16:03:28.481774Z",
      "disease_induction_date" : "2026-05-08"
    },
    "measurement" : {
      "id" : "mst_6szdtUPpxZ54NYTMKVzjLw",
      "study_id" : "sdy_2DIZoWO1u1nHaUEBPbPLd9",
      "animal_id" : "aml_2YQ1UECEjYlOIWJliNYhe7",
      "measured_at" : "2026-05-08",
      "calculations" : [ {
        "id" : "vbl_1ecVRMi46jmB9s86341c7j",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ ]
      } ],
      "created_at" : "2026-05-08T16:03:28.561685Z",
      "updated_at" : "2026-05-08T16:03:28.561685Z"
    },
    "user" : {
      "id" : "usr_5uIbtSrPrRVUDSLeHcX33w",
      "name" : "Hz8nw Overwatch",
      "email" : "ZyF9PlbL@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:28.296884Z",
      "updated_at" : "2026-05-08T16:03:28.296884Z"
    },
    "treatment" : {
      "id" : "tmt_1hyoyQJwP3l4254kMtkCSn",
      "study_id" : "sdy_2DIZoWO1u1nHaUEBPbPLd9",
      "type" : "volume",
      "name" : "pyZa4NAy7W",
      "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-05-08T16:03:28.600623Z",
      "updated_at" : "2026-05-08T16:03:28.600623Z",
      "external_entity_id" : "ZdFb6l9jIe"
    },
    "created_at" : "2026-05-08T16:03:28.628072Z",
    "updated_at" : "2026-05-08T16:03:28.628072Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_2DIZoWO1u1nHaUEBPbPLd9/animals/aml_2YQ1UECEjYlOIWJliNYhe7/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_2DIZoWO1u1nHaUEBPbPLd9/animals/aml_2YQ1UECEjYlOIWJliNYhe7/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_2DIZoWO1u1nHaUEBPbPLd9/animals/aml_2YQ1UECEjYlOIWJliNYhe7/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Animal Measurement

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_7DHRJ1KcbMYOhAIVf7oYap/animals/aml_5SgH21z1mUFbGd3Jhaf8F9/measurements/mst_7kIZFJTBBl36LYRATQVIWT HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NGYwNjE1NS00NWU2LTQ3NzUtYjgzNi01ZGM1MDRjMjc5NzIiLCJqdGkiOiIxZTQzNzIyYy1mMmI3LTQxOTMtODI2NC1kOWVlMjU0YWY0MGUiLCJpYXQiOjE3NzgyNTI2MTksIm5iZiI6MTc3ODI1MjYxOSwiZXhwIjoxNzc4MzM5MDE5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3lHcnMwYkVYeXV2UVhwbDVlMkRYbyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.jvTTv-G_EBpVIDVU-yonoJgUZ5c4rO02f2oAlvmLObI_CMIxZfJV1bE8YbtxQYv2G_rfJSNVgKoVImEtv3Xpz5U2_nfKRAYM17wKmHPxI3HjU9TzzLh2oaCn-c0xdz7Fz6no2AXjFC1dMHrrAfceOrP8VQt0xc8r8S0_DVQxquGb0yrITYpVHn02XM-oNabK_Y0vqCC4bSnz-b3m83apbDM_oEGFw7F2Bv7YV9JrinPUpv0bVFU2ofc3_HQRTeGkpNIo8nYQVkaUxPX4nqi4kdD0GaCHxPvR54QwmirEFqCjm8skNaXQ5DXrzzmXMgV4SPY7e_9W2v-_df5ke1Hm0W2bj3Td6Lk1VEuGpjI9IsafKGoi4pU-yEm0rddaLO3Bse3YuZUoGJbRLn84rtT4C45sK4OXNxfQvIv6Z8UP185dimJ1bcColxez1tmEkXthKDUySvnaCvkpiailKDF8wfuNKIqx44rMRs0bIr0_PE-jXMqS_45WnP_FHw2c3eC8YlSIne-iSDjhyFO_CqukzpxtaXhNLM2x8ssCwO8xu6tgWXhjEdxBRRgv-5O0doAF_SpBCVNbT0nWJ-t09PT6_glTYQfUkLDrvP04acx8DCRM0XZ0YA_nBStottBroVRI9oG3dsYJbyTwyIZ7BwR3cjq_pvO_XX7OGi_9qIyi2yk
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: 3254

{
  "id" : "mst_7kIZFJTBBl36LYRATQVIWT",
  "measured_at" : "2026-05-08",
  "calculations" : [ {
    "id" : "vbl_7ArO93XJXZWNwS1ZMi83tX",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_3soAvGG2iGKJByGDRpHAHK",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_5vC7lAcbS58eQQr8JatTX3",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_686JqBGCk9eGfEH0bJeGsi",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ ]
  } ],
  "study" : {
    "id" : "sdy_7DHRJ1KcbMYOhAIVf7oYap",
    "project_id" : "pjt_3Uqpfhw7nySV8dMNLXp76d",
    "name" : "d2QUOUcSKu",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_flYRsVVygeGit5dp8GwYV",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "c60APekWlo",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_48biwNuRIl0A1wFAYwHooo",
      "name" : "G3ZC3EdASn",
      "email" : "WkEH6pey@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_21LnoeqeEw32tRlk4ZfmEN",
      "name" : "YkWjOBy2Ek",
      "email" : "GZ3GlDbl@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:39.208182Z",
    "updated_at" : "2026-05-08T16:03:39.208182Z"
  },
  "animal" : {
    "id" : "aml_5SgH21z1mUFbGd3Jhaf8F9",
    "study_id" : "sdy_7DHRJ1KcbMYOhAIVf7oYap",
    "study_group_id" : "grp_8g8MI1SKxw1JyflxF4brZ",
    "cage_id" : "cge_2h0HiKvrc6eA0cBfScIp7X",
    "catalog" : "A0000001",
    "name" : "rX154eLY2A",
    "number" : 1,
    "strain" : "2XPfNEiS1k",
    "species" : "WaQJnGsfMM",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "Cy93R7b74Y",
    "ear" : "XR2E1u9Yiq",
    "tag" : "YubXpOmI8C",
    "donor" : "1kQqF8b9zC",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_5xPXVZSuW6dwLGFN9ePt0Y",
      "name" : "qqhNALkYzl",
      "email" : "pg5Sx9JD@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1JXJrvlF6zBfshfmqsl2Nl",
      "title" : "Found dead",
      "comment" : "fcWrDvzI98"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:39.373120Z",
    "updated_at" : "2026-05-08T16:03:39.373120Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_2WswjcFg1xdHCxc3TUkqIK",
    "name" : "iVzQb Overwatch",
    "email" : "FJ8s3DJh@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:39.181877Z",
    "updated_at" : "2026-05-08T16:03:39.181877Z"
  },
  "created_at" : "2026-05-08T16:03:39.448379Z",
  "updated_at" : "2026-05-08T16:03:39.448379Z"
}

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_7lIhmBKdqxX8XTdqbdckvq/animals/aml_2LpO1Wn134hxxAAEH0rtic/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyMDNkNmZmMS05OTJlLTQ2NzYtYjFmNy03OGYzNmQ1ZGU0YWYiLCJqdGkiOiIzNDVjYzM4Mi1mNDk5LTRlYzQtYmIxNS04MWU0ODFhNjViM2QiLCJpYXQiOjE3NzgyNTI2MTYsIm5iZiI6MTc3ODI1MjYxNiwiZXhwIjoxNzc4MzM5MDE2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZEZU8wbkZoeDcwMWpxUWw2RE1hY0wiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.KWCNS7Nb3SFpUslhpKnT9wnqdgx5aKKC2876_WnvfiPXIEX-Mr6keiW-Ycl-RA38xZkTF4NBjlQ9dLBnHLJKFeyVQdeFPujdrVLAz5RCCKIvIBjdpUo34pk46QbZaB0qTR_Z2Ii6YzoYNvomzn0MhlxFWLGR7eWbo82YV6osQ6oniJ0lq2SZbtqUVim1zlxjli65ZTUD1ejc-M-Ee97_i1ABD0W7gzPI-baWkQxxTw06U05Jt61OVah4LxsGcc7vQEOY0wsV5vBLQxNBjqxLAQ6QxGjfh6v_r2gS1VAkfZKZuo_yJawUz78AwsTGcifKqatO0mg7bBVXRi-wjbKZblPYHMjLvTNgWqpzjNHXZ9cziGyJbZi7g3iCs3d9olkgD7_Oi6YcSlW3JFOeCZiXRKM_51CVnor1s6HquBNNs7Ewz0odrJv9MlmKsqjJoegxaxd3o1ginbRUNHaZNtF-OfR9dtnoycOGiLxd6U5P-BEWmrWdzEeJ9PYCz85hf4B44v5o0XA84PCbq7tmby38suCI80m316b3IccOT_lKz5kcVtjyI9N2dJuXYlcUqgSUosncP881PCZkxPkIP1lSuBZZ56acNb2k8VnmLiCMHzGIOvAd0HyHVE3n4w0zgcgJaZnuQ2OQ6iRIor0nsZSDW8QVUoSI5SESrsw998eg46g
Host: localhost:8080

Response

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

{
  "data" : [ {
    "id" : "mst_ENFUrGspEBUZM2eQzxdjH",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_4UBdlYi7V1eZymlIjCmcx8",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_5OYwPWxhURB88Z8VoNm9j0",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_6YafVct4CFn5lhOf3C7LRg",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_59pxahvq82fy6J5xJcpDaU",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_7lIhmBKdqxX8XTdqbdckvq",
      "project_id" : "pjt_4yv6RlDy3tK88vRSImdYYc",
      "name" : "E6K0HDOWpx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6b5K65UZcG0uyzsEDHXV5Q",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "2bO1ce1NN7",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1iQEcAAuqTa62sg0JWEEJL",
        "name" : "l4C9djVDea",
        "email" : "8QrWcSvN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4u4gMVzzUGCawL8fDQZxTi",
        "name" : "pkD6nrPzKV",
        "email" : "6FXHnI3v@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:36.158320Z",
      "updated_at" : "2026-05-08T16:03:36.158320Z"
    },
    "animal" : {
      "id" : "aml_2LpO1Wn134hxxAAEH0rtic",
      "study_id" : "sdy_7lIhmBKdqxX8XTdqbdckvq",
      "study_group_id" : "grp_4DOZ03YdZ2yIBBAS6iGy29",
      "cage_id" : "cge_2V5ydI7dbuUlfIeQKdVBOj",
      "catalog" : "A0000001",
      "name" : "9DSBCjoAVH",
      "number" : 1,
      "strain" : "Zu2LjgeI7f",
      "species" : "SVilaekiyw",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "m36wnDFQyu",
      "ear" : "ROwJwd4ju6",
      "tag" : "mFsvysdSuv",
      "donor" : "qV3bbuvQvV",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_2LSrIsX7a9iPoHw9mBIeNH",
        "name" : "ax6mONRyFU",
        "email" : "4liWeXcS@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3gXjBPibYmKgNJscaknMHd",
        "title" : "Found dead",
        "comment" : "YO0gan9vFS"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:36.316714Z",
      "updated_at" : "2026-05-08T16:03:36.316714Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_7X0dixaYPnIEMXhF2BGNl0",
      "name" : "pBpdC Overwatch",
      "email" : "FFTPy9um@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:36.137841Z",
      "updated_at" : "2026-05-08T16:03:36.137841Z"
    },
    "created_at" : "2026-05-08T16:03:36.411921Z",
    "updated_at" : "2026-05-08T16:03:36.411921Z"
  }, {
    "id" : "mst_26AfUXhvnFyVdmf1CHLzIi",
    "measured_at" : "2026-05-07",
    "calculations" : [ {
      "id" : "vbl_9HXT7VFdHyjnWmLSYVJN7",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_3lwUT08Y4tDuQOtgI4kaHf",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_6G8ZTGe6OB8CUC9ijOUWum",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_2YfJVrI4RURWorMrIEZ1ms",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_7lIhmBKdqxX8XTdqbdckvq",
      "project_id" : "pjt_4yv6RlDy3tK88vRSImdYYc",
      "name" : "E6K0HDOWpx",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6b5K65UZcG0uyzsEDHXV5Q",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "2bO1ce1NN7",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1iQEcAAuqTa62sg0JWEEJL",
        "name" : "l4C9djVDea",
        "email" : "8QrWcSvN@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_4u4gMVzzUGCawL8fDQZxTi",
        "name" : "pkD6nrPzKV",
        "email" : "6FXHnI3v@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:36.158320Z",
      "updated_at" : "2026-05-08T16:03:36.158320Z"
    },
    "animal" : {
      "id" : "aml_2LpO1Wn134hxxAAEH0rtic",
      "study_id" : "sdy_7lIhmBKdqxX8XTdqbdckvq",
      "study_group_id" : "grp_4DOZ03YdZ2yIBBAS6iGy29",
      "cage_id" : "cge_2V5ydI7dbuUlfIeQKdVBOj",
      "catalog" : "A0000001",
      "name" : "9DSBCjoAVH",
      "number" : 1,
      "strain" : "Zu2LjgeI7f",
      "species" : "SVilaekiyw",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "m36wnDFQyu",
      "ear" : "ROwJwd4ju6",
      "tag" : "mFsvysdSuv",
      "donor" : "qV3bbuvQvV",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_2LSrIsX7a9iPoHw9mBIeNH",
        "name" : "ax6mONRyFU",
        "email" : "4liWeXcS@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3gXjBPibYmKgNJscaknMHd",
        "title" : "Found dead",
        "comment" : "YO0gan9vFS"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:36.316714Z",
      "updated_at" : "2026-05-08T16:03:36.316714Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_7X0dixaYPnIEMXhF2BGNl0",
      "name" : "pBpdC Overwatch",
      "email" : "FFTPy9um@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:36.137841Z",
      "updated_at" : "2026-05-08T16:03:36.137841Z"
    },
    "created_at" : "2026-05-08T16:03:36.455728Z",
    "updated_at" : "2026-05-08T16:03:36.455728Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_7lIhmBKdqxX8XTdqbdckvq/animals/aml_2LpO1Wn134hxxAAEH0rtic/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_7lIhmBKdqxX8XTdqbdckvq/animals/aml_2LpO1Wn134hxxAAEH0rtic/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_7lIhmBKdqxX8XTdqbdckvq/animals/aml_2LpO1Wn134hxxAAEH0rtic/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.

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.

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_1xFGP6rSU8wMSdkYW9kKAr/animals/aml_1pU3iP0gaUDIFZOBPzxpd/observations/obs_7DF7QtvdoLtSstGbHlBMLL HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMDc5NWFjYy0yZTU2LTRkZTktOWUxOC04OTBiYjIzYTE4MjEiLCJqdGkiOiJhNjgwZjZlYS05YzhiLTQ4NjEtOTc2Yy1kM2EyN2ZkYjczOGQiLCJpYXQiOjE3NzgyNTI2MjksIm5iZiI6MTc3ODI1MjYyOSwiZXhwIjoxNzc4MzM5MDI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVETmVTSElab05HVElmaWVHNUZTeVMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.QGoVmHZ-I8czFN-0QzicIs9FAA0kIZ6VH-q08ZfEnqqD1lsc583hLA-LNiCWUkCgBVZdnbcasMCUWXmT485RSO4W_7-unpjDqB1g8L87d3MigxeYkMsZpFWiNIgTtcfmUmlLHQ7osPLaabiJ-VubIS9yNAlTGVGhTHE1Y7dXbXHV7AlSdGlxn83hpWRhC5_voQVYp9I4vBBYSgK09yoFqlSOtIbEzY46Tns-oebg9rla0rsplMVZNtF_YPogDL3RwMlUiMHjUQEB2DjvUdc_BhKupiXzqVTT1K4-ZdtnGtVbxjyRRnWLU4h641pHv5PqR_n374ElQYLBL9qwxjITftiJHLuWaAE9IRryrl6gV5Zpsy_dBvckT6AJ4JWcyeMjD3HAtYnPsQJqKbSYYamJMEdpgeaxST0cD3URvABwoC0DYVxbmGUWp4w3DofyzS_hIc1Sv1oGxJkea5pW5LcrG-Rhg-VsItcXJTbej-V3jEsZ0535fajo4xoTdGoFF-fUOGxiAutgl_CcvhTj9leObyaK4nkkl23K7BXsm3L2x5JF3zjx9CtdFwWiDlC2lkOIoVsY04bTkRryc0TtJsNBvVpoLjIcr5eM7nhoFjhI1LWn_km2-_WA9pGTlzyG4HkFhZPXPvFTRC4_75t_zvX4MtEL-ggbBuyoC-kZA_z6Uh0
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: 2777

{
  "id" : "obs_7DF7QtvdoLtSstGbHlBMLL",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_6fr9kC0Di9SwOiFZhUtAIT",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-05-08T16:03:49.917667Z",
  "study" : {
    "id" : "sdy_1xFGP6rSU8wMSdkYW9kKAr",
    "project_id" : "pjt_35atBMNvnaC66q6DIJ599G",
    "name" : "bBK6eDP0hX",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_72yCK2KEGqaK9BGjF1XHbI",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "WvuZGoKaHU",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_4Kk9h09Fltdl6l6nirlQkP",
      "name" : "p89F3D82nV",
      "email" : "hggxPZ0v@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1qvyoVgat9ybpbaYpStqKr",
      "name" : "5RLZTycdpJ",
      "email" : "jPX6dpYA@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:49.668081Z",
    "updated_at" : "2026-05-08T16:03:49.668081Z"
  },
  "animal" : {
    "id" : "aml_1pU3iP0gaUDIFZOBPzxpd",
    "study_id" : "sdy_1xFGP6rSU8wMSdkYW9kKAr",
    "study_group_id" : "grp_49r5Sg5vnuEa5Omsnz99pb",
    "cage_id" : "cge_1arsuWgccXG9lRO66AxT8E",
    "catalog" : "A0000001",
    "name" : "dHVo5HfkhG",
    "number" : 1,
    "strain" : "GHzMr9pWmf",
    "species" : "u8y8mQRQaG",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "wmoIc6hJwu",
    "ear" : "LGC73Y1YDr",
    "tag" : "XbjQdnZLAN",
    "donor" : "JN5gDuzIpx",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_rhHZ2cfu47tDoB5NbUqV7",
      "name" : "cQBhe777f8",
      "email" : "8NWhtoJI@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_2kqbL2fOhPNPZANQSn5gfG",
      "title" : "Found dead",
      "comment" : "ghTkGe9SjW"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:49.826523Z",
    "updated_at" : "2026-05-08T16:03:49.826523Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_4Npzx6jbE8JsKlSVsb7bb",
    "name" : "mBJCe Overwatch",
    "email" : "AphhlZns@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:49.646428Z",
    "updated_at" : "2026-05-08T16:03:49.646428Z"
  },
  "created_at" : "2026-05-08T16:03:49.917682Z",
  "updated_at" : "2026-05-08T16:03:49.917682Z"
}

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_6u94IfUsFIrOw77dxKm9Np/animals/aml_2AQgdCoMzpQOIVpfZspTEx/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZTU3ZDU2ZC0wMWFlLTQ0OTgtOWJkOS0xZGE5Mzg2MTY1YWIiLCJqdGkiOiJjNjNkYTEzYi1jNDE1LTRiMDYtOGYzOC04YWQ5NzAwYTJjZjAiLCJpYXQiOjE3NzgyNTI2MzAsIm5iZiI6MTc3ODI1MjYzMCwiZXhwIjoxNzc4MzM5MDMwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRDUkdOTEhiU3FneW9zcGdIcDNjb3AiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.ZBJR1gJn8UkUfseXKLiKS3443WjyxFkXjFTuk2TWoMcK9EwVEdKGzDwzv2jwGX3qJo_nMnP0nuAgOEZWSK7Jn8Pf3xNF4tbNCajXOJLf4V9FqWwJX2p5tdVB89yPqd36L_VHLCaoMVXczBsMcTztPQ9GO-htU9sCRR8MyFFANhcLHOV5lhLkQTsA4TlEwcg1zW0FPmQsR5EgMk8jOwuP7laMh0dESMlEo1mq417I-A2R_bwjs9K7Y4Yz4Qup1fRCGu6iHJrCK0JPjVHEqdBwk5HDZ6nU25r5zGJtV8DvGgFEGYQkpxQSAqX94PLDUPXsHHTCC5PzURNVMAFBAQO9MQi2jUJxXUqJcUJdwzRXhMG7h56TT77KCv0el0cH8Ms3fO_c4PPCb1LtkWUnZ2qm4nYcWLIswPvv8X2a5JbUFOZQfPPczwI4qjPbZmd6wHPDvXYgxgKSL3Jb2isPOSouePmKlP7dQ09AIlr6okYSOx49pzNjf4NT0D4CTEt_N5E7YanRX75mtm2QFCyUK7VCvHVgng6tbEbz-tVsXjVuUKtPkptDVuir9ahZbPLS3bn9GlsuuLvPMOqRedVNwhqJ98S0FFdLIiEq7I34DMtBqy999_0IzdTcIRbdOawxiAl-19P-ZK_-iFgCpumm4hwr3XEpxWqf8cfwg-V5zgQDOkc
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: 3589

{
  "data" : [ {
    "id" : "obs_2ui0luEFkNCsW2aoksCU3K",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_7UJuLYTNyEqRFhxGlSRoYc",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:03:50.744220Z",
    "study" : {
      "id" : "sdy_6u94IfUsFIrOw77dxKm9Np",
      "project_id" : "pjt_2grIUWY6yotnrQWJAdR9Sr",
      "name" : "Z2c2XjmlZ0",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5W2jOVpYtGpfhNuyhmdvct",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "rixIs78iti",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1ulQYtnM8TncidJi5cPZCj",
        "name" : "hUMAylViP2",
        "email" : "fzAd7Q6z@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7k2QBFB2f5QsEGe8it0q7E",
        "name" : "2mdjj47XGw",
        "email" : "lYkspGlu@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:50.508927Z",
      "updated_at" : "2026-05-08T16:03:50.508927Z"
    },
    "animal" : {
      "id" : "aml_2AQgdCoMzpQOIVpfZspTEx",
      "study_id" : "sdy_6u94IfUsFIrOw77dxKm9Np",
      "study_group_id" : "grp_1TWbzTKkA6G8ufVFZboMcF",
      "cage_id" : "cge_4MW34U76SKAD2iAEEVTquJ",
      "catalog" : "A0000001",
      "name" : "B783SMsddK",
      "number" : 1,
      "strain" : "bZX4dWSSq0",
      "species" : "DfPW39FFiv",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "rv3b6vJIlX",
      "ear" : "J1RZY7xqoL",
      "tag" : "DN8T6uCa8w",
      "donor" : "jQgh10pktI",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_6ReqhzooxRqiy9XzfmfJWp",
        "name" : "mSSLJ6ogdy",
        "email" : "9PRY3LBm@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_5p5uJIJFvoESzlF93vmIda",
        "title" : "Found dead",
        "comment" : "Yu1CA9TAfA"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:50.671596Z",
      "updated_at" : "2026-05-08T16:03:50.671596Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_3advV4c9dsHdTnDpOGuz9A",
      "name" : "LNLhw Overwatch",
      "email" : "wMjryH23@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:50.486245Z",
      "updated_at" : "2026-05-08T16:03:50.486245Z"
    },
    "created_at" : "2026-05-08T16:03:50.744247Z",
    "updated_at" : "2026-05-08T16:03:50.744247Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6u94IfUsFIrOw77dxKm9Np/animals/aml_2AQgdCoMzpQOIVpfZspTEx/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6u94IfUsFIrOw77dxKm9Np/animals/aml_2AQgdCoMzpQOIVpfZspTEx/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_6u94IfUsFIrOw77dxKm9Np/animals/aml_2AQgdCoMzpQOIVpfZspTEx/observations",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Animal Sample

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_4sU4FdkPAlZvUWOVXWuUg0/animals/aml_2em7vQEQkOwdGfM1BNVK3S/samples/spl_2DZ2UI6KkG1r3Yk1ILWwz7 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YmRiNGM3NC0wZjY1LTQ0ZWQtYWE1YS1hMjZhM2IyMjhjYzUiLCJqdGkiOiJkZjg0YjhjOC1kYTRkLTQ1ODgtYWJmZS1hNmQ5YzI2MDcxZGYiLCJpYXQiOjE3NzgyNTI2NDgsIm5iZiI6MTc3ODI1MjY0OCwiZXhwIjoxNzc4MzM5MDQ4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVxc2FLRnVCQVlPcVE2R09CbVFRSTIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.jORaRnhFQQ5gzKgQeV3HVssFGGkgVAYeBF4O3jf-I1dWCc-LEpIS9yuL7AeuixAvRbzzffr7wg0rQfUoxz4K6C9uHYCWrBYCmC-3BiQ8AwlHJuyAXUxWpCmkpZlNv7OUFUoPDmroDxH8JZeAGDeTHzpXxPE-mpt12-xKPAHSZTtkdHb_FgmG1cb7IyeKk3k-uXSV3POhRZVRTrxAyBOe5FktGA8yuL7mo69UEwuFCec3SqScnwWlf_VTpo95nAnfbbVL--Sd01RmLBPGwcIufmglRRu8j_IULFG-kyUeGyjGeXUn2rFRzBk8IkD8WqXoMrsG20sfHOzPdVLVkYULxpGCJOQ8kPiDvhQ0gJHd-lyLIdK6oHu4IHWX_3btEVWTBghw4D3U9BT935Cq39srKowu8q25pgSnaw_K8YOBItEkCjgnsWI1UM47ytcRpjQKbs2zgF4CSe7_-FHAI8TgBKDDTaNuE9P_izpOKldIq52H5LUwbRy9Su4tH6a7OScGjxN06rQ-vp8glld9aBE0HjSa1pT5lo5YlWcNyyRRjNDAGBavJYy-qbefmr8UYBwNMXgL5DC5pthfggV2YAY-SW-nGbDAigvOdiGUcslBF3YQEnHnsg_IbwY4FFD5InZqqBiS4TBsJ58xKuomCnN3SqPTV8O99S1qY9aaNrLWP3k
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: 2929

{
  "id" : "spl_2DZ2UI6KkG1r3Yk1ILWwz7",
  "sample_id" : "S454763220",
  "sample_definition_id" : "sdf_3wi5Xyu0ht4Dk4cJ12ADZO",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-05-08T18:04:08.806501Z",
  "details" : [ {
    "key" : "volume",
    "unit" : "ml",
    "value" : "5"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-543102519" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_4sU4FdkPAlZvUWOVXWuUg0",
    "project_id" : "pjt_g77r7Z8tnoyESjNJQSfYO",
    "name" : "ABEkhBKv25",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5eNnNzYZzeh1X8mvMIW9p3",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "eWMRz3Qajv",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_52EfkpQD6zhh7CIrNOUwtp",
      "name" : "EJU9tmkfpb",
      "email" : "BuOi7W2X@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_OiXanXxZaABerfiW2vXqp",
      "name" : "VqMDGGcz4a",
      "email" : "hy90DPr7@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:08.493805Z",
    "updated_at" : "2026-05-08T16:04:08.493805Z"
  },
  "animal" : {
    "id" : "aml_2em7vQEQkOwdGfM1BNVK3S",
    "study_id" : "sdy_4sU4FdkPAlZvUWOVXWuUg0",
    "study_group_id" : "grp_2DAHIrfW4NVItEBMofV0xC",
    "cage_id" : "cge_7PQw04XElTMi7Cvq8w8FjO",
    "catalog" : "A0000001",
    "name" : "grt26flz5n",
    "number" : 1,
    "strain" : "6eLdK4tdSb",
    "species" : "RLOM7jmijc",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "Vj0mwXGSHO",
    "ear" : "iPJK3aoPY0",
    "tag" : "R7klhlMCaP",
    "donor" : "2rr5mq30AF",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_3rxO0vRRb4PyKL04sDz8Q8",
      "name" : "nHBL1iicet",
      "email" : "Zi7DRBZV@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5jvXUiaunYwtVJd4I7PHHO",
      "title" : "Found dead",
      "comment" : "5VzUlPq3H9"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:04:08.660866Z",
    "updated_at" : "2026-05-08T16:04:08.660866Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_7OppaCbvXp94GJG25xbFwK",
    "name" : "2G3owqLUem",
    "email" : "ppBp2UBs@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "gzXo4wx6wt" : "NAJ8T2a9Lq"
    },
    "created_at" : "2026-05-08T16:04:08.791700Z",
    "updated_at" : "2026-05-08T16:04:08.791700Z"
  },
  "created_at" : "2026-05-08T16:04:08.806576Z",
  "updated_at" : "2026-05-08T16:04:08.806576Z"
}

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_4nNETqr4Q2wfVRUe4maiWQ/animals/aml_6ZpOwCEu6P9cxhB0qtqe0B/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NGEzYTU0Ni1lNDljLTRlNzAtOWM0Ny00NDZlYzEyMmNhM2UiLCJqdGkiOiIyNjU4Y2FkMS1mOThiLTQ4NjQtYTg3OC1iYzAxMGY0NTI2YzciLCJpYXQiOjE3NzgyNTI2NTEsIm5iZiI6MTc3ODI1MjY1MSwiZXhwIjoxNzc4MzM5MDUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzM3VFRERnVqOU5SeXRiNGE0cFY4b3giLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.YfqdHg6Fdm6TU3cAoKja4o4ZKjqPcwJxuR1Ooq6VKTMpF7hJ94TPbRMDE1Xf-iFQq7jM1kok9hsiNSSqiNPZ4LUBkVl4jgL3n3Pm_FkrHOG0cAnHjqJdkJvhHYdrEx-sqaTwutkApFtqmC_pgY8AEndPDdYXOpMRiTi66mMj-Ukcq_0-8oGGhgyAfMKR3jk9tyq0SJjePYfoiuNwn7UPaw6-wWif9UBxpCxR84ZJlbDx_xUwl3hwLt1haLGbvy59kauWT4Z1vwB45Ogs0ZPLenELBaGPwEPJdkKXIh3ldm3-K-rGUcfBnYA2Ly2Dh0yPge8b9lr_v1Vy9999webwHMYrlC3979PuPZsDEK0N-ycFeEGS9fziRzwPEEuo8vqK8-jPhgJp2843jhM-v3rqjnJqeAuuX71TEA6zED2JnyCG0QZ7H-FnSQ0ArG9P6GiUXwvyWgAZPVyXPMNzUcNVsa9jPH5LVyUNGn0g4pdE5cgBG3wJaT2yd_gsweHoHc2IJITMr9PvVfxG1zCdx5Q80PIWuu4HQOxyxXuRLvWH-yZ-kiqoe2t1w4WKqmP5MOevtzVkpUtymtfIWSTNIN5LLbgjyQXnBBnrsZNmwXUwh6U7FABH-8od-AgrpayNh6I7pZlCzgmogi3EBXyEprGNngYjfeeeHRmldyelOkwa9uQ
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: 3741

{
  "data" : [ {
    "id" : "spl_4R3GQbHN2G2ldl4RLGUMtx",
    "sample_id" : "S1507973088",
    "sample_definition_id" : "sdf_1K9uLTlYRvz1bidTv6ad2p",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:04:11.898570Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-112502423" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_4nNETqr4Q2wfVRUe4maiWQ",
      "project_id" : "pjt_1RoIswz12xWIeVdlKoEFdF",
      "name" : "diwixGs78M",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_qv6CHS6tQWNV6ZNoEu6WF",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "1ZaVaq5yG8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_49KiUjsxSuzACnZfLpVWK7",
        "name" : "GHD1HJsogH",
        "email" : "J1espZMh@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6EQAvPa6YhdKbXiIdEdDUD",
        "name" : "mdujeYF1y2",
        "email" : "0pkpPhdZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:11.511799Z",
      "updated_at" : "2026-05-08T16:04:11.511799Z"
    },
    "animal" : {
      "id" : "aml_6ZpOwCEu6P9cxhB0qtqe0B",
      "study_id" : "sdy_4nNETqr4Q2wfVRUe4maiWQ",
      "study_group_id" : "grp_64JpPvopckdXPDWZcNLpxt",
      "cage_id" : "cge_168myehI3w8KtTi91hKUoT",
      "catalog" : "A0000001",
      "name" : "pQYtqgf2mF",
      "number" : 1,
      "strain" : "3vfEfRKLvf",
      "species" : "mGOo1zMMlV",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "rbpk9qZLEX",
      "ear" : "zuHuDFOvWe",
      "tag" : "BiKjA64nTU",
      "donor" : "ffaXtBIAqg",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_7P0o2D9TabaTsA2Oq2WW9w",
        "name" : "xCvWwLWUqO",
        "email" : "kZr9KFom@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_75r3E7MlaZ3zUkEHcwlID9",
        "title" : "Found dead",
        "comment" : "Y5ZI2zOgRw"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:04:11.752007Z",
      "updated_at" : "2026-05-08T16:04:11.752007Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_6ShXmu8eyzMq7H97qE6u0h",
      "name" : "fMQSpoBERn",
      "email" : "if2r7vJZ@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "RRaw28u7YQ" : "GF9lVXOTFN"
      },
      "created_at" : "2026-05-08T16:04:11.884756Z",
      "updated_at" : "2026-05-08T16:04:11.884756Z"
    },
    "created_at" : "2026-05-08T16:04:11.898654Z",
    "updated_at" : "2026-05-08T16:04:11.898654Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_4nNETqr4Q2wfVRUe4maiWQ/animals/aml_6ZpOwCEu6P9cxhB0qtqe0B/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_4nNETqr4Q2wfVRUe4maiWQ/animals/aml_6ZpOwCEu6P9cxhB0qtqe0B/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_4nNETqr4Q2wfVRUe4maiWQ/animals/aml_6ZpOwCEu6P9cxhB0qtqe0B/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_9rw1X9lMNQcCoGY2SQYTA/groups/grp_6KIykgY1wBujsjSkYVWafP HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNTIzY2Y4MS1lNWY5LTQzNDYtYjhhYi0wYzdlNDg0YzNjZWUiLCJqdGkiOiJjODY4ODhmZi0wZWRiLTRjODAtOTljMC0wNWFkYzUwNWE5YjMiLCJpYXQiOjE3NzgyNTI2NjUsIm5iZiI6MTc3ODI1MjY2NSwiZXhwIjoxNzc4MzM5MDY1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZkZzl3OGg3ZHlteVMwS25VSkdkU3oiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.NNyNjkcAAau_9CjP5qgMN_IQCPXy6s32ut6RfoecLA2l1nsqChVolSgb0hV258hMps7mI2Gi76ujp1UwlYZfQ_KhsCnJwXfL8pqbZqvHo9QxdpsDQFO26TkpgoXypOJWzkNKFjhqJnYzrEF-araiwTh0mJ6Ei-i8X52O_NpSrbEIX5cLroo0fUYqa5Cie9yTe0bGEResVJafagPK0yLnhiQYYws-mNScaHjpVOcsZ4871EHreSbaanyKGgANK3o-zb417zaTwHSsK3y05KZCFR9pIdobddW9k27LYYRbayGCtbhQ6pkAHtnqlUQgwXXRNrnCnhL29-onJnek0J4so3EtT3NGu_nrLILMuo7W0Q_uwDEo2q2OS-6o9hhky-G1icmdeQwAHkdH_0pwcDi4o3SyU33-qOIsTQ_h-Z6z9_3MA0mSmakxfOYxeusdYwRAdItDbRpWFjTiQWC513CtlCAkL-b2gmcnUKCIBcPGa4KjgkgciSwCCUiNWQxX3ifLDKfwyY9FT3KbXug0icRP8CR-V2iZYlhmSS-PBHiuVAWWsvLDpwcSXeNwUN7vKHTWf0KCaBrEVPAjFJU-LvXBxe3R8SyyB6IqYZ_e113gGlo1vgHkOnnb-n8mn_yVA2-cYCGEQoipOaSpYZWHYZWhi5cBBXB0wrWK8B2jY6cPRWc
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: 1216

{
  "id" : "grp_6KIykgY1wBujsjSkYVWafP",
  "name" : "A",
  "no" : 1,
  "color" : "#34e8eb",
  "max_animals" : 10,
  "control" : false,
  "metadata" : {
    "study-group-internal-id" : "SYSGROUP-A1"
  },
  "study" : {
    "id" : "sdy_9rw1X9lMNQcCoGY2SQYTA",
    "project_id" : "pjt_3xqfSSGl1baz8pvKxDdapj",
    "name" : "3A7G5Eh8Cw",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_E2jOgMCnAkONIJGjm4SaK",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "Dll3dYIqTj",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7g2WBYFPzmCENCNks7phWI",
      "name" : "pAcg8wBtlF",
      "email" : "NsEmveZ8@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_Tv6SmciVYP1mtVmVfpaep",
      "name" : "apUbiVJkvF",
      "email" : "s2JgkSes@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:25.744736Z",
    "updated_at" : "2026-05-08T16:04:25.744736Z"
  },
  "created_at" : "2026-05-08T16:04:25.911874Z",
  "updated_at" : "2026-05-08T16:04:25.911874Z"
}

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_7WEra5oivI0AXMM7tNWbvo/groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZThiOWYzYi1iODQxLTQwODQtOTY2ZS1hOWY3Y2YwMTdlODkiLCJqdGkiOiIyOWIyOGIwYS1kNDA3LTRmODMtYjA0NS0zNjAyZmFlMjAzZGIiLCJpYXQiOjE3NzgyNTI2NjYsIm5iZiI6MTc3ODI1MjY2NiwiZXhwIjoxNzc4MzM5MDY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVVTEtLdG55OHJiVWJKeWNMSnJQNUgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.PyRRYRV_E4wChde-azsyzJ9_F6awa-D2bC6ZIuqB1gBiZBMytSduf9h8KjghgfAcHH9vh4JkBoHD9bOBFcUEXJ6aBBuyRoByiSLo4nbi0HDlV0JAwwGBrynODbFR6rw9yXu9BzAZep0VJRd4tfnbXAt_1ecP6saVQZdKk05UhegdZPf9By2VgJiEksygrWhimCXGdmqKeedF1Lz5RB8mSifMrqTfDYdk4Xxcj0XvjnIGgmfQhBEJr3TUNL9j-nqupOVk21xAokQ3AEspF0RQWlCW8a-PLEIn8H7UivA-oS85uKneTxyJfwMTzJiSxUzLfb7Nec2PR6dBM274Gw4K5Fc2D-OTlaWwhr-u8JhcxtHK_Wg6Ht8ZJoPHigh40VrCOuzcVu-ooX2xoH7xYEB-EHuIdiY7oLZw_VZdYBfgMh1iiCfnEvPXy6Lch8Vj79Qp0a37nV95MUuKKdC8KdZAxeNT5wZdCQngBVfC4CxXVRc9pZWyktdKD7X_yDyc8QgNxyBYULNXubHw0Y7bF6zX-C51IxqziCPd6Q9JMKfAz8OzunGacVXlMuDp01mQ260lUIpOQe3qs4iHj2julb7-B2IC_dveJfdVeAbvI92lC4NXWYAHQ86a33bZwy4pDifawohX-ELMms_f2pJ7e6FdjZkbd-FohSrUAD9mjPkp3gc
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: 4418

{
  "data" : [ {
    "id" : "grp_6tJnrv3KuiwF0bpkgTWzgz",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_7WEra5oivI0AXMM7tNWbvo",
      "project_id" : "pjt_17vM9pl9eiB7NSjGrub7lQ",
      "name" : "eRIpi6tTR2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1iZCytQVSy1SltQy37Rwqm",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "joSYJ2Dspp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5o4X6Ooxil0Qr2vekm4HLm",
        "name" : "93Sz3YKF53",
        "email" : "Zn8hppwr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_X603qFeYajrLOXQFjuW85",
        "name" : "GMOPO6xrVG",
        "email" : "2pzXgum2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:26.216619Z",
      "updated_at" : "2026-05-08T16:04:26.216619Z"
    },
    "created_at" : "2026-05-08T16:04:26.360580Z",
    "updated_at" : "2026-05-08T16:04:26.360580Z"
  }, {
    "id" : "grp_7Nxf8TaOlpFKGIuy1t2C9c",
    "name" : "B",
    "no" : 2,
    "color" : "#4a7d4b",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-B3"
    },
    "study" : {
      "id" : "sdy_7WEra5oivI0AXMM7tNWbvo",
      "project_id" : "pjt_17vM9pl9eiB7NSjGrub7lQ",
      "name" : "eRIpi6tTR2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1iZCytQVSy1SltQy37Rwqm",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "joSYJ2Dspp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5o4X6Ooxil0Qr2vekm4HLm",
        "name" : "93Sz3YKF53",
        "email" : "Zn8hppwr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_X603qFeYajrLOXQFjuW85",
        "name" : "GMOPO6xrVG",
        "email" : "2pzXgum2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:26.216619Z",
      "updated_at" : "2026-05-08T16:04:26.216619Z"
    },
    "created_at" : "2026-05-08T16:04:26.367183Z",
    "updated_at" : "2026-05-08T16:04:26.367183Z"
  }, {
    "id" : "grp_5rEUMUdXgxq7c9ppYDlKdw",
    "name" : "C",
    "no" : 3,
    "color" : "#ad2f70",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-C2"
    },
    "study" : {
      "id" : "sdy_7WEra5oivI0AXMM7tNWbvo",
      "project_id" : "pjt_17vM9pl9eiB7NSjGrub7lQ",
      "name" : "eRIpi6tTR2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1iZCytQVSy1SltQy37Rwqm",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "joSYJ2Dspp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5o4X6Ooxil0Qr2vekm4HLm",
        "name" : "93Sz3YKF53",
        "email" : "Zn8hppwr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_X603qFeYajrLOXQFjuW85",
        "name" : "GMOPO6xrVG",
        "email" : "2pzXgum2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:26.216619Z",
      "updated_at" : "2026-05-08T16:04:26.216619Z"
    },
    "created_at" : "2026-05-08T16:04:26.372368Z",
    "updated_at" : "2026-05-08T16:04:26.372368Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_7WEra5oivI0AXMM7tNWbvo/groups?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_7WEra5oivI0AXMM7tNWbvo/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_7WEra5oivI0AXMM7tNWbvo/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_3mmV6ZNCZaWBade4dppwHS/groups/grp_5Rd6PiFxs7aP2kgTG8M7ks/treatments/tmt_72o3EtSsNF5xcKxp7qzPb2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5YWQ3N2QzZS0wNDY1LTQ3MzktOTgzYy0xNTdmMDg3MmJlZjQiLCJqdGkiOiIyOTY2MDA3Ni03NThmLTQ3NjQtYjhjNC04Y2JlNjBmOGRmMjkiLCJpYXQiOjE3NzgyNTI3MDksIm5iZiI6MTc3ODI1MjcwOSwiZXhwIjoxNzc4MzM5MTA5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRnMFNVUUlLbDZBbW5XeGcwYldJalMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.FuzPXjtC_Y9Dj73lU-DN2XnMI60Z3JI7gPSYNJ9jGw1lHIpZorFzlgHlu9IlH2qMb9SZQR0TTBX-YVtRi60XMXAJusvxxx8W2lqHNqdG6W9c-yBubEac8CNpKftgs0kBKSa4zOrtHzRhg-gE0KDThEJe1gGJO1KktZ6tXcvQVeIChrbfXp65h8YaeRG2g95Oq_h-JaH2P-d9z4UwsF3dycRGPDNkSlXqvLyeH8-K6_MhnpiexLlG9fEUmVoceweyDdhkqnV37Kgnesn3oxEAIHUoanBrcFSkQv45O_0qCHj_rSZbtP5GpSKqHUEYJByKc99eZL0mUZ0dR6nuKfmQeZfv5ZCs2yvvsVTnt_u1ymA2Neh3dgrFm81xpUoMhCm3-pK7i9hgiwNWf_VyrfR2A0Xz9wseVwB_br42QrFvN6vHFNGfOFlNp-79IiD1B7O3BlE93Lh0wXLIGypJff1qsRdKc2YjumUghGLthrEoZS5i_ihtVtI0_7Ynp4p4oW7LvNfOA95997uSLyq4tz6E6OjYqZIuZvM3ZqKVusyEtaqdCOmxdCezn4d7DSveAjEJt9NRkMj1sDpKkg3Joe83Sx8_1YPR7gnXJDX9dHHxgjryyEFDgRJe4IsGG4F3fCLc3IdxgB1H1tuQMkwy3O5TXNeHIFiB27oCI3wrI9nLp4g
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: 2137

{
  "id" : "tmt_72o3EtSsNF5xcKxp7qzPb2",
  "type" : "concentration_vgkg",
  "name" : "dPYm9pmZHS",
  "label" : "Test Treatment Label",
  "external_entity_id" : "wPTZSMrh0N",
  "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_3mmV6ZNCZaWBade4dppwHS",
    "project_id" : "pjt_2O2oYpqtp2kBRqxDG1p6ea",
    "name" : "vPE5kPohZB",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_6FRyxX5BBUqhLy2qCrfosC",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "CV99OxQcdM",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_dGxJ3R0fYwwlJsHzcV2GN",
      "name" : "wfF0PCkHvx",
      "email" : "nsYUDoiR@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_3nvO0LFf43hMN5KnmU8kDh",
      "name" : "3B4Qhb8uhi",
      "email" : "tAdw5fMd@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:09.742011Z",
    "updated_at" : "2026-05-08T16:05:09.742011Z"
  },
  "study_group" : {
    "id" : "grp_5Rd6PiFxs7aP2kgTG8M7ks",
    "study_id" : "sdy_3mmV6ZNCZaWBade4dppwHS",
    "name" : "Uf1Npi66UD",
    "no" : 271609429,
    "color" : "QGFGFHMNLa",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "GROUP-1234"
    },
    "created_at" : "2026-05-08T16:05:09.901116Z",
    "updated_at" : "2026-05-08T16:05:09.901116Z"
  },
  "created_at" : "2026-05-08T16:05:09.986028Z",
  "updated_at" : "2026-05-08T16:05:09.986028Z"
}

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_7UIgiRIfLhw9MFkXrnkn7V/groups/grp_4sUrcwEwOOngCbKKRr5fM8/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhODM2ZGZkYi05MzljLTQwN2EtYmNkZS0zZjhhMTBhZTk3NjkiLCJqdGkiOiIyMjJjNmQzMi1jMWM5LTRjNmYtODVmYi1jZDdlMjFlNGRmYzAiLCJpYXQiOjE3NzgyNTI3MDgsIm5iZiI6MTc3ODI1MjcwOCwiZXhwIjoxNzc4MzM5MTA4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2p3T0pjSUpYem1JSDFzSVFwVTVSQSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.Gh9ne-9t_9GUMDmV5qf8-QMRqy3fNJQ1OiYCWROd05MfihEQBbxpnvHu79GPd9bfpkgSefkE_FxhFrZVjbUq5kxLD2AKI2NDfu3Mkk8059RSahm_JtF_LdWMWWD4yk3dg3HtAJZTzI-wEmDHsOsutqsBYasipzgsg1zBcc4zdbc96D5h6ZGNjK8NpeFu27A4SquGYnbko6EIqniiN06Y9cuAEeCJsoqUt4-tM7nky5P9Z0hA78P78ULpSe0FyBRdnceBaEDV0tgSHRTyvcC2_3XwlsAJzT6SA8gCb1pvTTMf8Oos9xIpqL8v7ukdP3bBY6PVJa-x2i6OxkoNuhaBX-7886rWmguaGT3cfn_HL9rW43FvtnmUUSjtg6k0V0-ryqBS4F_yHnTKqKCX22KjzolnrpWKZ-Mc7BMjgaQP__BLYo9_NFe2kQTpwjZMCnaHcwwxTIr3CbwVnBge3zkTs13gb-6IJhK3Jc00qC4xeKL2PMEF7RHlKPcvSFt_xwp90UVt3nysD6SbwJy5lv_cc2ciBuSGts4xNkPWACfs0iAlUz8pjj_jRQnC1mvzXlN7i9ZfC7F43xrmksXF78R1_BF8AFxpi0m520GNv3Q1XdXbqTkZ6X-WTZ_dnJ_7ZGnMX__0xOxfZPISFpz8LTm8ByWVDRvuEL_Rkz4Z6ayNysk
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: 2907

{
  "data" : [ {
    "id" : "tmt_79y6zGkbaka9EsITqr2EJO",
    "type" : "dose_volume",
    "name" : "Lpcsha5qop",
    "label" : "Test Treatment Label",
    "external_entity_id" : "ZQ2hayznIr",
    "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_7UIgiRIfLhw9MFkXrnkn7V",
      "project_id" : "pjt_6gc9bPyN0D32RKe94MoZZ0",
      "name" : "ZKAf2rnq7T",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_72DOTkcQ4KGMmPJgNp9Pgq",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "BoPEMVuPV9",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_359vFupIZrnmo8ImsjaRoL",
        "name" : "zuoUYGAFKp",
        "email" : "DfBEMUSv@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_Ym7UWLyR8vlePb1YgfLaO",
        "name" : "Dm8s8isYEG",
        "email" : "pey9rq79@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:08.147583Z",
      "updated_at" : "2026-05-08T16:05:08.147583Z"
    },
    "study_group" : {
      "id" : "grp_4sUrcwEwOOngCbKKRr5fM8",
      "study_id" : "sdy_7UIgiRIfLhw9MFkXrnkn7V",
      "name" : "FovXzSZQPj",
      "no" : 1333348731,
      "color" : "3d8xxFORPc",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:05:08.314277Z",
      "updated_at" : "2026-05-08T16:05:08.314277Z"
    },
    "created_at" : "2026-05-08T16:05:08.398973Z",
    "updated_at" : "2026-05-08T16:05:08.398973Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_7UIgiRIfLhw9MFkXrnkn7V/groups/grp_4sUrcwEwOOngCbKKRr5fM8/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_7UIgiRIfLhw9MFkXrnkn7V/groups/grp_4sUrcwEwOOngCbKKRr5fM8/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_7UIgiRIfLhw9MFkXrnkn7V/groups/grp_4sUrcwEwOOngCbKKRr5fM8/treatments",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study 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_4bE3MBATTdYGN2ZsgO2CPv/dosages/dsg_4LozGWBLdk0s6RWE12y8fe HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3YWY1NmM2NC01YTY1LTQ4ZDItYTE2OS03MDkyMWY5NjliMzAiLCJqdGkiOiJlZTRiMjYzOC04Y2E4LTQ0NWUtYTBkNC01MmEyNDQwNzRkNGYiLCJpYXQiOjE3NzgyNTI2MDgsIm5iZiI6MTc3ODI1MjYwOCwiZXhwIjoxNzc4MzM5MDA4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQxR3dBYW83enlRTzBpcW5qSHhuR1EiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.VvwuTc-zJBtj_hSrpjr-gnVWZ-I9Gi9LQL8az3owrOduUI_q4dZTR9o0Dek5ppfkyRwpDdwm8vnB1yC5pk1EVKZqyBt7W9IS5WgWSrxkz7K6h3DrOh1bJxdeaIWLo21w7d1iM8CAwRI_SuRI7IlrGvUIXmKQB84tPr2iLimDCRhv2UIVBizdtyFuqvqPlON-r4v9D84G8ToeMQCkSqNMUJPZAKoGOpi7Li9h6b0xRjqGQR1ZRw1bBEmFg4EwhlJTJUBBZidCr3HodT0siugXk-fSO-hWC2Id0wrGnT7dPsFUJJMd3LJabv_wUj3vgEPzrep_rXOn8RJDpO0WMSlXGSE_dkHxiz_LJAAhgei4-uKvx9J577aqxxtYVfeDTPPLbc9I3PZVw-XepsAz2ps6iLuDZkzmAucW2hBrBe4KoqVXhVxPPGkZejd6KvyA3b194eUBNjJIMGCuuY_4-8BoIt2kvSMzgvUcSRaxWrqsJkA6BhYdp95Ma1iL4efg1SC3jKHc3uJq_Ark-UxeQ225wapHo61FDUwllxpBWJpvnNTLXefD3wxSIcXGYvoQNZvhmC-ej-7oMhTxsi6PDLfgKbiwKUx70KLiC1Utka6ng6fe5y-sSWKognYSHME1uBDQIcyJj_88oOAwqElDKeDyYVOmak_cYYjtfTWQrHfQF-E
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: 4630

{
  "id" : "dsg_4LozGWBLdk0s6RWE12y8fe",
  "name" : "Example dosage",
  "dosed_at" : "2026-05-08T16:03:28.127341Z",
  "comments" : "td1Ag5HV7z",
  "weight_at_dosing" : null,
  "dose" : {
    "unit" : "mg/kg",
    "value" : "7.45",
    "display_unit" : "mg/kg",
    "display_value" : "7.45"
  },
  "dose_volume" : {
    "unit" : "ml/kg",
    "value" : "14.29",
    "display_unit" : "ml/kg",
    "display_value" : "14.29"
  },
  "stock" : {
    "unit" : "mg/ml",
    "value" : "26.68",
    "display_unit" : "mg/ml",
    "display_value" : "26.68"
  },
  "volume" : {
    "unit" : "µL",
    "value" : "35.31",
    "display_unit" : "µL",
    "display_value" : "35.31"
  },
  "study" : {
    "id" : "sdy_4bE3MBATTdYGN2ZsgO2CPv",
    "project_id" : "pjt_3AkhObD7dN8Ep0lkyuubew",
    "name" : "bGtMjFsMWO",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2EujCCw0HeZEJnid07P4EH",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "GwJBYKzCTp",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_6J6EcBu1oaGdbZaZKl3kvn",
      "name" : "skkhPWU5Rl",
      "email" : "pzoy9yjl@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5eHKuY8mbrGgC18QvN9yJ2",
      "name" : "NPQ3R8EZV0",
      "email" : "1hx1zHYv@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:27.897309Z",
    "updated_at" : "2026-05-08T16:03:27.897309Z"
  },
  "animal" : {
    "id" : "aml_1Xri5R2LAysgYZv7ZREjmH",
    "study_id" : "sdy_4bE3MBATTdYGN2ZsgO2CPv",
    "study_group_id" : "grp_4KYImmi2h6jZ36Nna24Tje",
    "cage_id" : "cge_5DoVT9VQIsrBXIFSLlM8np",
    "catalog" : "A0000001",
    "name" : "7wS6wfcVdb",
    "number" : 1,
    "strain" : "cLSceSRisM",
    "species" : "Fy7w3q1ogD",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "8vBC5akPfo",
    "ear" : "a2imQ3W3IU",
    "tag" : "j6XONI0P6a",
    "donor" : "YQSEgDsVZM",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_5v6HlM7fqej6N5I9zuakQs",
      "name" : "6lEmw6QTwv",
      "email" : "mlixMpKe@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_68gTpUSNdBSYy8WCtXxVvJ",
      "title" : "Found dead",
      "comment" : "SzlNLd198N"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:28.047220Z",
    "updated_at" : "2026-05-08T16:03:28.047220Z",
    "disease_induction_date" : "2026-05-08"
  },
  "measurement" : {
    "id" : "mst_3Z7nCaQOEyBbjQRWmX5HaF",
    "study_id" : "sdy_4bE3MBATTdYGN2ZsgO2CPv",
    "animal_id" : "aml_1Xri5R2LAysgYZv7ZREjmH",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_7AW8N6Pw5Uz0eCoy7w4kSQ",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "created_at" : "2026-05-08T16:03:28.113197Z",
    "updated_at" : "2026-05-08T16:03:28.113197Z"
  },
  "user" : {
    "id" : "usr_7SbdI8nFmNOCPNNaveqAyu",
    "name" : "IBVv1 Overwatch",
    "email" : "zoQnZbGD@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:27.876915Z",
    "updated_at" : "2026-05-08T16:03:27.876915Z"
  },
  "treatment" : {
    "id" : "tmt_4PPuuDNNtQ0t5thwWTyFnN",
    "study_id" : "sdy_4bE3MBATTdYGN2ZsgO2CPv",
    "type" : "dose_volume",
    "name" : "NArn4NAO4c",
    "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-05-08T16:03:28.119902Z",
    "updated_at" : "2026-05-08T16:03:28.119902Z",
    "external_entity_id" : "OtJglINOQR"
  },
  "created_at" : "2026-05-08T16:03:28.127355Z",
  "updated_at" : "2026-05-08T16:03:28.127355Z"
}

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_48SCXObJEkNqJz1Kpg2cYh/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiOWE3NTNiNy1hN2I1LTQwZGQtYjUzNy0xMzZhOThkOTlkYzkiLCJqdGkiOiJkZjc4MmJjMS1lOWI0LTQwZWItYTkwOC01MDMwMzRlNTJlNjUiLCJpYXQiOjE3NzgyNTI2MDUsIm5iZiI6MTc3ODI1MjYwNSwiZXhwIjoxNzc4MzM5MDA1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNFaUtzSWJPZFZ4RTR1bHlmMUVESzEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.bBR9oGS0ZqLIx7zxImzm8KV-PQJ3R-VXmgD460Q_AS6rJvDZ4qT8AnFh8t4b07d8N1WqMocZnXxpOPE0y74IUUsNNtyqNL0fPEu1Oqp_vBGvag58dqGR0UpX0W-9yq3NQ4HWhUgYl1GJCQPb0mh83eWieiXm-gwlyoXVX55kgptQsQN2I5OcND25h-Xtx3DuL1FPTS5MsEUBfmpqbdJsIY-9-TGOBo0k0LZabcIFO1CNKnugyuP_9C8yGvLNCuWcMbJeZ0hEls26ksK6mozYRCVGDdCSR5YYgVVYpj0cxN48x2Ab3mYKFiSU0m8A6DBE5f7lt94p5D74NJRmgQS8-o_sdv9IgrVkM56ydrNqOcQ-WPkqH5ra6CCw6bbnaCIXRlao5YoIG14VP1W41p0ZCIdDNP5eqP5U9j5_F70wtK5tSUbHkwkWo0VRnoJdKjPV8gJ6yqLtG83y-WPjpuAQck0E2kQVzecYyv59LC9fCaKKRzeqfqEmIkti17cm_b9htau0tsRwF1LAlvALNHru2JVLEeMp26n_4MwvYghRdGccqdbRzHkLFubxS3ZAHFO--ZZo73oOxGEtRTDlyEZVvRQbUSkzobcdb0qTuEm5-eEUHrlCMNzKi6ekTWCfxHAn_VvHQeuA5XiJnbKdn3FfjIHMjM-s6mz8hirRd0o0bqQ
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: 5468

{
  "data" : [ {
    "id" : "dsg_7R9e5ddz5cE1eSja42397f",
    "name" : "Example dosage",
    "dosed_at" : "2026-05-08T16:03:25.558442Z",
    "comments" : "RGxJ9m5ify",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "9.40",
      "display_unit" : "mg/kg",
      "display_value" : "9.40"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "16.29",
      "display_unit" : "ml/kg",
      "display_value" : "16.29"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "23.34",
      "display_unit" : "mg/ml",
      "display_value" : "23.34"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "35.31",
      "display_unit" : "µL",
      "display_value" : "35.31"
    },
    "study" : {
      "id" : "sdy_48SCXObJEkNqJz1Kpg2cYh",
      "project_id" : "pjt_Fp9KdwEkq0v6qYioMJNFK",
      "name" : "6TTOQQ9Qt7",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_9RDpcxStd1ObwHpWAy3l",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "v5zT8b7qhT",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_h0RGsd9E4nWS2Fwbzkdjt",
        "name" : "ZIdWfLJyOb",
        "email" : "0ru6uOkx@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5ftAL4JeFJswbl3qqXkTz2",
        "name" : "R85aOiZXKJ",
        "email" : "VJcgMDl9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:25.119422Z",
      "updated_at" : "2026-05-08T16:03:25.119422Z"
    },
    "animal" : {
      "id" : "aml_3eOZ96UoZ7akQss6J6qwO",
      "study_id" : "sdy_48SCXObJEkNqJz1Kpg2cYh",
      "study_group_id" : "grp_LAxaUiYOOeABwrbBaIFX0",
      "cage_id" : "cge_4cu3AdGOBYYTnOOSQRRnJq",
      "catalog" : "A0000001",
      "name" : "K7yLoZ4ana",
      "number" : 1,
      "strain" : "mgnkCF0gnG",
      "species" : "eNAyyXEuOZ",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "W2ZnixQ8l2",
      "ear" : "8ZQCy2yvfu",
      "tag" : "y68lCmTh93",
      "donor" : "b4b2czfPWc",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_7OXW2xfDtN4qae276WKlLy",
        "name" : "FdM1i2m8DT",
        "email" : "0onOTkDy@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_fhjxOLySrD6QUJCMHuagK",
        "title" : "Found dead",
        "comment" : "O8styXorrq"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:25.352705Z",
      "updated_at" : "2026-05-08T16:03:25.352705Z",
      "disease_induction_date" : "2026-05-08"
    },
    "measurement" : {
      "id" : "mst_5rc4m4sV5hS1QZuaSqLLWm",
      "study_id" : "sdy_48SCXObJEkNqJz1Kpg2cYh",
      "animal_id" : "aml_3eOZ96UoZ7akQss6J6qwO",
      "measured_at" : "2026-05-08",
      "calculations" : [ {
        "id" : "vbl_2rIAWssU3jkM8BBZhS4wv9",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ ]
      } ],
      "created_at" : "2026-05-08T16:03:25.433861Z",
      "updated_at" : "2026-05-08T16:03:25.433861Z"
    },
    "user" : {
      "id" : "usr_6zT6HS6ozkj9beqQDLDrux",
      "name" : "5IMM0 Overwatch",
      "email" : "z7FMhCHB@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:25.097784Z",
      "updated_at" : "2026-05-08T16:03:25.097784Z"
    },
    "treatment" : {
      "id" : "tmt_2H0kkNiWaIBSRDIEG21BAb",
      "study_id" : "sdy_48SCXObJEkNqJz1Kpg2cYh",
      "type" : "concentration_vgkg",
      "name" : "qKdNucanP6",
      "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-05-08T16:03:25.542199Z",
      "updated_at" : "2026-05-08T16:03:25.542199Z",
      "external_entity_id" : "lT5gm5uooA"
    },
    "created_at" : "2026-05-08T16:03:25.558598Z",
    "updated_at" : "2026-05-08T16:03:25.558598Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_48SCXObJEkNqJz1Kpg2cYh/dosages?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_48SCXObJEkNqJz1Kpg2cYh/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_48SCXObJEkNqJz1Kpg2cYh/dosages",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Measurement

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 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_3y4vWB2pppXdOitIWegInH/measurements/mst_6x1b3RL9Vs35bEGbZFH2zI HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNzQ0NzMwYi1iZjVhLTQyNzgtOGVjYi1jOGIyZmEyN2NiNTQiLCJqdGkiOiI4YTNmOWFhZi0wNDdhLTRiZjQtODIwZS0wNjE1ZGY4NDE3ZDMiLCJpYXQiOjE3NzgyNTI2MTgsIm5iZiI6MTc3ODI1MjYxOCwiZXhwIjoxNzc4MzM5MDE4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVEejgwZ2RCbEg1S3JIbGlwR0JnT2oiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Ff9FftBh0JQaeNtZ9QIUpWDjppCmGGoD1qOAYql-kSs3bRVd5kXVU0QausNmhGLnQaN56437LjkzADgvRHl6UYHEMU653HUM8mHbtd4mpKgw6v1NpOie_-ufFkXkVWPqHo_9M6fFISQFeE2Tjv8TBRQ2i6Ajg7QUFqnWP1u8GEuGcJas9zfran-Da0ZGCOGCJm194o7au01VZM2cVQWfZDoKDNMg-gaLhHK1dVgFlYFHKEu6iqWHWle08_5Ome9Qt8NoEZc692c1p5vkp8REiqY1Tkjnx6qaJmGSvGIR5ty8SMHjxeeWfMhI1M4xOu8OtSMjU0J2LqUvPji1CPbU96n8E-16M1HmYw0n1XNstJQKDaOFycamEmuibC2w8lub50vTKyBIkpNwB_uUvXKJY9HkP7nSnnO-iHmfRe8nyLoDqqw-NfwYlSU_buE-YsfCOdtdI_1zO-YWkHq8suNO1n6CDA5_-7_dKmP9RHFgeGZBO57LaJtOjvUHyBgjk8-m5ivFrZ8lW7UyNZqqdiqccwCRPnNYB7QUBRKp7BtGk97-L3idpZ61gXZ1Y3HEq2GFBMVVAtelDbr_lPw2McjnBh4RWzQRQwmUbaxWU4sCtudnhwLhsFR77gfRTjvn8Lz23Psc6MqnZSELo2FkYbp1AYEGgH9A1W-k9qEJ3wY2kaE
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: 3254

{
  "id" : "mst_6x1b3RL9Vs35bEGbZFH2zI",
  "measured_at" : "2026-05-08",
  "calculations" : [ {
    "id" : "vbl_6H15VOcr70bNX8Frd6WjPK",
    "key" : "tumour_volume",
    "name" : "Tumour Volume",
    "unit" : "mm³",
    "excluded" : false,
    "value" : "75",
    "formula" : "(width * width * length) / 2",
    "variables" : [ {
      "id" : "vbl_7NFc5cNxPfXpbnJNh18bYg",
      "key" : "width",
      "value" : "5",
      "unit" : "mm"
    }, {
      "id" : "vbl_6yGtEhDdYzyRANOUNnH2pZ",
      "key" : "length",
      "value" : "6",
      "unit" : "mm"
    } ]
  }, {
    "id" : "vbl_6o3ZtKLJo86jIdADQ3SdBz",
    "key" : "weight",
    "name" : "Weight",
    "unit" : "g",
    "excluded" : false,
    "value" : "55",
    "formula" : "weight",
    "variables" : [ ]
  } ],
  "study" : {
    "id" : "sdy_3y4vWB2pppXdOitIWegInH",
    "project_id" : "pjt_1lW4lsZ2DrVAb0G4cLoURN",
    "name" : "4kcpXOJriH",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_42ztkAQEFaawEmLBoFME5k",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "mvoTfyY0P6",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1OvZPsvLlkpMI35cy2tU06",
      "name" : "PoREoexdUG",
      "email" : "FAmI362y@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_lxaIUyKWNvJOsGN0cpqaT",
      "name" : "zjlyAc2Ffz",
      "email" : "1U4ukn7b@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:38.391871Z",
    "updated_at" : "2026-05-08T16:03:38.391871Z"
  },
  "animal" : {
    "id" : "aml_tp3NsKMhRfhFGsFlO1nwE",
    "study_id" : "sdy_3y4vWB2pppXdOitIWegInH",
    "study_group_id" : "grp_3ktlEitSMfREh4oxtM6vnB",
    "cage_id" : "cge_56UePBJOa3WGjOwRxGdOWm",
    "catalog" : "A0000001",
    "name" : "mMprJXRsMv",
    "number" : 1,
    "strain" : "CAc5lpqkvw",
    "species" : "iYKNDubDaG",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "Nh9MNgeKDc",
    "ear" : "2SPZRyp3Ed",
    "tag" : "u2eUQB96mw",
    "donor" : "v16CHg551i",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_36Rcazy9D6DnOEWc17SUpU",
      "name" : "9T3ZL8Jphm",
      "email" : "Z26lizw4@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_7DoApOjECHtzg7ZyqK8Ki5",
      "title" : "Found dead",
      "comment" : "vsNLS0ENsI"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:38.558294Z",
    "updated_at" : "2026-05-08T16:03:38.558294Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_7EcO263rJzqr1xTc8kYoxC",
    "name" : "LaEjO Overwatch",
    "email" : "HZM7JjDx@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:38.366113Z",
    "updated_at" : "2026-05-08T16:03:38.366113Z"
  },
  "created_at" : "2026-05-08T16:03:38.656271Z",
  "updated_at" : "2026-05-08T16:03:38.656271Z"
}

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_5Br7m3OTugKLSM9isisoyF/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMTZjN2Q1My1jZDU4LTRhYTctOGM5ZC0yNjAwOTQ5YzNhMTgiLCJqdGkiOiJjOGJjNDdhMS05MWMzLTQ1YzktYjc2MS03MDBiM2QzNTBlODUiLCJpYXQiOjE3NzgyNTI2MTcsIm5iZiI6MTc3ODI1MjYxNywiZXhwIjoxNzc4MzM5MDE3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZJa1R4bDNrV3RwTWpsRGN2SnFpNHciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.UY16v6pkaafQ2CzzoRgJh09NRPBlQW3F9vTwtGW1h-x03LySJnbpKoRZuTTn4b6kw2MjgUWbdfcN6VAVXqiUOcUFzgCU1CtmZyJNEVIgoNZi-I7BQM0m7fZ65j_c7VnZzgF8EoMm7O3yGyEaUEaBVKECcertwuGWeYByoKXjiN4eWRIUdYGkd9tKxB-72LwvB9I3u2OK6-EpLWQZBMb_jEK3t1Gh3zqV82T-sWvoe23YAwfXdmy9FYKJYKMHa0tZntfTX89TDY171_fOydVGTaO4unJXSREHyHA81rasK5OzkmNmzF87diyyBogsq2M0EjtlbmXaSyHG91WhQGNcamWsTdOsa2YAdxleVCLAAIojVFdI1sV2vKCC70xy0hxHFU_rgztj3Nh0xz2awB4VHFjwPWfKH4osbpPowTXrMh8OA5a4xnU2t4z0V3s1C_9OYKvFoFj9cRHhB4dPz_IcJicLEifX_HtX77LMsD89aq-jxIJtb4PfKq8ZeQVjitKM_zyOh1YlPq7k6SAKLVCEBNXiRjnOd9dPBDoqWZ4ZyUh98JThG01y-KrvkWlKcKQwZpiW8kZ4LngLfOGRXLNdueZOWSUOQGb1HI5LD2RVecD56cVa6t2LIgm7tXWxjZnEzBvXfRmftb15QJ3430YF8XS5_L1RRU3QM6VIdirZWsQ
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: 7484

{
  "data" : [ {
    "id" : "mst_4k0nnQaMrDJ0X2JCqYO1hO",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_6jzHYhWGlqwOEu4N3zuzj",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_2zsfMJMx73vGMFKQQhhy3S",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_2KuIPvK3ZMgjKpjffhM9AT",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_3X0wjPu20u9Vdycm6JFAMz",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_5Br7m3OTugKLSM9isisoyF",
      "project_id" : "pjt_1xHtqm6ZlLNxVAO16wxZkU",
      "name" : "PEu0gxq7z7",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4MsZ6xJjUz7rkiDtgOB7s",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "O1ZQzlCpzn",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_Jx8lim8DCpLNvddIpozCw",
        "name" : "jpTZVGYjm6",
        "email" : "wdg8V9QK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6H1xOq5GkRFaokmIHEfCBF",
        "name" : "Pt97QwOiHe",
        "email" : "4PXI18Ic@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:37.071915Z",
      "updated_at" : "2026-05-08T16:03:37.071915Z"
    },
    "animal" : {
      "id" : "aml_7MpgGD5BdQzKMFMhDagzjZ",
      "study_id" : "sdy_5Br7m3OTugKLSM9isisoyF",
      "study_group_id" : "grp_5UosMurJ3SfGsJ5dujp6y8",
      "cage_id" : "cge_1LZqNzKTRRMxasIlOp8byr",
      "catalog" : "A0000001",
      "name" : "3jpG2Gm1tg",
      "number" : 1,
      "strain" : "5pwNS6FfOx",
      "species" : "xTvTH5aOMd",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "scyjm0pxfF",
      "ear" : "LAC5U9qEVu",
      "tag" : "KpELAhZfio",
      "donor" : "vxDkhyfaPa",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_1TQmNp0Jz0JySKObzcXpcz",
        "name" : "H5vG5SYblL",
        "email" : "kOoDm5lE@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3aCxERrk7tygvKu3bILl04",
        "title" : "Found dead",
        "comment" : "WVqJ2nluKp"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:37.224188Z",
      "updated_at" : "2026-05-08T16:03:37.224188Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_Vd33ekw5MxuGysBz0qJoG",
      "name" : "7rguo Overwatch",
      "email" : "nENuHU87@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:37.055106Z",
      "updated_at" : "2026-05-08T16:03:37.055106Z"
    },
    "created_at" : "2026-05-08T16:03:37.289883Z",
    "updated_at" : "2026-05-08T16:03:37.289883Z"
  }, {
    "id" : "mst_3hunHRhTPOZtSYu81asPwV",
    "measured_at" : "2026-05-07",
    "calculations" : [ {
      "id" : "vbl_2m57XE5157r6vemy4j7MIX",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "196",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_22vY8SIpdpGje6KsCEkHC7",
        "key" : "width",
        "value" : "7",
        "unit" : "mm"
      }, {
        "id" : "vbl_6XrcGuNKLbHTz59gXtD7A7",
        "key" : "length",
        "value" : "8",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_631I0VsD5fC4qhFIsIo8wV",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "56",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_5Br7m3OTugKLSM9isisoyF",
      "project_id" : "pjt_1xHtqm6ZlLNxVAO16wxZkU",
      "name" : "PEu0gxq7z7",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4MsZ6xJjUz7rkiDtgOB7s",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "O1ZQzlCpzn",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_Jx8lim8DCpLNvddIpozCw",
        "name" : "jpTZVGYjm6",
        "email" : "wdg8V9QK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6H1xOq5GkRFaokmIHEfCBF",
        "name" : "Pt97QwOiHe",
        "email" : "4PXI18Ic@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:37.071915Z",
      "updated_at" : "2026-05-08T16:03:37.071915Z"
    },
    "animal" : {
      "id" : "aml_7MpgGD5BdQzKMFMhDagzjZ",
      "study_id" : "sdy_5Br7m3OTugKLSM9isisoyF",
      "study_group_id" : "grp_5UosMurJ3SfGsJ5dujp6y8",
      "cage_id" : "cge_1LZqNzKTRRMxasIlOp8byr",
      "catalog" : "A0000001",
      "name" : "3jpG2Gm1tg",
      "number" : 1,
      "strain" : "5pwNS6FfOx",
      "species" : "xTvTH5aOMd",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "scyjm0pxfF",
      "ear" : "LAC5U9qEVu",
      "tag" : "KpELAhZfio",
      "donor" : "vxDkhyfaPa",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_1TQmNp0Jz0JySKObzcXpcz",
        "name" : "H5vG5SYblL",
        "email" : "kOoDm5lE@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3aCxERrk7tygvKu3bILl04",
        "title" : "Found dead",
        "comment" : "WVqJ2nluKp"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:37.224188Z",
      "updated_at" : "2026-05-08T16:03:37.224188Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_Vd33ekw5MxuGysBz0qJoG",
      "name" : "7rguo Overwatch",
      "email" : "nENuHU87@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:37.055106Z",
      "updated_at" : "2026-05-08T16:03:37.055106Z"
    },
    "created_at" : "2026-05-08T16:03:37.295363Z",
    "updated_at" : "2026-05-08T16:03:37.295363Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_5Br7m3OTugKLSM9isisoyF/measurements?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_5Br7m3OTugKLSM9isisoyF/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_5Br7m3OTugKLSM9isisoyF/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.

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.

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 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_1RJo8eWPJLwNuuQHmnsvtM/observations/obs_17bnjcYRCZONudHRd0pwe9 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4NDY5OWJmNS1lNWRjLTRiMmMtYTgzZS1jMDRlZTBhNWY1NWYiLCJqdGkiOiI4NzNhOGViNy0yZGI0LTRiNGQtOTQyNS02NzkxZDYyYTA0NjIiLCJpYXQiOjE3NzgyNTI2MjgsIm5iZiI6MTc3ODI1MjYyOCwiZXhwIjoxNzc4MzM5MDI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzYwaVJQUm1ZbHl0dFFkaVBsVUVLWGgiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.FO0kw4-KC_t0wbycGWzk0wMFqWLrKrQykPU625FOeRg5sbJvtjB5VSDmDvD56lbC2wvepyQPKfXkipgDu5Sc_cj--D6uAxJ74svsbdmaj9PzXz5a8xatSAa-V4_Lqds10XWtno2VdrIn2lx4s6dbWjJeifHC5FGcN6HguIh9Qw7x1d6G9SbEJ9fp7Og7js4jxbIyqffLWyluLu-slqt3oqt43i_FudClxNrLdNj4QF8UNDniD2HIawOPQKnyFOdReMUHC-HA1XsuSfH-7P-TsDVmdtmdZxat4qx-cp9IWO1eHCw-S8At8x6ZrzQMUQUczYH2VAh53RJq2Vma4RNLpz9E6YGPsLFqTZiPKKyHhTKPVa0VszDrYH6R0b6pYbZmEiE8JepvlBfWZOM3cXtqUiIZ_b155dVFfxdEr_TwECNahGPd_evI4h0hYHhTqX2fm38CvFl1gnJ_VZnKmvcnhzFmt2-CTJaRW7b1RUSIUCs6FFxMZjMfqIMB0N7F1h_1hf_r59Y15x34SCqzAWLxVbsMbpOFQDjXySgpnFVt2GWPSUWHV3FZaVs-KRR-ipZZpYrq2Oa4QC5vooGK0hxPX5SAxCZMc12GhwD_UIGxrrqvEiBq1GzD8qkiOeI58J1HFRl0HiiA8W-9Ygno8qxONAD6XLdsZyv4x7Tp7zzcYEg
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: 2779

{
  "id" : "obs_17bnjcYRCZONudHRd0pwe9",
  "glossary_id" : null,
  "team_glossary_api_id" : "tgy_70qGP6AokBuIPdIeB0AWUt",
  "title" : "Observation Glossary",
  "label" : null,
  "text" : "Example text",
  "type" : "severity",
  "value" : "Severe",
  "observed_at" : "2026-05-08T16:03:48.618154Z",
  "study" : {
    "id" : "sdy_1RJo8eWPJLwNuuQHmnsvtM",
    "project_id" : "pjt_4gRJYjCdLmaqPfc6RZh6s4",
    "name" : "sKLxpxRRUH",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_qAZimVSt8tey66H6VEZEH",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "EhWygpeB43",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_1udv645Dlr42jwqs9A8AZw",
      "name" : "rLVeCfx0hm",
      "email" : "dwWMXEZn@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_742jyPLgqZmXWsGZQMcbiI",
      "name" : "7gYJXLeNBx",
      "email" : "hpWsQ3qZ@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:48.357762Z",
    "updated_at" : "2026-05-08T16:03:48.357762Z"
  },
  "animal" : {
    "id" : "aml_6Ao00fOr53DqD3x3gEmD5z",
    "study_id" : "sdy_1RJo8eWPJLwNuuQHmnsvtM",
    "study_group_id" : "grp_4juGNINnqHKThkdrZ4XNOF",
    "cage_id" : "cge_5wRHE2OaUa7rSOyi0tmg4U",
    "catalog" : "A0000001",
    "name" : "ufvZw2cTw5",
    "number" : 1,
    "strain" : "XQ4Pv8xj5r",
    "species" : "xXRR7iEYSt",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "0KDqClLtaK",
    "ear" : "2rufDeu0l6",
    "tag" : "dgHR3ahpwI",
    "donor" : "uF3awdFFCG",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_7OX2BX9ci2s2Jf9nsMy9mn",
      "name" : "jRhEOyoh8T",
      "email" : "gEkg5qQC@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_1f00nGdYbffgQ6kRexeRJl",
      "title" : "Found dead",
      "comment" : "P9aws6iMtP"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:03:48.530058Z",
    "updated_at" : "2026-05-08T16:03:48.530058Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_28KJOBWEYEo7IOyi5u1kFY",
    "name" : "4MicW Overwatch",
    "email" : "q9RjHtnl@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:03:48.333224Z",
    "updated_at" : "2026-05-08T16:03:48.333224Z"
  },
  "created_at" : "2026-05-08T16:03:48.618169Z",
  "updated_at" : "2026-05-08T16:03:48.618169Z"
}

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_4Mu4F4yCgZLNP4hU2hElQW/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1ODBkNTk4OS1jZDI0LTQxODctYTBmNS1lZDY2OTgxNWI4NGQiLCJqdGkiOiI1ODMxMGQxYi02NDdjLTQ3ZTYtODkyOS0zNWMxOTcyYzU5ZjkiLCJpYXQiOjE3NzgyNTI2MzEsIm5iZiI6MTc3ODI1MjYzMSwiZXhwIjoxNzc4MzM5MDMxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRPNndtSHNGWlpQTVZ4d3RYc1J5ZnAiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.nBQS0CzxNCgWzx6eZHOy5NVhoVY3tNU56Kae71P8-ZNhlkNV-vV4EauIx9eK5Wl0RUT1DiQ7RtJaYqmhaKENTY7l1QdHQa2saKhCE1rhsBDu9JbfAaoR-F6zS96ETzZT5jcdTiYfn7OBBXgIIOMrG1MmVrO8vIA-sETACxU-Ca5iVLa-uylxm-ORCas5SE-Y4gkLAAksgS1dvFtYE20hqYEgSdZkZw3q4JdPgTfSyPyqM5NbMf5kKoinV2rvFpskgIiHCm35EueaYBhWNgB29jPhuVSzg6bSZSCOEbAzH7oxWdeB7WtP4Pi5ltZnaHXpfqC-AiWcKwX2LbcqaMq_J9qEvkapWMz14QxilILBYF6MMB7ism8tb8ofp9gav1msCk1H1s-d40A50xmraoZXiGR_8sU9Cclv0jcMmSuPxF4uua-B2qEIOWHt_ork-9sWWEWuwzNz46tMnjgcnhzcFpyxwNEw8RK8rCDHojUokq1dMyY9LIQfby1izUMATWwcUwq5LDzjuFA1r476sfhbunH0cvgwMwMQDTtGcDxkuJrSw5SCxgT9_NDEpnVywwnoyJAIpzDg1Tad_qTLAPGNeaKe6AiEHqxy9h9b67LKJpOYELMyx_rxoacPpoeULBQ13K4Cf1NqDXQCCK8um8jTzkaDKc7xMJfiE19cL4jpQjE
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: 3484

{
  "data" : [ {
    "id" : "obs_4foiPvmbMZeCn90aurgCJM",
    "glossary_id" : null,
    "team_glossary_api_id" : "tgy_2hXVOeRDoGcMUxJihGGELm",
    "title" : "Observation Glossary",
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:03:51.204571Z",
    "study" : {
      "id" : "sdy_4Mu4F4yCgZLNP4hU2hElQW",
      "project_id" : "pjt_1qIfNWf8bsBDtLcvTfatiw",
      "name" : "dBB5Mpsr2m",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_6qt0se4LfULemHszf8x3vf",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "Ix5Lb2vna0",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1lDaStwjeSQnNERuttfJ7V",
        "name" : "Aw6PRzFevI",
        "email" : "SF9J1hz5@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7N1oqmCQxQ60K4fxk76gxp",
        "name" : "oA9ha7kvxz",
        "email" : "Xc31y7Oa@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:50.863153Z",
      "updated_at" : "2026-05-08T16:03:50.863153Z"
    },
    "animal" : {
      "id" : "aml_5cbFmouMbn4fM8tRpMcNtU",
      "study_id" : "sdy_4Mu4F4yCgZLNP4hU2hElQW",
      "study_group_id" : "grp_23F7IJCH7Hpisw3g5aBsZC",
      "cage_id" : "cge_4xyV1HEUaTo7Uk3JYfs66E",
      "catalog" : "A0000001",
      "name" : "UVitexTUOV",
      "number" : 1,
      "strain" : "UBmAAp3Gay",
      "species" : "CREvjyBOH3",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "gfpPN6ONw1",
      "ear" : "92XOMhAVhG",
      "tag" : "aeNhjEPT0F",
      "donor" : "WBYnakRy2O",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_4VntEYDDam4oyae9Dac26F",
        "name" : "LZEzSAnuUe",
        "email" : "fxyGhgJP@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_712w6wQCB78VJWrmhwqjd9",
        "title" : "Found dead",
        "comment" : "FvPohFfJUD"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:03:51.110006Z",
      "updated_at" : "2026-05-08T16:03:51.110006Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_2chZHVgH7DBsdHNR63Gnow",
      "name" : "2ljhR Overwatch",
      "email" : "IAPDeeDc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:03:50.845423Z",
      "updated_at" : "2026-05-08T16:03:50.845423Z"
    },
    "created_at" : "2026-05-08T16:03:51.204612Z",
    "updated_at" : "2026-05-08T16:03:51.204612Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_4Mu4F4yCgZLNP4hU2hElQW/observations?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_4Mu4F4yCgZLNP4hU2hElQW/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_4Mu4F4yCgZLNP4hU2hElQW/observations",
    "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_5ed8Tr6fqagUabxhT2Jbu/preset HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3NDZlY2M5Zi05ZjA3LTQyNGQtYmI3YS0yMTM0NzU3MmU0NGUiLCJqdGkiOiI0OWVjNDc0MC05OGZhLTQyYjYtOWI0MC1mM2NmZWU3ZDZkODciLCJpYXQiOjE3NzgyNTI2NjYsIm5iZiI6MTc3ODI1MjY2NiwiZXhwIjoxNzc4MzM5MDY2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFYQVFQbUQ3bmNIRllaSEprb2NKcWIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.jiDLq1rg_hdhsa0DRDljWTVdQh19w3qcjIOYd0LxmK8RGmWTgwhn1eaGI2d4WaOgasu2MzlgX0uqBvddiqfqPdLVetlfUYwGlSOg6k_pW1DzwBHNU3ptKBt3ztwBPjwqcE51HTqPUZJBD_x1SdJiEtCNt1z2j-xO2mOtkpg0CcglrxayGINTG3k2pzzSKrcpYFBOHuEUJov-2eSBf-3WYi1ExCcNq808MoxwvKNpJustFlmH98yuupTitTI6Ps5mafxl33z8ZO_7t8hy8iawBJe0tYl705vQ1d9cDDx7oEXhq6TzrnBC8WWyZB90i4tNX8nZEBIr3WMgc-51fuyQfy7cmSCmJV5pHY-4qrBD0-1r0NLqPq9a0t-CcghaaqQquQttKhHHv57hTV_lTZaY4qXxihY3ilcflFIKp_jfQQH2X8htbipiDlEuvNh7mk4dAGQOm78W3pM54yWgAbeZ5Y7qvybHU6llnM1Z4r2DdLo-h4uA0Sr8MFcXj2eO6tBuVNwLS3zAb9rKyA6-Bpm-MaLYafAsmMQq82fSO4l9lh2WRYRwB0obrRV7pQ9GKtyn32HGjQGyIpBLVuv4lY03TiXb6PQIFKlRn5F9oxFyWEa-PTkIccw78-f2NtsC7SRsyrV94n4pMtdq7SvbS6tl7iTL35Lp4QU7dwz3w-2LuOU
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: 1499

{
  "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_5ed8Tr6fqagUabxhT2Jbu",
    "project_id" : "pjt_1V1LvaFtIIxA81BPL9HD8s",
    "name" : "etbwa4Aqwr",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_GBo5pvFlibhKtnLzcab2M",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "xeQVcZBin0",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7DeX2v3RTwShZUtMbIKU2d",
      "name" : "eYOIqyiho9",
      "email" : "LZOTpEf5@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4KR8E9gpO6NCDqxXAAQSbT",
      "name" : "sWz1uwwTYJ",
      "email" : "e0ocSD7k@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:26.456637Z",
    "updated_at" : "2026-05-08T16:04:26.456637Z"
  }
}

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_1a8muiIATNjW6qwRrJfcaF/requests/req_IaqeEQq89r1lb4kR3UNnH HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmODVlYTE5NS1kYWVjLTQ4M2QtOTkxYy00MzI3YzhhODIxZDEiLCJqdGkiOiI5M2UwYWU2Zi0wMjNkLTQ3NWUtYmFlNC1kNTQ3YzE0MmVkMGYiLCJpYXQiOjE3NzgyNTI2NDIsIm5iZiI6MTc3ODI1MjY0MiwiZXhwIjoxNzc4MzM5MDQyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZoNWw0ZFppbERKY0tHNFNEaEpWZUIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.hsgFd9ZvdvAPwt-99bEAZgXd1YDNFAR4PNH5nlRx41bGqRUdQF_jFgZJBSEfn41nyjPlTQCp9tRtSv8Eor5f6k8uyXij2CoRQDOYQPEs0X029T7mEuq9rQ98OUSpdHkWPnIqfH2KhvYrTvq-6c3wayWb-L048fe01kzGxaFaDLGTWtJPXWN4gVUAtxCFwwqmAxzAbZ7VBisALdsr5GM_WwSitJmfEBWpDbwUU1awQzfcfmuWI9jpHzrIStQCUym44JetS4qf2JyBHRu1d94Q8Co2ct094RF_WLW2amoVbu9jKEqe-5Me3WIHJIAjRFSMWuYUSd56LzTFRSzGC1Bz6-hsciap1CyMWjwQEhX0Yihawr7_0coZdeLFnduETckj1o0ZSLV8HvSmqSLISRMxfjT2rD2iAOJm_XHI9TA1dsaqSOVAT5l5_FI1xS3lQcvvEajodXU6oVRNEq0DI-sCw9pRZMZ-mRPCFPvX8IUJ0dfk0HegUeLWC8w6Z7rX_Nx0SFlvXQWa-KyNcM_y8t2JlAxMt-PLntg_nBpkuzYIEYAV_sAQEucBkfgpv5BwMQ8qqHkoqvUgaSePHjXfORFolWlngVaPHaVi2DPb1DOvPWXKCrenUHvTnvkr5J8L-gguaVY7ggH7NkTvB4C0O3bhvxsevUzGIxALE6xOo6oBGAg
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: 1419

{
  "id" : "req_IaqeEQq89r1lb4kR3UNnH",
  "user_id" : "usr_2A5400989AzNRWd214RS9C",
  "assigned_user_id" : "usr_2A5400989AzNRWd214RS9C",
  "status" : "pending",
  "due_date" : "2026-05-08",
  "groups" : [ {
    "ref" : "w83XQYlO1o",
    "label" : "jNfaYxulrn"
  } ],
  "fields" : [ {
    "group_ref" : "w83XQYlO1o",
    "label" : "u8pHS0VrvV",
    "value" : "5sGJEFh9pg",
    "options" : [ null ]
  } ],
  "study" : {
    "id" : "sdy_1a8muiIATNjW6qwRrJfcaF",
    "project_id" : "pjt_1Wz23VO6vTk3SOqIw9ZQvA",
    "name" : "PhJkwJMIqJ",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_20zBqr3PKE0ShSXKq8CFN4",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "50VX03PDUD",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_oCzS2k0DX4K3BcUqO40f6",
      "name" : "qVLg2fjamL",
      "email" : "9ynjaXU9@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1BQyZ821t75cXkWLKlwT1v",
      "name" : "2XrFIXssIY",
      "email" : "57WQitx5@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:02.216907Z",
    "updated_at" : "2026-05-08T16:04:02.216907Z"
  },
  "created_at" : "2026-05-08T16:04:02.403254Z",
  "updated_at" : "2026-05-08T16:04:02.403254Z"
}

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_1u89JKKpbcQ0zmWTqEvLOV/requests HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMDNhYWVhYS1lNzk2LTQ0ZGEtODcwNi04MGIzYzkxOTQwNWEiLCJqdGkiOiI1NDAxOTdmMi1hMjRkLTQ5ZjktOGIyMS01YjUwMmY4ZGRkYjkiLCJpYXQiOjE3NzgyNTI2NDIsIm5iZiI6MTc3ODI1MjY0MiwiZXhwIjoxNzc4MzM5MDQyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZNbXNTVENRdkNVbzZ3WjZaMFRhTUMiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.MnR4lf04Dwe8_BicgWB78oNBcdccZhM5J3QTMk3oYmtmaQ4f2M4YfIuuU8qJZ-TJ8x5SFoiiL2uuzgMd9Wei21WlELknPMOHbYv0nYd4gofVaD7J25mcdBzeD1FE_QWC9f9rNU_No_TXYlcjLim-8azC0k7pzaVpmZPoWy8EVS39WjnD2AYt9MhhxbLSw5sdUzUQMhDMrCGGLruQt4k9JEs22aaHE84kP5erTqxB8Hovk8DouMQmpuPZu9-n3NL0FKIq-XIDSi8444_LLf-buyUOdPBj666oBRMbBk8Rv2MkiGmf9HADL5hMPIQCV5GpAwJ11-PMvC-DMLIveV-i-Laq5fNsLiAddJbxm8UQj1PZ_UnvdxcFnuyrCsiiFJBJRF1V3CbJiSXmEaCPqHXjgBCMuOn_oB9ZLVdC82qVKXwlWKzGv5OoJrO5_uFNv4bPUpPIXr8_3kaQLS9AcEj4HCgTy4jOe32c0YLG0c_6oj4qdIZ-ADJCTRQs6pFP7kL_sa3e2x2PEGE8Asdou_eBQLQr5pdoE9oD9iGPqlFacoD-d_UxR2OopKZCMXT0kH2MGEyz66kWdNhsTOc8lluynHkbtfsGbf84iyZ0fPELpxz6SV6gLygQ-ECN9FPiXCMFZKUaWQfWF9cucRT0GnPJJXFbPbp6t749J_dTQaZ9_u0
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: 2027

{
  "data" : [ {
    "id" : "req_1LBmSAxswL8upwFEcaDXVa",
    "user_id" : "usr_4YkQjGwPSLc5uUXEvfxpZP",
    "assigned_user_id" : "usr_4YkQjGwPSLc5uUXEvfxpZP",
    "status" : "pending",
    "due_date" : "2026-05-08",
    "groups" : [ {
      "ref" : "D96isZOGpL",
      "label" : "h8AVmeJBLC"
    } ],
    "fields" : [ {
      "group_ref" : "D96isZOGpL",
      "label" : "NtONqkt7OR",
      "value" : "fcybQ4Gdb4",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_1u89JKKpbcQ0zmWTqEvLOV",
      "project_id" : "pjt_70giXka98YycSubjG2tYO4",
      "name" : "LOLVK4tVOL",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_4yqhepuVWGjJ8B2SBnR37v",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "rtxkM5kN33",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_41iHkHrBILDi9k8QFabH9X",
        "name" : "e7deK0Rot8",
        "email" : "PKQTHapV@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1HCp6YAy40Gos5JpYZJmcc",
        "name" : "NnFGMhNQC9",
        "email" : "87IqRSyy@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:01.953362Z",
      "updated_at" : "2026-05-08T16:04:01.953362Z"
    },
    "created_at" : "2026-05-08T16:04:02.102280Z",
    "updated_at" : "2026-05-08T16:04:02.102280Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_1u89JKKpbcQ0zmWTqEvLOV/requests?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_1u89JKKpbcQ0zmWTqEvLOV/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_1u89JKKpbcQ0zmWTqEvLOV/requests",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Request Sample

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_4ciBEI1nPnn1UAQkWh5DHr/requests/req_3XYh83GUDXLBc2OfgDywlN/samples/spl_3dMzTjQy5NtDGoe7aYrcDt HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYjE3ZTI2Ny04YTM5LTQ0MzctODVmMy0zMDBiMDkyYTc5OWEiLCJqdGkiOiJmZjljNjQ0Yi1jYWY0LTRkNzYtOGZmZi02NmZiMjk2YTRjYmMiLCJpYXQiOjE3NzgyNTI2NDcsIm5iZiI6MTc3ODI1MjY0NywiZXhwIjoxNzc4MzM5MDQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdNT1BIbUJjSTVwaGF5blVSZ0k5enQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Q7iOXiF4y0imyspNmy_6fpOTkoKGubWd8CDpfVqnSdNTu2Yv7Ted4rt8rCMnoBtgAq9NOrHbZrB05PRFKlV8XnI2RNQzGMXRL3JtPpfeh-SWJmAWuqz0EhFeHdFg5ybJY4MtbFcYVY_VK1h0VPNMEr5a61ka_jXMAmp_pdjBCAJQkCsD2Qv3K_rU_oEe9bNCATf7jXvmzd_B_oIo8Rxyw_wQcGlqOEDyOgGlK4U4JKLDjEYhsg6AGh4QpIrzp1ljRsT3GmllFvJROMLzDakemUFJadAQa4wTZspouRvoWImIiwMzrGm_VBsC9xRD_ir_PSuWWMxCA248vFvEgdPxi3vjmsegzyHuAc9rg8qhq5UiksSaoSKEAM_kHO0gn86KNhwqHJab6Ifr7WxmLWqDVlglp06qAwnteY_DTeHE7YmTjqJuroiLufxiV7eT_dmGh8X3HbLCjwdfptYfi94rNoUTYIkXkuTuWvJWDeHvtQ4FPtEsmJ12-7Ymaj6knm9_UJ_SHe4_s2-297A0FNk1m7NOY_x1b3GgDGqYi_4YkJiJD2HTGAxlf2NLASh2MZgpVGV8gTNJSDazZu32nsMPwfJMWBjndWrrXFPvyDyh7rK50ycEBuXBvnE7wPYiW-CsAj5Ev8uY14Zc9989xMo3Oytyh9ACgNBy4D6qCsTNj6k
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: 2932

{
  "id" : "spl_3dMzTjQy5NtDGoe7aYrcDt",
  "sample_id" : "S1012341350",
  "sample_definition_id" : "sdf_61v6TWsdMavFivv23wp3NT",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-05-08T18:04:07.975029Z",
  "details" : [ {
    "key" : "volume",
    "unit" : "ml",
    "value" : "5"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-342862533" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_4ciBEI1nPnn1UAQkWh5DHr",
    "project_id" : "pjt_6eayTdh34zlF8lB8f2FZZL",
    "name" : "Kex2ovPaiV",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1RzgLjkmT1nwFeqVYTmOcN",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "zDZNmIoqUh",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_45kI5s91pEgCgx7LGqSbyz",
      "name" : "CWyLBZNErk",
      "email" : "Ihblksbx@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4ssLhU43q24cVfAkXFIBzU",
      "name" : "1WdqXSpsyq",
      "email" : "auyBIbp1@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:07.568016Z",
    "updated_at" : "2026-05-08T16:04:07.568016Z"
  },
  "animal" : {
    "id" : "aml_3uXf3fJ1S2dZYfcgC0jciI",
    "study_id" : "sdy_4ciBEI1nPnn1UAQkWh5DHr",
    "study_group_id" : "grp_1JgB51ej84wkKs6HDDQgCy",
    "cage_id" : "cge_1BUPRu1Gu4Us20v1al9a1I",
    "catalog" : "A0000001",
    "name" : "E4FKDcJVnx",
    "number" : 1,
    "strain" : "LQHApYYOnj",
    "species" : "ZJ6fAdqgpo",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "XRulWHAgtX",
    "ear" : "15dwwC9iZM",
    "tag" : "kgsecBrv0J",
    "donor" : "mJ4YvLOGos",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_1Yc0vVOCDg91Y3cVA4BdKt",
      "name" : "h9inBh37pC",
      "email" : "P8tR7fl9@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5p1Rsb5SIdU4muGbxkBErA",
      "title" : "Found dead",
      "comment" : "89wbgdlSuV"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:04:07.723382Z",
    "updated_at" : "2026-05-08T16:04:07.723382Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_48E6PyHhsWSYwcg4cKnFiO",
    "name" : "gWO70k8bTu",
    "email" : "WsuXiFQW@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "Q1WhL8USAH" : "JDYY3d4C3H"
    },
    "created_at" : "2026-05-08T16:04:07.964049Z",
    "updated_at" : "2026-05-08T16:04:07.964049Z"
  },
  "created_at" : "2026-05-08T16:04:07.975087Z",
  "updated_at" : "2026-05-08T16:04:07.975087Z"
}

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_6BcmdXUfzAqNdhIyqiI0oT/requests/req_IKwk9YvRGa4lW0fDDCmZv/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYzdmMjc0NC04NWRjLTRlM2QtYjNmNy0yYzY2MjdjMGNiMjAiLCJqdGkiOiJkMzk4NjY3Yi04NmE3LTQ1NTMtYTQ4Mi0zMDk3MzI1MmRhM2IiLCJpYXQiOjE3NzgyNTI2NDcsIm5iZiI6MTc3ODI1MjY0NywiZXhwIjoxNzc4MzM5MDQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzYwQk84NGxLTjR5ZTg3T0NzSDZLOGkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.DbNphll9jG9mZZ2twCmYBUVSIthmVLoZHeJCmAKHGWWrB7rup3QTcsocUr0-lz9U_KD0PdM8cgXDRLJJPQp-BI04xSGji_tMI60SlS9wKE-6Yjs0oU3kQPPOylLWnD7Hxj8uPzYwCBi0GwM7w0ho5PN2NXE-dKBPsCVam0l8wdDTGuP7PEWZfudm-_Lt1xEDBa7UQrYJTlCPrK3bVRuDfyag_PQFVy2GrBfUkBt7SgEzOabZyN6LM8In-17-Awt-p9Q3DBkZxVekYcXAhSNPV118ZmmIzLadccgZe31RaW90lcaLEH2S6FnflfX45SryRKzgAxN3Vns-X8Xr771voyKBJJihpUODYdwmY1qHQyt6U1vnRdmjGbzIvotTtsIGy6O52DbVBNnMAMR06o2TkZqdgEkvtdwO1Ag56MHNa6ceeWqNkqPheUDTAZ0hsAlRUPet6HJ0iYBEHdCouAmPHhy_q43t8cGaKP3P6MxH7H_HBEr823R8anMQVMJR18dRZcbdBP0P9SDyvmCwlYuFco_32R5bQVPv76f5z36NuhjZsqYohxdO8sx1Jb4tj9g3aSYqh9VV_buJ6lJthc2EV5qQ1_h5H7iXK70UzIpgp6Q-uYJvCGRjZzoY3VNVrUAe8TYTqTuw3D4hZ899RRDfZE_H-OvKBOjfKYLn-SqX0sQ
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: 3742

{
  "data" : [ {
    "id" : "spl_35JywiQ3boArUZmstswbxJ",
    "sample_id" : "S1648047925",
    "sample_definition_id" : "sdf_6ljTYrKUrWkGjn721ve0xv",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:04:07.449128Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1306183361" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_6BcmdXUfzAqNdhIyqiI0oT",
      "project_id" : "pjt_2sy3KsVr1wgMX1o6MZuxNU",
      "name" : "An5ep0eemT",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3mboBJSfx9N12x4NXx0Dbv",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "v7MessAhT5",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6oSCFIwfRH2Gm1tP0xnMIo",
        "name" : "WgPATouiTA",
        "email" : "mdntYD9P@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_B3cHIwrdiRXKxexJwlM2G",
        "name" : "GWe7SgLkPa",
        "email" : "Oj1Dx3eW@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:06.946721Z",
      "updated_at" : "2026-05-08T16:04:06.946721Z"
    },
    "animal" : {
      "id" : "aml_3p70bzkXHzH9NyVrbbtAvQ",
      "study_id" : "sdy_6BcmdXUfzAqNdhIyqiI0oT",
      "study_group_id" : "grp_2LJIrjHbZ7dz4kcxw5FSLp",
      "cage_id" : "cge_1DQTq5MbIyNmyEzxT3rkY0",
      "catalog" : "A0000001",
      "name" : "fUAnje0M99",
      "number" : 1,
      "strain" : "tcVhxHthhH",
      "species" : "zWBKu0DLBw",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "TbAOFzb4cz",
      "ear" : "S3SqGpjWRw",
      "tag" : "WqdYCjC81K",
      "donor" : "CguH5gREEE",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_1sM38mBmukucJfbTVORWN7",
        "name" : "YhQFH7PocS",
        "email" : "8Qqh1nXi@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_6HVBXXtrhA2d3tT9fuwP9l",
        "title" : "Found dead",
        "comment" : "rcqpx4pvwU"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:04:07.311539Z",
      "updated_at" : "2026-05-08T16:04:07.311539Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_4PZyBw4ThkU6Li3aU5q26x",
      "name" : "lRfzw62tFw",
      "email" : "QkfshfIf@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "qbogleLm9L" : "yu6EyVZKAj"
      },
      "created_at" : "2026-05-08T16:04:07.435207Z",
      "updated_at" : "2026-05-08T16:04:07.435207Z"
    },
    "created_at" : "2026-05-08T16:04:07.449232Z",
    "updated_at" : "2026-05-08T16:04:07.449232Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_6BcmdXUfzAqNdhIyqiI0oT/requests/req_IKwk9YvRGa4lW0fDDCmZv/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_6BcmdXUfzAqNdhIyqiI0oT/requests/req_IKwk9YvRGa4lW0fDDCmZv/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_6BcmdXUfzAqNdhIyqiI0oT/requests/req_IKwk9YvRGa4lW0fDDCmZv/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.

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_2EJkXlMn3GhuRoZw3gCQaT/samples/spl_46Eoz3noyRdfsoMJWCAKpA HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNTA0NTVhMi0wYzM1LTRjZGQtODQyNi1lNDdiMTY4ZDIwNTAiLCJqdGkiOiI5MDVkNmRiYS0zZmI4LTRkM2YtYmY4ZC04Mzk5MDBkMTUxNjAiLCJpYXQiOjE3NzgyNTI2NTEsIm5iZiI6MTc3ODI1MjY1MSwiZXhwIjoxNzc4MzM5MDUxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJVT21qdzh3Q09lb1gzdkVESjVDNDUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.PAO80soA0Q7dKSvJEfDw7WaMh6tN_RSH8-2IwVdlSXU1290_1nSx1qsQbsMNq3y0NgdJPkctRQloQjELgoA8pFYighTzbQDeg3RcGRMVYN6y3xt1i4npJycx8agtcL_QOFaWxnoDTGpYbtoWAEudNINWjQ-iSGsjUNQm1uURi7922sKf2Wlz2VPsluuduse8vFeQKqkKvz4y79IC7RgS66IQvm0RH00i9YoLBT2HEVhSao1tf1SzMk4b-pNnS79bufwGDLdI2SKA2Uc7ZvLC3_5q5uyCp5D5JNeHupK-9wS3G7fg28XCfOkmqHrYYDaeZls1erH5J6sMgqoR1hMtiN6rCnBPao_Pumv08r0yl3InPKo9bGwZUCa-nf50CuBXnooggiUZhi35f_WMG5urfdKSGH20OGCo0n9MXChE23ThhTKixXjNTvXukh8jv1DltULtdu0w7gRPbX3O32kiOIaakIG89N3hLVESWAaP3sYMLjIfuIuG4WB-04DrIR1BxhgOGTBdkrT7O0wJoFhXMxwbkB0dcpubFgZIaOPdUaggysu9Rgku3ps3SSvJMb7ApLnkXHrAlv94KkImadSGVcY1muF3Y7dN1DahDs_47l-97tXGKAAyH1BofpicjygYGDxFNmUvnsf-yIupXdfIJnnURAktsN1w0AZU7s-RIg4
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: 2930

{
  "id" : "spl_46Eoz3noyRdfsoMJWCAKpA",
  "sample_id" : "S443243747",
  "sample_definition_id" : "sdf_4lOYyHu06l7O2h1vWDrbW2",
  "type" : "Blood",
  "label" : "BLOOD",
  "status" : "collected",
  "timepoint" : "PT15M",
  "collected_at" : "2026-05-08T18:04:11.079168Z",
  "details" : [ {
    "key" : "volume",
    "unit" : "ml",
    "value" : "5"
  } ],
  "comments" : "A blood sample",
  "metadata" : {
    "sample-internal-id-1752038051" : "SMPL-1234"
  },
  "study" : {
    "id" : "sdy_2EJkXlMn3GhuRoZw3gCQaT",
    "project_id" : "pjt_1whUAKd1QSZM5zXhD6cL1b",
    "name" : "r290TnH6pz",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4ekBBPbjEQSMUyHnRA05PP",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "ecuO71S0eh",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_oymgDdfaxXNw83nNxttD3",
      "name" : "schV8doRTI",
      "email" : "QCkPylA8@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_10UMaMFeEoGMcwfX7lsEf0",
      "name" : "CqyiBOWyvF",
      "email" : "YJRMhT0x@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:10.757175Z",
    "updated_at" : "2026-05-08T16:04:10.757175Z"
  },
  "animal" : {
    "id" : "aml_5cokDVeeBtMiiRttUkFmei",
    "study_id" : "sdy_2EJkXlMn3GhuRoZw3gCQaT",
    "study_group_id" : "grp_7Jk3L2GDAr9sum86rHWebp",
    "cage_id" : "cge_5NqMrsOtRuaVWQxBgrXbA0",
    "catalog" : "A0000001",
    "name" : "Ab163LLUXv",
    "number" : 1,
    "strain" : "NtL7WQZs5n",
    "species" : "bokfBcSGU0",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "Gans1Jl9AO",
    "ear" : "52Z4OhKJjl",
    "tag" : "NkzWLOL2V6",
    "donor" : "bHZKn9UOyF",
    "tracking_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_4vuuV7Z7E9d48tFvEUhmIe",
      "name" : "VF4edDqGCh",
      "email" : "f4TpRXXw@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_Z3RINZIrg1Xx44ymOFpLY",
      "title" : "Found dead",
      "comment" : "ULZId0HMp1"
    },
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "created_at" : "2026-05-08T16:04:10.927114Z",
    "updated_at" : "2026-05-08T16:04:10.927114Z",
    "disease_induction_date" : "2026-05-08"
  },
  "user" : {
    "id" : "usr_7KaBCwPGFFZOzppe7LmFic",
    "name" : "OcrP9ZtFjx",
    "email" : "nMhBET7e@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "WDZ14oBYcm" : "vCtGfW0BiJ"
    },
    "created_at" : "2026-05-08T16:04:11.062862Z",
    "updated_at" : "2026-05-08T16:04:11.062862Z"
  },
  "created_at" : "2026-05-08T16:04:11.079245Z",
  "updated_at" : "2026-05-08T16:04:11.079245Z"
}

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_1mNswqVgH63Ue0BKrI6Txx/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1YTkyZWYzYS01OGIyLTQwM2EtODExNS0xNzMwMTU5M2Q3NDIiLCJqdGkiOiJmNzUwZjMyNC1iNDVkLTQwODMtOTU5Zi01NDNiMzdmZGRjY2QiLCJpYXQiOjE3NzgyNTI2NTIsIm5iZiI6MTc3ODI1MjY1MiwiZXhwIjoxNzc4MzM5MDUyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzQ2dktNbUcxaGZrYkt0cG5lcXo4UmQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.n_Ei7gL1Tia8fdz6wjl4Qpw5mct1BJGVnI3-PkYFJZr0Xk_amxz3r6cVqPtTZHNmlBm2oiH9CKSg7O07HWx9D0YDIrsBfpPK7igDn3E80lnExAbWPZnOsVVJfA0B4JOL7qPoaFVl3jHRWllDTNuHZcrUrcT_zepStla_M_D87GHW-Tzp0La1Ch0sAwQrwhOkaVjVySRP2n65nscqftvFJTIZgeq8S5sVg_q9Yy9fMKAOI7PvcayDOIgr2t7gwMag0W5jN8CIJMwOKF8NXKipwZU4HvfHHzzRjlsjwR7el0dbzBf7Hk0bmEcfLotTyyx2P8NQMQGnzSq5KiLspmq9uexMuWM7ufpq1j5f5RkiXwOdT2B-7V7j23eJi7AOCES-bbQmZLu9nZpKGUDrxstCJ0JbQQXlBpYFgX4ri0ZmFuis0RoeBjIjQI7qNBsLJFV-DIy2kPzMGlXtV6lXtLblPcmFdI8e6BDuKi45llL-owiUxGDnIy0FjMXz338jzOtEhBbKM5xz1LANFtqXgllg50_7E6fnFSnitTnEa81IWXNfbK_b6CNBA32RjeW1HZmUMT1JrKUdpv-HKoYJKuM976P2_eb3JBsExk69sYwf9Sl_NtcsJ2tyxqWcsucW89NDJoEBVnNWHTMP65LZLSNBCSkcxO-8-Emdsi33bM5RZKA
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: 3630

{
  "data" : [ {
    "id" : "spl_3smuERotXzkGXRtO8eL929",
    "sample_id" : "S392813661",
    "sample_definition_id" : "sdf_5dDZdM3LbsNYmlqMcLFDzR",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:04:12.973894Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-5290572" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_1mNswqVgH63Ue0BKrI6Txx",
      "project_id" : "pjt_4FugY232z5xzSzBm5UqN5D",
      "name" : "B5xYUoJvQV",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_T23fsYUqHhxUQx0zlmo4A",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "zoVRRnVbW9",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_4wVOefxbtDpW0dM1hLCTzt",
        "name" : "xCmWauBl9v",
        "email" : "t9iEUxS6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_IOl7RdbYjxYQNZdDHI8km",
        "name" : "XKdXAYfJK4",
        "email" : "Hr0oBE15@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:12.636204Z",
      "updated_at" : "2026-05-08T16:04:12.636204Z"
    },
    "animal" : {
      "id" : "aml_G7zjywHyr1QksovYADtX3",
      "study_id" : "sdy_1mNswqVgH63Ue0BKrI6Txx",
      "study_group_id" : "grp_6V6P9D3lsvpk8ei9vgEB6I",
      "cage_id" : "cge_1gfDzoUBs3As6Rzyr7jTvW",
      "catalog" : "A0000001",
      "name" : "Pp4SNR8Yf4",
      "number" : 1,
      "strain" : "7JRtPc2HuB",
      "species" : "6gj9saruld",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "BYs7DmTwj1",
      "ear" : "Olg7eyoswF",
      "tag" : "XGnq6NAH5p",
      "donor" : "StgSfsJnDY",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_12oCbdVNst0UDVbvW2xkV6",
        "name" : "kUzjCVTByr",
        "email" : "vW9lw6vV@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_4nnB5fO8a2aDFHxUQAC2Ix",
        "title" : "Found dead",
        "comment" : "rCkxU3z6Vo"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:04:12.833052Z",
      "updated_at" : "2026-05-08T16:04:12.833052Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_asH1IWItQc1QZnbwRl0yV",
      "name" : "okOWkcZ5BF",
      "email" : "U8m2DT5y@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "Kxj02YFqYF" : "vda3VkTOqy"
      },
      "created_at" : "2026-05-08T16:04:12.963935Z",
      "updated_at" : "2026-05-08T16:04:12.963935Z"
    },
    "created_at" : "2026-05-08T16:04:12.973999Z",
    "updated_at" : "2026-05-08T16:04:12.973999Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_1mNswqVgH63Ue0BKrI6Txx/samples?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_1mNswqVgH63Ue0BKrI6Txx/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_1mNswqVgH63Ue0BKrI6Txx/samples",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

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_3iTwupwBvrFo2IZZD6u4uw/sample-plans/definitions/sdf_3ZvLMABNzM5OnITKMR18dF HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlNjllNzIzNy03MzlmLTRkNDctYjVlMS04NzE0ZTE2Yzk2OWEiLCJqdGkiOiJlYWU5NjY0Zi02MDIwLTRlOTYtOWZiMi04ZTgxNDdkYWRiODAiLCJpYXQiOjE3NzgyNTI2MzMsIm5iZiI6MTc3ODI1MjYzMywiZXhwIjoxNzc4MzM5MDMzLCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl80MWhuRXFYaUFybW9PeVNrcmhYU25JIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il0sInJsX2VuZm9yY2VkIjp0cnVlfQ.AQ7G5ynwq7XoF9pgECEz0tSg-lteWWxEisX-2bpfLUVE8O2cVFBHweQWi1HRr4QGGp605EN9-CUsMpxdfvK9v7A0ghNl9aK8A7ovV1xGdIhUqvrfdBwrO3-RwI_BFBO0cogQVW3zdz4NN3XiZ6ro91_RwiJhadXt_ccfe01GuCahXJLj_8G8TFdIY7YG_oBokUjLsp4jDuKwKCduOvBteJRqDtcxNeqMbnyLJqthclvliY3IuYlN5aAAQAPW5-j8DAyrUyUHMOcP_RBhNDQGdPb2jIvlin-6UvA12bT-W08MYt1OU8UwePPxHoBf5SjWPF8Ca6zvMl1ESYX4twP5bFqxfEM_7ynsJr9179tipE0NHsVg4_HIL_QjuuYflmGdbQCgfEnbjDKX2Qlv_EhKn-qYSTrNGJR1oe2K2ktOoEy2LiO4fwRYgEOog8_zkEqP2GFlSskzLwgnF24ui9-9DWNgyJLR4KzNl5Fu_rKy6Ar26XD6CoqMkDjWfk4M2u5JmWcOmvRWDYDRsaWbAXYBXiHiLP1YIk9LElk5eJ1LjaeRl6ChOFWKhUyMCAYQdM5ckEYl8FIQuuYsNOMbWcMCeTGYf-7lFTAdnIMTCqzAdkgqLjpZPdR5aPFjXx6gvaNF9L8DlswoheiUiUfoUPa7ojSq3k9pIFm_vs03rcAXjDo
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: 1478

{
  "id" : "sdf_3ZvLMABNzM5OnITKMR18dF",
  "sample_type" : {
    "team_glossary_id" : "tgy_1n5J7Uh3hlBQn4k2ZYCal0",
    "title" : "Blood Sample"
  },
  "name" : "Blood Collection Protocol",
  "timepoints" : [ "PT0S", "PT1H", "PT4H", "PT24H" ],
  "details" : [ {
    "key" : "volume",
    "unit" : "3",
    "value" : "ml"
  }, {
    "key" : "weight",
    "unit" : "50",
    "value" : "mg"
  } ],
  "metadata" : {
    "storage-temperature" : "-80°C Freezer"
  },
  "study" : {
    "id" : "sdy_3iTwupwBvrFo2IZZD6u4uw",
    "project_id" : "pjt_6dg7lLNaQ2TPJeSxpBLTB9",
    "name" : "NC4EhDsfj0",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_3vPJzup76NTpvGOqcOvkaR",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "1IW4wV7LHc",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_3xVQJnd0TFcY4XxLhQzamZ",
      "name" : "4jww1Lx6J6",
      "email" : "ZoRdf0sa@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_2bdtuaBlkV34bnOusbkm02",
      "name" : "Aq67fak6uh",
      "email" : "W87WJI6V@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:03:53.146011Z",
    "updated_at" : "2026-05-08T16:03:53.146011Z"
  },
  "created_at" : "2026-05-08T16:03:53.563827Z",
  "updated_at" : "2026-05-08T16:03:53.563827Z"
}

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_reyxU8W8m2TpSCUpwrk5X/sample-plans/definitions?perPage=1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZDEwMGU2YS0xMzMyLTRlMDEtYTlmNi1mYTNlNmRkNjg3NTAiLCJqdGkiOiJkMWQ2ZDNlOC0zODQ4LTQyMWUtYjVlMy04OTFmZjcwMDQwNjEiLCJpYXQiOjE3NzgyNTI2MzQsIm5iZiI6MTc3ODI1MjYzNCwiZXhwIjoxNzc4MzM5MDM0LCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl8yWkl5Vk0yRXhYbFJQdXlCdVpPSFdXIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il0sInJsX2VuZm9yY2VkIjp0cnVlfQ.C898G2TOdoEGiawHXRTZpEve-j4l_TT7Lwl0p8aMwcBS71pL0iGzLEg3djv0PEIK4e_0dxscg3-QARILhAVh9onfe-vQPKg3hLrtw4ivSoOCJxJNsKqeVlojmhlZQYAPk53jdPCMvybAr9POr6Ba6t2kvJCtjOkYNfWcfCp_dfoxRVQfrVF4cooNHX2C5v8-ewy93331P0dGKJPCCvP3NK08sB_cqy_yndEeE5Oqp9yeecDG46kumGqRkF8gLky0mO6IXxOa_PFVI7j6GqHtaU5ydx_Ss4oR5KaaTjqauiVUxAnjAedIR7yTYfwy0eqeOKmMzuIiqz0Cgy5aEp-35uZw8gRkLhBAyC9Ion-z45wTKklBg1BUF46K8EctKVlbrgxCZu3I7OqvAyp_cxluAtz6vjlY06ykDH5HJGxfg1VeppWuuybfwiBfTMopSMngFzjAHUVPF8CrsknrSm00LvsG4Lp4pUc7NCsTgq9syh8mPMT4hlgllsw-SfzgrG2KYtXqpTslBEF4zdAtqoD2Fe0VDktcHEhWryCOx-ZbCE6WBYshUC3eLhh_NId9GsKHOi4BgtcWLiFYPUHGH3MksVfL-HQMHOLSJDeUCq9u91L3JBmNE5qXja9oKclxC4Qz0eqbnvTDrHebgVxSVjQSQSFMt0QsKUlb7JuVncc1e-Y
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: 2243

{
  "data" : [ {
    "id" : "sdf_6RJIBck7imSJNkKqvZcjC2",
    "sample_type" : {
      "team_glossary_id" : "tgy_7OLcReDTpSx98PcR1AwBVU",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT1H", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "unit" : "5",
      "value" : "ml"
    }, {
      "key" : "weight",
      "unit" : "50",
      "value" : "mg"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_reyxU8W8m2TpSCUpwrk5X",
      "project_id" : "pjt_5Ea6tQFr2nPi1jFC7VMdlW",
      "name" : "NcPGDw5526",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_33Di3niHufVezHFVpkINe3",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "KpUXQalknf",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6MXblIgq1liAXmjWiLtwMw",
        "name" : "KJBhDI8zhm",
        "email" : "MisWR7at@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_hUDjpYG6ug7dx2YxZAj4B",
        "name" : "okIjZi6ziB",
        "email" : "AzPEUhMS@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:03:54.178241Z",
      "updated_at" : "2026-05-08T16:03:54.178241Z"
    },
    "created_at" : "2026-05-08T16:03:54.708190Z",
    "updated_at" : "2026-05-08T16:03:54.708190Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_reyxU8W8m2TpSCUpwrk5X/sample-plans/definitions?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_reyxU8W8m2TpSCUpwrk5X/sample-plans/definitions?page=24",
    "prev" : null,
    "next" : "http://localhost:8080/api/public/v1-beta/studies/sdy_reyxU8W8m2TpSCUpwrk5X/sample-plans/definitions?page=2"
  },
  "meta" : {
    "current_page" : 1,
    "from" : 1,
    "last_page" : 24,
    "path" : "http://localhost:8080/api/public/v1-beta/studies/sdy_reyxU8W8m2TpSCUpwrk5X/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_3FK18ODMFc4UE67syZ99Vq/sample-plans/definitions/sdf_4n05giLBQAQLbXLxGNuwO2/targets?perPage=10 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNTNhMjI3YS04MDRhLTQzZmEtYjZhMy03NTA2YTVlNzI0NTQiLCJqdGkiOiIxNjY2ZmYwNi00MTBiLTQ2NDAtOGIyMi05ODk0NDllOTI1NjQiLCJpYXQiOjE3NzgyNTI2MzIsIm5iZiI6MTc3ODI1MjYzMiwiZXhwIjoxNzc4MzM5MDMyLCJzdWIiOiIiLCJzY29wZXMiOlsic2FtcGxlLnJlYWQiXSwidGVuYW50X2FwaV9pZCI6InRlbl81SUgzZGdrRFpLSlhLaFY3S3RqR0MzIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il0sInJsX2VuZm9yY2VkIjp0cnVlfQ.UCKqimWQb3yyMH2n_ABVLFzFZWZeaivSHDc0mwsxEMuglNSrGZQnNvLUszWRfrAB3HuzSYMXYuTsLraHqeAbS5GEISNBQrn2McgcO8Z3voWjIHo2Vi_5SP6QPcf8fEmN37MEz4bRVmtjEUDtF1uUX8flwy3LCwtnFuXP4WlUpFx5p-iBISebXwM7qcw-KRyLgP9mezZ3nY-xYp4t_GfN-Qk-dWvJRn8dQL2Qa_zC0wX0xuW3cP2DswKd55uLeZZ-NkcdUvpMWPcJlGZgaTahqeMJqborSYpUqWVmtgP5681TFgweSpEHDa-iOzhNE6qAdkAL_MPSZ_MpN3YZOOAbrraR6BQSTDzToL-9dPuW09k4Vy_ysYs-QL80SXQhsPI4kVeN2jAaZjwPyYzwujnPpr81quicsOR4GAyevfPjP0_R41xPo4Bu99YEyESYCQBREFL6eerq1ngv1CBs-Xkl0Mz7lEYDAzR7OPafDvUPNBLFg8HWbLH4lgmI6EfPtVuSWqCtNZGQRcF7LTjIW5Fruq7G5UjxQ1jhLhqyEI6Vqgl6XE69F2EPuCHOg1nqUeog5lWtk4yjxKvMCnZFVigngBWu_L5pVFG4xKnn2mRG-hguf4zCEDWc4JUZ1z-ERD00p3ZAnP20i5AkZOjGUlvRZSADtnc2WAjeDPHOoC5_rvY
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: 2743

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_6GbgtvZdb3ahKF7GHnWYzI",
      "name" : "Control"
    },
    "sample_plan_definition" : {
      "id" : "sdf_4n05giLBQAQLbXLxGNuwO2",
      "sample_type" : {
        "team_glossary_id" : "tgy_7V5NKouTTlhnlYn7pbunV9",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "unit" : "5",
        "value" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-05-08T16:03:52.690301Z",
      "updated_at" : "2026-05-08T16:03:52.690301Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_64G7OB44QKOeTXtsyeWbmA",
      "name" : "Treatment A"
    },
    "sample_plan_definition" : {
      "id" : "sdf_4n05giLBQAQLbXLxGNuwO2",
      "sample_type" : {
        "team_glossary_id" : "tgy_7V5NKouTTlhnlYn7pbunV9",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "unit" : "5",
        "value" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-05-08T16:03:52.690301Z",
      "updated_at" : "2026-05-08T16:03:52.690301Z"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_3gJAgxojRZdrx8VJzt3gwr",
      "name" : "Treatment B"
    },
    "sample_plan_definition" : {
      "id" : "sdf_4n05giLBQAQLbXLxGNuwO2",
      "sample_type" : {
        "team_glossary_id" : "tgy_7V5NKouTTlhnlYn7pbunV9",
        "title" : "Blood Sample"
      },
      "name" : "Blood Collection",
      "timepoints" : [ "PT1H", "PT0S" ],
      "details" : [ {
        "key" : "volume",
        "unit" : "5",
        "value" : "ml"
      } ],
      "metadata" : {
        "storage-condition" : "-20°C Freezer"
      },
      "created_at" : "2026-05-08T16:03:52.690301Z",
      "updated_at" : "2026-05-08T16:03:52.690301Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3FK18ODMFc4UE67syZ99Vq/sample-plans/definitions/sdf_4n05giLBQAQLbXLxGNuwO2/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_3FK18ODMFc4UE67syZ99Vq/sample-plans/definitions/sdf_4n05giLBQAQLbXLxGNuwO2/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_3FK18ODMFc4UE67syZ99Vq/sample-plans/definitions/sdf_4n05giLBQAQLbXLxGNuwO2/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_3wNGjE5Bm1mZr3tkNsgTTq/treatments/tmt_bJxArf19XAWz1Qk5OhxJF HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4Njc0MDZiYi02MDcxLTQxM2ItOTYwOC0yMWY4YmNhZDg5NDYiLCJqdGkiOiIwZDllOTQ2NS04YjNmLTRhMjctYmQ4Zi0xZmU1NWU4MzM4OWQiLCJpYXQiOjE3NzgyNTI3MDksIm5iZiI6MTc3ODI1MjcwOSwiZXhwIjoxNzc4MzM5MTA5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdKdXNhV21tNW5aYkZ3aXhOOG1tUTIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.G7EKgohQ_S-UrKKYHZbpCgbqXeT9ipEOyxMwtzpn0FbGdPtCTf8m9eAqWfnRbyT8_y7PJRL8iZ0bEiRO9gysjGK3IGaxAqLyxxb6Gwb4aSur-LuoxakEHSsuT4bCNd54xW5oDCT0JguXvcrJ87FTd8BLTE2bbTCOOUH3zrom2vOYoTnCeVXhyorNiCraNnvAWygc5pIj4W6VOVIJQOHtea9xF0g-5WOAJzbYkKEJyzlDETBDWVzq6Y6OvPgNlltOM3idY-cLuTtaAU9alnTJH0E4ke4JlsN4Nok3rKlo_G9BKYsMhX-yy1V3vbzVQZAREGYVHgk3k-ZsJpC0SMR7bGuIVckXykA6njsK0HvRl_l77TMv5uxt034ht-0tEsx5auCSufh9vt8WodZaqdpqwzuOuFv9l7SfZPkB8XkVBKEcgD5kEUVY2xic4czE0lbio5I2CT2Af21CZf3k-nFWld8jN8xoz6r5nMd3852FY7t7XA3g_1jIGuNLA6_L4zRHns1ocC6GTX-GOA3C9t-N3CAwJ10YEJiLXyRRcj1w9e3l4ImXgSZdiKclXbDsSgTcZ648xnGAkfUF5JU91qqhrGgbCVgyYcB-jZKvafNz8MBl9q9_tHGG6Tp6vLnnExt9GTVpSVaoubF7MU-BeF-htqd7Bx8VhLfW18i5Kz_ck-I
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: 1715

{
  "id" : "tmt_bJxArf19XAWz1Qk5OhxJF",
  "type" : "volume",
  "name" : "ovcDrFoD1H",
  "label" : "Test Treatment Label",
  "external_entity_id" : "BCWOujLUm6",
  "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_3wNGjE5Bm1mZr3tkNsgTTq",
    "project_id" : "pjt_5T8Ou0P9HKIxJcZj7Gs3PB",
    "name" : "tsj2J8uShi",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_5PtuEUXWU1tjUsv9xrMCU",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "72aANzq5Pg",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_2TarNHEThRGBUA1YT0GfMS",
      "name" : "7BCNxfZeN8",
      "email" : "0YMxmyUK@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_4Jd3WJGq4xpjrlVxxw12RE",
      "name" : "wDfNoIy5Pa",
      "email" : "JtVCkQbT@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:09.373842Z",
    "updated_at" : "2026-05-08T16:05:09.373842Z"
  },
  "created_at" : "2026-05-08T16:05:09.605189Z",
  "updated_at" : "2026-05-08T16:05:09.605189Z"
}

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_3lSyTPg2nIQf8R1DPVtX9T/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNjY1MWEzYi00OTZkLTQ0ODItODJmOC1jMzg1ZTFlYjEyNGIiLCJqdGkiOiJiYjUxMjBiMi1mMGY2LTRiYjEtODFmYi00NjA3YTVhOGQ1OTYiLCJpYXQiOjE3NzgyNTI3MDksIm5iZiI6MTc3ODI1MjcwOSwiZXhwIjoxNzc4MzM5MTA5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzRpOGhXaGlqbjBFR1RtUGt4Y2xWZUciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.A5WCApUQ-FkUZ04LdzP2lDDshRcmbCZ6ZAZ9eOynUgA5_-lJ1PUGEkxUjyXjoqF5Rw9HZK7Eggac8-PnAoKuNyNS_X_NcIzbt0CXOw3zTemNkPWUSNiKQ1P76HQwSRg-yL69iiiEzj778XAOL9b43Qub8vdksaPudewmBtBiP97usHC_pjDc8A_KJ7WF7BQoKHLkBb84WtbwEbQQYTuZ7jqIJ2oDW66pnXls9DSVhjX35XTjiDEzcePLVHf8C1i5kqLQ3pOAn8ZzyJmih7mNWHoHVSuk2J6j809fay1MBPVmDi7mRIkXoK52yC5ClzTG33IBcf5iHBk0QP8N-vsLXxzkfWxTV1MKO44BtjwAu3c8HnDINXPHmod7j7VOE5T4UV9zbCWtofqBX1HDpnRDwj-98LYk6rlxcQigZOcH2Hg6JqSqpxXs0ObXfIAGZsvZswMpLxVRFBuRqmcJD7Io0IkMt6s5ocGI3grZCdQ-1N9pEh05370I5HNCRexV-ecRwGknuEXaBFkuLxTWDk3A9K0lR8kbb4OJKSekSuqCnQ9BOxKF148BhEnLDDNpK9PcOzMFgWjrLvmTJsG5a1-nIODNfY1yWlMkbgP_eHu3l06In9cwtf7LXtG-81vz7lyinMilKsSZkSgB_l2iP6h-c4YpCgI_ugLI3Ao2GC7_4PY
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: 2370

{
  "data" : [ {
    "id" : "tmt_7YrR5iOmu7wyJtnFVfJG9g",
    "type" : "concentration",
    "name" : "NQyQ2VQ0y7",
    "label" : "Test Treatment Label",
    "external_entity_id" : "Zp9jBJpJLG",
    "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_3lSyTPg2nIQf8R1DPVtX9T",
      "project_id" : "pjt_1z2I3uQlCirASeOnyrNBQW",
      "name" : "tThXwmGi4v",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5gaFo4sSeiB4D52FJv1V0T",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "pWxNb17h7N",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_60Vy5d2XXF49DhFFGTjJmL",
        "name" : "OyTBXRYXf0",
        "email" : "i1CMuFMf@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60bmL3Ag3o93nhzfU02BQJ",
        "name" : "e6oxR3sK1l",
        "email" : "40p4c5RB@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:09.084150Z",
      "updated_at" : "2026-05-08T16:05:09.084150Z"
    },
    "created_at" : "2026-05-08T16:05:09.319053Z",
    "updated_at" : "2026-05-08T16:05:09.319053Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_3lSyTPg2nIQf8R1DPVtX9T/treatments?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_3lSyTPg2nIQf8R1DPVtX9T/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_3lSyTPg2nIQf8R1DPVtX9T/treatments",
    "per_page" : 10,
    "to" : 1,
    "total" : 1
  }
}

Study Task Spec [BETA]

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

Object

Sample execution configuration

execution.sample.samples

Array

List of sample glossary identifiers

execution.sample.auto_generate_sample_id

Boolean

Whether to auto-generate sample IDs

Dosing Execution (when type is dosing)

execution.dosing

Object

Dosing execution configuration

execution.dosing.treatments

Array

List of treatment identifiers

execution.dosing.skip_dosing_for_un_required_animals

Boolean

Whether to skip dosing for unrequired animals

execution.dosing.use_new_body_weight

Boolean

Whether to use new body weight for dosing

Observation Execution (when type is observation)

execution.observation

Object

Observation execution configuration

execution.observation.observations

Array

List of observation glossary identifiers

Measurement Execution (when type is measurement)

execution.measurement

Object

Measurement execution configuration

execution.measurement.measurements

Array

List of measurement variable identifiers

execution.measurement.weight_percentage_change

String

Weight percentage change tracking mode

execution.measurement.assign_identifier

String

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

execution.measurement.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-beta/studies/{studyId}/task-specs

Parameter Description

studyId

The unique identifier of the study.

Request

POST /api/public/v1-beta/studies/sdy_7TJYksIb5lsbQNauFaSGMv/task-specs HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4ZjRkMWQ5OC05YzhhLTRlYzktODk1YS1hMzE0MTQzNWRhYTMiLCJqdGkiOiIyMjZlNDhjYS05MTA1LTQyNjgtODRkMS1lNTFkMGI5MDJkNzkiLCJpYXQiOjE3NzgyNTI2OTUsIm5iZiI6MTc3ODI1MjY5NSwiZXhwIjoxNzc4MzM5MDk1LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNW1FN3FObVY0Ykc2SkxOckNtVHRxTSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.OsqwHj3_AgIQXHzM3ZDQt0X3hBT_Wc5Uh5zeEDLBmIwMF04JcQw-XipYCAXcqABWBHbWLmWxPTO3sOaHrAd2tDmBTip7rO9XfJi_l8pO7nVc8XHZE6-zJ4xAczZmphWgqIqRryiMMQcIuye82vv1SbVaul_i0hHjB-aWjKrvuSIjDG7e990SU8hPCDWkSQFfqunBR268ifJS7yk7toc1bTjNRcZfJvtzOrBwsImzWN5p8LeECg_2kkA_gu5Hv1uYyrpTImyZHIbTb_-Sg6bARXpllicpmivDUuXlRw9qsg0J4yoYXxibH672dJwv3FwVFO_90IbKtpVN1Vwad-bxo_GAOumxjVi6eeCYYyqsUTjaHrPwQNo91ysNq5Cjx50YqTJa-VsPSuTHtRIQGNar52M6NsoU08FAKu8PEu-7Euj0ZiHPn5sIpS_VCct1bWuPotzmzo3fmiqhRn9ICXMBGLtLxAIUBtkjtXSRb6utkU411MrXjuVjEVIDuwAzniNU3rSPmL9mxI5HzW_CJeVA0y5D-ZhoyL6Pb572CmeTeLeqn7iVu8noKViNXIo-QE_J1-qX2rFyDqDWk2gtMBSARyC0yRQKnBsNnqAB6PNtyahmKPoVTrRNunB6nL3DG_ri04pGty-P4dE6KPM3SWmALsxhd8Azjj2Dstc5yX-24l8
Content-Length: 797
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",
    "measurement" : {
      "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: 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: 1925

{
  "id" : "tsp_78uChD83X0bv3mkUpZfjYZ",
  "title" : "Weekly Measurement Recording",
  "description" : "Record weight and body temperature weekly",
  "type" : "measurement",
  "execution" : {
    "type" : "measurement",
    "measurement" : {
      "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_7TJYksIb5lsbQNauFaSGMv",
    "project_id" : "pjt_4sCJzSeT3Ncf0ld6tthw5u",
    "name" : "q7r9h3GzsA",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1D9EY7Ajdc9EKFML4fTHfr",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "xeAx6qbr26",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_A1KiObrjqD3032r5Rh4pl",
      "name" : "biAX6t8PdB",
      "email" : "Ypoxp92N@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6opuoINR8Fu0cNZzouGndt",
      "name" : "0nAGCVLrW7",
      "email" : "oQ1tyrYF@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:55.778272Z",
    "updated_at" : "2026-05-08T16:04:55.778272Z"
  },
  "created_at" : "2026-05-08T16:04:55.950957Z",
  "updated_at" : "2026-05-08T16:04:55.950957Z"
}

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-beta/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-beta/studies/sdy_6il79Rdxpf0Z3LLT5IOiGs/task-specs/tsp_4GiEyeVVfdYX362uuACo2j HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMTgyMDFlNC0zOGI5LTQ3YmItYWU5MS03OTA5M2U3ZmUwYmMiLCJqdGkiOiJhOTQ2OTFhMS1lZDJiLTQzM2UtOWQ4NC0zYjM2MTc2YzNkN2IiLCJpYXQiOjE3NzgyNTI2NzcsIm5iZiI6MTc3ODI1MjY3NywiZXhwIjoxNzc4MzM5MDc3LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZLekZ3ellpTnk5NTJyRVE4SDkxS3IiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.VpcOkGxN7sV9Ulq3ycuWHXCSP9BuFxib00inJ5INBG_HtQDSi5zdhlp01V2YdjM9QbozxWzvOmTvGZeakeNZvC-Ty5435U6Z2CyBSe7Ce7stTMV5aztkneewfToifE22bvu7ZvXwvOhI1w1wJBLfEStuzidJQdoNv6HBO0zufHzlJDGQ_u0DoV2BPC7eOX7MNnwu52cSWgTzW8dCHWFmcP5MVpoy6xRMDWPHRkmB4HmRZKCQmbXYgSr0EoP1HtQefrBllaqIoDhi65RNHfeA9svAu9r-W2bIUhKkxC9G5Qv7JTUVO4sJx-IiKhfWG1jDoUvl-P5KFkLS2Fs9I4upb-VnfCnju3RpAXdQPeabtZleInVB6SApQKCAxcECTjbFHKKJplTKwOz73hHmRO-_RKBugjzXHbZ4ZpwpUN-BNNrANb3kOi6QivptKqYuKK4ClM4baeLiNQD7d4NJelCi_TzLv76qS2H-mVPLzfyNGun3f-QR1tNj306nljddwHrB3j34U-FNpNTXP2wzFJkjccNY_k7ImKV9kAvP1__-Tylg52b9JWUWOzV__CtSKuOF25bQtCbT5w9hQ9jppmBCY1s8ZdBgBkXzvTK_C0aM8RUxeY-wyJpSMbiDuf9KAb_8hpw22NvRJkDp9HdZEto4FI1W20Qcri0gkifDGjCrM80
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: 1654

{
  "id" : "tsp_4GiEyeVVfdYX362uuACo2j",
  "title" : "HPlS5F2YQ5 Task",
  "description" : "vg5KMEmplJ Description",
  "type" : "dosing",
  "execution" : {
    "type" : "dosing",
    "dosing" : {
      "treatments" : [ "tmt_6KUfVBZvzgobkOEynJjlmy" ],
      "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-05-08",
        "end" : "2026-05-09"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_6il79Rdxpf0Z3LLT5IOiGs",
    "project_id" : "pjt_2HKn4RHoCE30uA8huSLyku",
    "name" : "TFlCE8IFQz",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_41KMxLDLkF0wIWaSn4BPTh",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "l5SUmaoI2C",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_3cX7L58MTj3Agh4ek920mC",
      "name" : "fHE2BWTLRk",
      "email" : "hMcARXAV@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5P7qD4pTGSSWs1MOoH0mut",
      "name" : "2bUWIS6qSl",
      "email" : "nBy8vf2t@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:37.549105Z",
    "updated_at" : "2026-05-08T16:04:37.549105Z"
  },
  "created_at" : "2026-05-08T16:04:37.817591Z",
  "updated_at" : "2026-05-08T16:04:37.817591Z"
}

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-beta/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-beta/studies/sdy_7NzkbrfzdikBhbJjKJdXyY/task-specs/tsp_4jS1gDD0R9bIOpodYRg31K HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiODZkNmJiMi1lYTAzLTQxYTQtYWI0MC05ZjM4MTlkOWVhMWUiLCJqdGkiOiJhOGY5MjA5YS0zZDQ1LTQ2OTMtOWU5OC0xNzM3MzRmOWJhMmQiLCJpYXQiOjE3NzgyNTI2ODIsIm5iZiI6MTc3ODI1MjY4MiwiZXhwIjoxNzc4MzM5MDgyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNFNYR0paSnEyRUp4eWd4Qk90bVU5WSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.ICqduMQ8pOHHpyhxrZfNIwPlYfdoBoFb9BTxSkvlMcxb60SBWB0PNUJGdDu_BIpEPzMMnF7nUF6hBWW4VCn_EM77OPcdku40zAnjNX-TsOFsqPS1o8py-8oWAD9viGa3BJySrUBPN-2AqRvU8IZP-2RgOWCd50VKivdivdMdblcuAVc-Yilgza3Ax-tCNpCSGconFZL2PVRbRfqB8-KsdiUo7jIy5JcZ5u9gDNyI1HK8YNz17Q7gy9XGA9eIpd9cWT3JJci8KO-Qnox53730iw61nC-rL0GYRYFudLuJiMmRnWj9L4tph9kw7lRdoSS-xRXYDeIqhDVx1z8_LePsNqDfBeb4PUukf200QbCmSBARwiMqHt3wA1jKQtz5xrIcRZICRJug8VzmG1vFdKr10SqQkZUveGNrwdMo7CQIW5s7SRzTTnYrZXWZ3s_oTiWaQB1vp8zrMZfoXBjzP8x0rCNtPMq0W2szRh36BCbw4x4L8mfDLH8I1b5qV8FrOZk-muqTIFceAPBGvV6ObNU1QLut5mOUOuVSKbVEbLgRubJeIUh_C6t-9lcTdfTozMfNrAKQdsMqY3yfrpPqu3ESIWNnWU9hQwMsBctWXn8Fg2FDS_H-BsY5wKBzDRiDcpPiMlMYm2WVLQAktxL2WE-A8IsbkVFJzgkr_7ydiQ72ggc
Content-Length: 242
Host: localhost:8080

{
  "title" : "Updated Task Title",
  "description" : "Updated task description",
  "execution" : {
    "type" : "sample",
    "sample" : {
      "samples" : [ "tgy_6fVsOyBM59zPYJ5MuwUBdT" ],
      "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: 1606

{
  "id" : "tsp_4jS1gDD0R9bIOpodYRg31K",
  "title" : "Updated Task Title",
  "description" : "Updated task description",
  "type" : "sample",
  "execution" : {
    "type" : "sample",
    "sample" : {
      "samples" : [ "tgy_6fVsOyBM59zPYJ5MuwUBdT" ],
      "auto_generate_sample_id" : true
    }
  },
  "schedule" : {
    "time" : {
      "type" : "all_day"
    },
    "timezone" : "America/Los_Angeles",
    "type" : "one_off",
    "one_off" : {
      "duration" : {
        "start" : "2026-05-08",
        "end" : "2026-05-09"
      }
    }
  },
  "target" : {
    "type" : "animal"
  },
  "study" : {
    "id" : "sdy_7NzkbrfzdikBhbJjKJdXyY",
    "project_id" : "pjt_6IFqabGVTzw8Kb2R5XWLqb",
    "name" : "lZWbBOZQ6R",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_60uslI0lImmoXQKOFKoQjh",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "beKFeXbjxR",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7kDrcdeZ90EwzwBZbvj1L2",
      "name" : "RMKatHHMeT",
      "email" : "gZErxzeq@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1UpGJHloTjL923RxLKVaw",
      "name" : "K4GJh7vKeY",
      "email" : "GFI1Sghe@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:41.950291Z",
    "updated_at" : "2026-05-08T16:04:41.950291Z"
  },
  "created_at" : "2026-05-08T16:04:42.103982Z",
  "updated_at" : "2026-05-08T16:04:42.129161Z"
}

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-beta/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-beta/studies/sdy_1ZfB3loftecx8LcPYWjY7M/task-specs HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MjMzNjJkNi0yNDY0LTQzOWMtOGI0OC02ZTA3MWI0YTUzYWEiLCJqdGkiOiIxMmI4NzM4OS00ZmIyLTRjYTEtYjVjNC00MjMzY2NiN2E4OWEiLCJpYXQiOjE3NzgyNTI2NzQsIm5iZiI6MTc3ODI1MjY3NCwiZXhwIjoxNzc4MzM5MDc0LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzNPZnBZMllFZkxUU1ZNcTlDQ0cwamQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.YQSLfQn90I8h_5QULzARhsTiAAEbSrXKTdyFksEAOq-7UbWYYAvd_HhbkzOX6QMGkBiG8UkN7Rob7CCvf3e9iJ9FeRxaNmjEqV3ixKEmoAUWUX4ySjnD44yFeSAaGn7oEcWPX0NcLPgBHlUqTnKRiIO_MYXACqHd-45GuGV2s0j2fvhyXibpZWhLNey7k7XAsR4FBMvJt-dVn34Ievn1p8b-q504E3JBF7H1_7QVtFMY6KRoXuCltNNSZoYT25Auxbh-O3pCEqrn-Ljw8IHURofltjtO12rQEmjXgl2vskOGT9R2IJFVcWBQSKCWlWfewJyn2lBYZVbJX4itKc2adELkKiRuJQ5ruLynq7DlzR7C8deBRYRlPXo_pBYCK6_OnQ042sWB8mm8Q29-e4sumjnfHDq2jYiKo2Csy8alO_XZwYTtQHMwM2ynWuLOZqpsVehuCeduGyeV-MK1TCsb5l9UJ2BpmY5UQQTfrmSNhk58u2mpRU-1ZhqDso7NX_W6KplsnW6BLIjgv7I3zYoNUIhAAhepqhQBgLo-deKhx7c5r6DQ4wb6XPeEV6K7I7h1yE_A9ZgWbbFfnp0NJ8IjsYVpG4qAX90LED83MnWw9WTaArOOANHBz5Nex8tkyclHbk7YlrN0b9XL4ODgtujczJgb13YK103FdsuLmxgHPC4
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: 3886

{
  "data" : [ {
    "id" : "tsp_5Tz7cqhdoYHEy51UUdHYVu",
    "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-05-08",
          "end" : "2026-05-15"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_1ZfB3loftecx8LcPYWjY7M",
      "project_id" : "pjt_3epqOcHmk4uHlvTXFhAKPV",
      "name" : "5vpBcsyyri",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5Dlq3vMT7Zzn5hesGzqxhM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "8cIEe4CYQD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_3xMhV8jvFyXNp5SwQIx8tq",
        "name" : "RbxHFJgkJY",
        "email" : "iAuPVnvR@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6kULfhyAwK81IjhRbUafln",
        "name" : "dZ3R6roGfC",
        "email" : "5i1CKevN@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:34.210611Z",
      "updated_at" : "2026-05-08T16:04:34.210611Z"
    },
    "created_at" : "2026-05-08T16:04:34.437759Z",
    "updated_at" : "2026-05-08T16:04:34.437759Z"
  }, {
    "id" : "tsp_5u1eZnn46ilw86k636z1kn",
    "title" : "vQkdRTeuCE Task",
    "description" : "yBl5kOgOrW Description",
    "type" : "observation",
    "execution" : {
      "type" : "observation",
      "observation" : {
        "observations" : [ "tgy_7QoADj5rPcjYEmRMgf2hJ6" ]
      }
    },
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-05-08",
          "end" : "2026-05-09"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_1ZfB3loftecx8LcPYWjY7M",
      "project_id" : "pjt_3epqOcHmk4uHlvTXFhAKPV",
      "name" : "5vpBcsyyri",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5Dlq3vMT7Zzn5hesGzqxhM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "8cIEe4CYQD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_3xMhV8jvFyXNp5SwQIx8tq",
        "name" : "RbxHFJgkJY",
        "email" : "iAuPVnvR@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6kULfhyAwK81IjhRbUafln",
        "name" : "dZ3R6roGfC",
        "email" : "5i1CKevN@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:34.210611Z",
      "updated_at" : "2026-05-08T16:04:34.210611Z"
    },
    "created_at" : "2026-05-08T16:04:34.444182Z",
    "updated_at" : "2026-05-08T16:04:34.444182Z"
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_1ZfB3loftecx8LcPYWjY7M/task-specs?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_1ZfB3loftecx8LcPYWjY7M/task-specs?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_1ZfB3loftecx8LcPYWjY7M/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-beta/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-beta/studies/sdy_53gfLxG9AJmw6hi2JDceQa/task-specs/tsp_3PM2jzJuANJtwhm83D8HtP HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZWY5MzE1Zi01ZmNhLTRjZmQtOTk1ZC01OWM4NWRjNzE0MTUiLCJqdGkiOiIyM2NjNDZlZS1hYzIyLTRmMTQtYWY2Ny0zMjBlMDMxZDUwYjkiLCJpYXQiOjE3NzgyNTI2NzgsIm5iZiI6MTc3ODI1MjY3OCwiZXhwIjoxNzc4MzM5MDc4LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fMkJaY2FWeTVhRHZ1eU9hTFJqbmxuVyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.Y_Wgwc9V6S4MtlDd6OFQexmhjtTa8txf_KqPBs7KdczkEo5ppSX-kF8KCKPQujTdl6bUCyajNpOH8xYToUvur1qcx4eksKVsHl6IW1ffYV4FtEB16AdgwJQZfM_wUNQXLF6y95Tf4PG-cgFfmMQ2a1xbMXSzgpfOwegVWBuwRf2mNAxsGzEoH_PRMsVS-yOl0NPySA1kfCb302vorboRh-N2QmiSFD6OLFi5hUaA8KKOscRoAoe0nYkQGGvQYHSLiNkcli3lbmYFulcySVba926c6OuqsT_WGV5QgtpbQ6dO_okJZ6MPudQHwn3hXnW9WC8YVW7nnX3NBuJpmNyFHtQFM9tm18G6NM984lzKz1i9UIV7_s4k07uFGmhie6Rj392rvoCRt0pAUL9dlBTz4EPEvughiCjJEeODcUzB_m4Luamo0dhXOiXOmUBckfFBFGHEqxGMtwbljMiCPknwXUU5ZDyhnP3PWH9m4ddQ3syEJ5HtW1E50-GKssIE6CYBYS1Anwwedy5XcYPYT-DqCtP-V6ksGyOhP04MxmFc7C-f9e8NAQP4p5eqdznY2_NPTeRibCoGKqDB6Cs2ITqzuJaOycf-f70mJO_zUzUkcWOZqbCHBTsUFzMr3VunchVnZ2_tUuagAKEbj1Qkm1dc1ko2EyN5L8Y6WwfGA53U_aU
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
}

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-beta/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-beta/studies/sdy_1KcwqbQVTUiB2OAKYCP7Jj/task-specs/tsp_4UBmNtuFXFkfteuqmC2Vyq/assignees/add HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwYjdhMTc3My0zOTcwLTRlNjMtYjRkMC1iOWMwNDIwZGIzOTUiLCJqdGkiOiI5ZjZhYTVlNC04OTE5LTQ0MGMtYmIyZi0xMWUzODY0ZTRlMmIiLCJpYXQiOjE3NzgyNTI3MDQsIm5iZiI6MTc3ODI1MjcwNCwiZXhwIjoxNzc4MzM5MTA0LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fcXN3WmY1aG9ObnNYQXQ2a3hYSW5kIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il0sInJsX2VuZm9yY2VkIjp0cnVlfQ.GRr7Bq1O3UBMw0l1LJhpyAypxVzvtfWDwMr56eOYZiIXuO653H8lsACY7wyVGtAUi6WeR5buNLu8uiVdI8DSuxXQfaXw3QkJKk9AGIOCjcqxPJbB1Q3zhjNFGufb_apEUI8davMDGV0W5ZvbXv59GRiE9MFtT-X64Kd0wHtzyiKlvHYnOIBxqKtJMAceerRhHglcJMFKvmcZNb8D-RlnferNqfW7BzjU2mOOp6bdYamI9h1EDaecS069tQW_lD5npwt0uaxfy-PB42E200XR4MOfFOD906WlJ20p46wLViSkErXxGVfrDBd4boHNYbgCnTm2JLc-BOk8muWtLorMviFOt7PelZSup95oBYvM37DHy_aynMwuBMjSHmlm_Bgo6E2c7BW-bCKMKsuNWE8OPSl2kpggk9oc0W748aX9pTfV65-66_vO0tv0n7q6l_2NBLAmC_O6MVCSfCK82Cq3hW1oS8um3UMOx5OkXIUkVDOMcpr3M2ZDK-eDQd3ur9BS5VYbEtL8hhLhIYGGRYO3rA7FT6wYDSWPIx9bBM8tCseEGASO7i7o1d7fLCJ2n2JSZuSz0tGcl1sFa-niT5xShSiDY7UmKIRxNdXmKKZh8L-9OaexIMmmeyqApj8Ac27EPU8E1gc4jIW6fwZMjD2XRf3TCLc4AcLf9QHWmOHaBWs
Content-Length: 96
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_443gexAKFqmNZK5IJ0Gupu", "usr_3kGl10bZhBixrcicgwu5JV" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 26
X-Content-Type-Options: nosniff
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-beta/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-beta/studies/sdy_Nf0hI6crMJMCn2lXw55Lu/task-specs/tsp_7aCgszH2bMShxwygypf5rt/assignees HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3NWJkMzk0NC00YmE5LTQ2MmQtYmY5Mi0zNzhhNzJhMjE5ZDYiLCJqdGkiOiJhMmY5MDZlMC01NDcwLTRiMjgtYTk5My0zZWI4YjAyNzhlNGEiLCJpYXQiOjE3NzgyNTI3MDEsIm5iZiI6MTc3ODI1MjcwMSwiZXhwIjoxNzc4MzM5MTAxLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdlRVIyREVPVGp4Z3Jka0R0cjdKek0iLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.ieiFBH8r3irmoE1q7LufQDauAUozQx7Y5t7oqi2RvqYtrAeVZUc8q8sjvpQ0TurOLPksYSvr7op5erfwdt6xhV0KL_UvigDbOpkD6Vz3K44nLUO2A3mrHDt-s9ugA50ekW91WAWyntsEPAh9zhe7RcX3mHxKcqX9VuoztuFLAZwTtTsWusk9RS9GA-XygHebYQIB8T29b2vY0fIVIGINKLRB3uIbhjgW6YCmvzfufQWfjYMVD4WoXKxrltfTJKOLkYpXI3YzKrRJ57lT9ghLN85W3J_ulkmBAgwVlOhmH7tTdIx4mfI3b1bp4sNMHdD4QUfx7ZnybkVvnJmaf1q6fgL9IMIRrz7LkmYUkXu1_ZD8pzSibgXzYTOdjaK10mNP0w0uOrXEDJ4eSUBviteBcx4Wz-FSu-NvDsGdi19tSgqeL8bDgkqGlq3jxrl9JACnXZHUFyAm0q5ZYOoT-rj9SU5fE2CGs96Tbuow2xiVo5H-iBbkjiK87TpWWQXCTZAI8q6cbon9Y2i29ihzqwNMN4oB10Q86A0nXd_4rpcgT-sOu4YS0zq2_pIV0JTPq5A6LTJRvu2SDLD46Z7mWrtgH2ckiHEt61KmljbLlOYLBFKBb-2lCj6aAzOM3MHNVBWJzKOp-DxMsDVy04odc95WkRZE5hzhb9FMAW0JrQ4S2Yc
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: 1321

{
  "data" : [ {
    "type" : "user",
    "user" : {
      "id" : "usr_2DySQbwJXsWZBMVsjRq8Lm",
      "name" : "A1TSBgmnra",
      "email" : "ljAlw2aW@benchling.com",
      "assigned_at" : "2026-05-08T16:05:01.281360Z"
    },
    "task_spec" : {
      "id" : "tsp_7aCgszH2bMShxwygypf5rt",
      "type" : "other",
      "title" : "Wt2VHK50vW Task"
    }
  }, {
    "type" : "user",
    "user" : {
      "id" : "usr_2vsGBzRxKib2VgKQ1oR3tI",
      "name" : "IWaX8OnVHP",
      "email" : "tn5R9PFQ@benchling.com",
      "assigned_at" : "2026-05-08T16:05:01.284494Z"
    },
    "task_spec" : {
      "id" : "tsp_7aCgszH2bMShxwygypf5rt",
      "type" : "other",
      "title" : "Wt2VHK50vW Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_Nf0hI6crMJMCn2lXw55Lu/task-specs/tsp_7aCgszH2bMShxwygypf5rt/assignees?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_Nf0hI6crMJMCn2lXw55Lu/task-specs/tsp_7aCgszH2bMShxwygypf5rt/assignees?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_Nf0hI6crMJMCn2lXw55Lu/task-specs/tsp_7aCgszH2bMShxwygypf5rt/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-beta/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-beta/studies/sdy_5zVzB9fyqSD6vrNTaLs97X/task-specs/tsp_1Yi3Rvj9fdC3xNIeTVO6JY/assignees/remove HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxNDY1MDQ2ZC0xYzE1LTQzZWItODZkNS1lMDI0NDQwNDQ3M2UiLCJqdGkiOiJiNDhlNmFlZi1lMzM5LTQ2NDAtYTBjMi1mOTZjNzYxZTI2NWYiLCJpYXQiOjE3NzgyNTI2OTcsIm5iZiI6MTc3ODI1MjY5NywiZXhwIjoxNzc4MzM5MDk3LCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fNkg1UjZrdGhaZDByOXZJbzFjYmV1MSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.G2JWKG7wqVjCQiAThEquJo3eWAChNeG2wJCLPW6xQejQIqp-DrUyVUAb8YVczG2tF3JinZZMfVSrcD3tqbRJOCw0t1blOOfCt1a6JJ3P9-NE0aXNhghRae4FZBGR_5CMKt6UCSYtvby-ZhuRtAnAI8DtfqFwccCbGqFRdUQEwq5x9vpm7yBu1WPKg5irDQf8T2SZmoLYirrCWcz92BRJdCyQTHKYr9tM9huAjJUyDF43FCHFzpOhncXRQOit1cdkU0uwr7kYQgpPoM0eO7H86Z5GNyGyVX1j7pVhaJTSj20n-IWjiwqRwsLPueTmgSJjjWENBYQ8lXzDXicE7l0itLFqmOIZ55MTD8rHNZLX4-oGJ6Fe3LvJ9tir__85gpB2kbYczKHK6GBHTEAwaxnumOLpr8qB6gMDAS32_Rw74Yn_DWKF8ZtkGoFLbxuA9QJvhnPsHIeyhjFDI39aQHIUl7Sjy0zRmT1NpTn41-BVNJVe_QmvM5rn8gBAloeyOpNPsGj4_ZDAj3W6dg7u6d-AeeFeN_KZ8T2E4s_6iBSEPlrjwpPy7IWLB22MzkaYMdM3anc5glVh9g5qwiRE01h7t6GaJknezpubAg_Q3I8c3PIEdfzxJT-XSm31GyKaavU1yS4kuSMZjn_dlWFWR6bawdStnpyyDj3pzRUeR8Cf0WA
Content-Length: 96
Host: localhost:8080

{
  "type" : "user",
  "user" : [ "usr_6Uvsr4i4sIp9yV8OdOcbN2", "usr_1iEUkT3H0nznd1bf5ws7T9" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 3
X-Content-Type-Options: nosniff
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-beta/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-beta/studies/sdy_5dM839J5kgnW3jAqk9o7iQ/task-specs/tsp_OoDMsIdirzoktrrAAU66Q/targets/set HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZjdhMjQxOS04NzdkLTRmZTQtYjEyNC02ZTMwNTU2ZTUyNmEiLCJqdGkiOiJkMTdmOWYzMC1hZjVmLTQ5ZjAtOWJkNS1jYzE4YWZkM2I3YzUiLCJpYXQiOjE3NzgyNTI2NzIsIm5iZiI6MTc3ODI1MjY3MiwiZXhwIjoxNzc4MzM5MDcyLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkudXBkYXRlIl0sInRlbmFudF9hcGlfaWQiOiJ0ZW5fUFNYQzRLRlVTZkNYSm5RblRGZGdtIiwicmwiOlsiMTozMDA6MzA6ayIsIjE6MTAwMDozMDp0Il0sInJsX2VuZm9yY2VkIjp0cnVlfQ.QRQo6ZTHiSYaO_JhlZUE-HxSXyD1BB5Pl3t3C1dWn-LXGg1PeDcc6ZJtpmh7IXv2DOP6Ypl7RVHw28cYi4Qu5hq3NTpA1qK5VwIyXw1SELj-oRNGvMc9ORoQodRcEs_ZyKQQ9BZxzJrkfXewm9bA3n8fH95kwDUhfQLS4smHpF6XNY44VrbZ2rUAiwX0gDW7LZWjzIi_gvKU15FgaJV2LBRjqzIMyETWWPqLa2REM9I1Lk9s8oTYezNL45oHeui94oOYBdvNQ_bJpEh4Kbv-sWs4btb4IwEJpqx6UcdwvqkfINXhCKwxrfJaNNDvs6wUK1b1JbrnjTJqbiJXz2OL2S7BjlopqYc5b_RhuuRQksELUgIWiai3SY3mLO4Kway28eGu-DwoG1SDTZj_J3_i81AFGksgIRNmlhNw-WfTQjqahMfJ8xtzzKi7WbPbqBcUWELVV31PmDY6wfSEpe7TVOann9EPIe9U--mqsHmhkpfgoxvS3HRhXtgalW0pRaN_9eaK6lMLDvIHW3PuYtScbrJ7Jd_x2fd2CioHhrCrFaLPfmmW3lrGVm_iSbq5bXjgnPbb8x4gbb_62lT5KVEACHyam3ex5ifJlrcInNkOcVq3TgTMQrrscLNG-I5KBe0vc1YLFkI5OBxhNzCgh1Zr2fADUvYdSC6rjPZuB2N8zVg
Content-Length: 98
Host: localhost:8080

{
  "type" : "group",
  "group" : [ "grp_2WzlFoHJGweoQeqqQqQ2Ds", "grp_225pgpi7raz0XvO3Q6LlAT" ]
}

Response

HTTP/1.1 204 No Content
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 28
X-Content-Type-Options: nosniff
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-beta/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-beta/studies/sdy_4a38gGxvQsneY05ui38M3N/task-specs/tsp_2D6nfvgF6WydIHtbaFup6I/targets HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNDI4NjlhMC01OTUwLTQ1ZDMtYmUwMy1iOWM2NDdjNWZhYWQiLCJqdGkiOiJkZjliNzdhYy1hOTQ2LTQ2YzUtODZkNy01ZmEwMTM1MTE2ZTMiLCJpYXQiOjE3NzgyNTI2NzAsIm5iZiI6MTc3ODI1MjY3MCwiZXhwIjoxNzc4MzM5MDcwLCJzdWIiOiIiLCJzY29wZXMiOlsic3R1ZHkucmVhZCJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJxeXlNakVraGs5TTNqb2dyZjJ6VjYiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.KnCIS5c2vx_VGo75APlFvziXgEqkAdsZoi5PxTuYJ2nq1Uq5JJ_-lR86--aAj6mZeWaNDcuSsRRiAr3-5CJHKbE9KNsQZFVXZPYp7zIahs4atznQ7ij9mmCE7VsDHl2jeQURxHLGfnVJfXSKn2zkwFB14XVWaVEMNNfUJBSfjTwNEJx6w7p5Q3mgOz8fUuNqnuw9aMydjHGVsdHxH5VuJeQYCQS7yvpot_gotq8KpwwYROS8IcMAJvl11llHAIVuQr6wZlXO-2HcJf6f8r-tLuaFRu-W90eoS5bijR0S7OAtGCQcSEuL4S_PpqT2Z_Z1o_G1iaKicGcfWT0m7g64GUTPU9_JSQ3q3QWwGMtf-COcVqHxdh-DYwWY2fyoHJhonb9_Dj3-GJ1j4TV3nkhLYtQoGNaMCWmqMK46o3s0jt1sPjU8O13LkoagglIXYzmXslNqvhK_M_MBo---xQBQ4q0ukl3pzupuqOvopi00Mo5Mrla0x7Zid4wz2vLQB9imHPkLTD0t3RUYWEkjHlfdTHra2hqjldPzRQQ3-cOKfHTKjO1fW1LisvmH8p75ok761Iu_X-db_OKBvNFO0sKAiIXAkeB-r5CJ5RwfLPpdYEz4N8xcgvy4tmdatCdvLdHFu0jfKRzGHxa_thb1snODzHfBaMfNPtTD_m_7Fr7yKOc
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: 1232

{
  "data" : [ {
    "type" : "group",
    "group" : {
      "id" : "grp_6CtGT42oSNKnoxGyAxO4LT",
      "name" : "VtqxZOvIGt",
      "added_at" : "2026-05-08T16:04:30.865528Z"
    },
    "task_spec" : {
      "id" : "tsp_2D6nfvgF6WydIHtbaFup6I",
      "type" : "other",
      "title" : "bPVoqQ2Xje Task"
    }
  }, {
    "type" : "group",
    "group" : {
      "id" : "grp_65Zv3CveSFEIG3tnDIXteS",
      "name" : "YzpJAI8aXV",
      "added_at" : "2026-05-08T16:04:30.865528Z"
    },
    "task_spec" : {
      "id" : "tsp_2D6nfvgF6WydIHtbaFup6I",
      "type" : "other",
      "title" : "bPVoqQ2Xje Task"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1-beta/studies/sdy_4a38gGxvQsneY05ui38M3N/task-specs/tsp_2D6nfvgF6WydIHtbaFup6I/targets?page=1",
    "last" : "http://localhost:8080/api/public/v1-beta/studies/sdy_4a38gGxvQsneY05ui38M3N/task-specs/tsp_2D6nfvgF6WydIHtbaFup6I/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_4a38gGxvQsneY05ui38M3N/task-specs/tsp_2D6nfvgF6WydIHtbaFup6I/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_3imqDoCTX5FZiGjjKPXJB/users/usr_dDICNpnUREddUvuoaTd0R HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzZDliMTUwNC03MzcwLTRlN2UtYjc5MS0yODQxMGI5MzJjMzciLCJqdGkiOiIzYzdiZTA5MC1hNTdjLTQwOGItOTczNC1hZWUzZjVmNDY2NzQiLCJpYXQiOjE3NzgyNTI2NjgsIm5iZiI6MTc3ODI1MjY2OCwiZXhwIjoxNzc4MzM5MDY4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZmb0dId2pITDBxelBwU0hMcHFkbWciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.UnNcOOSp8Gpmb8uWoSDykTQo2zVGPPALjNXF-cPM9nvm33eHE-lYDVIFJPsmqGsxF6hzMNIeP5QA5pC2pX_GZBf8YU5YwrWL5NQjSYhjiFYYTi2mfJVXj9bLahnaniBOo4fA8hNM4omzumhXrUJMQHMnS4H00jiGpMjRNhI8nnmz13Qzaw6EuNIRc6u7n9LA-FsR_4C6ubmzvo8j6Ls1N1HXWHQaAA0JX3mtWeEi4eDlJtKZjWfVCdRDU5ZcpVaQfKd17blXojX7maWVTW97ox5n_bs4XdacmuT_uZMYtmwMiYtioHpLNruV5FficUDlbpdgTXp5pLL1llp-CcjA_dWnZO33WikxUdhFL7fX5ftjyPhwmRx9wOD_kWpcIX8FyPFg35h9A3As3nFevWdU2HSb0NLdGF4DJ0Ijck6v3ZgjpT0yMxLj4ANooOxALBncmFc3sbqTGq4orM7I432cgnWM1H0T_ZwyFtnrBibnyzaDsFVyRKZfP2PF6ds1dwW7Vayq484bs1TEJ8rG4sSC9ATTh-tu31gzlm86PV4qJDjaSWOm7gms9W-655PPlN-0Z4FCARv-HVnVOoHO4wrrbpOKrGvtRhir5xXt_gLwGmF-LOVW-DEAPhCjbnA5HV_eM4P-r1aqkfogCU8aMte0z57k8PuW4lY3wetwY4ikEPs
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: 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: 1084

{
  "id" : "usr_dDICNpnUREddUvuoaTd0R",
  "name" : "t7VrxZ6Opt",
  "email" : "9tZLZSMQ@benchling.com",
  "timezone" : "UTC",
  "type" : "team",
  "access" : "read",
  "study" : {
    "id" : "sdy_3imqDoCTX5FZiGjjKPXJB",
    "project_id" : "pjt_40TH6Le54XtOO0QOTHDsRL",
    "name" : "cmEcJjUU4W",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_2atWlS9UFd6IqG9I31GApD",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "JFat5HiOia",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_10TmlzXsvIOqpuH51V6QqA",
      "name" : "mpKyL4sbsF",
      "email" : "qst4x7pu@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_6uxZioLzqvxM8YpmXitNWI",
      "name" : "P7tDpipy8P",
      "email" : "uPHhSJec@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:28.527645Z",
    "updated_at" : "2026-05-08T16:04:28.527645Z"
  }
}

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_1J6G6dn4IxfbB8ZFj6vGxX/users/usr_3W6ILFLBtsPfmyX4caNxBd HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxODM1MmIxYy02Y2Y5LTRlMzYtOTkwZi1lOGZmZDdjNzJhNGIiLCJqdGkiOiIzNjlkN2U1Ni1mMjUzLTQ3Y2ItYjdlOS04YWYyMjljNDkyOTAiLCJpYXQiOjE3NzgyNTI2NjcsIm5iZiI6MTc3ODI1MjY2NywiZXhwIjoxNzc4MzM5MDY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzVzVU13STdTOHd4MTFKRXBBVWdCUHciLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.kCLrydYJEvO1Du0rZEUMgPppkMFV1UwgnENDg1BH529fkik0Z_3E1VxtTJpSG6H4HND3D_zwn4i2t-jut6zb4lZqpNxcaskhfMDZHZQnVvPE-aJESEVsGc-YxfNxjL8f5HjBgKII-aGbmZrwkLKOBxA5YRkKi-HFjHQ8zwAbeQ25sIabRmmlgUP2H15OHYk498q3Hi1o-qcW3GSDRxbSnioKLggUJnV8nTTWemAJ_9M8oy4Nvue_Gzrg0ThkMxI8N_MUIMKRwEUHgoTOZ46YskqsYbluUFxxLXzFEUTlrjj71IPUUd_EQZhuCSyP3HDfKkWXUdjnzawFIZzFpnjKYaaaaOIVIpb_Zfhm-4eNW1JWQQx9aTv9rfn1dgrsM3cvs6YXIXUtdY-mQENv6QpZd7Gh0Jv9NQ5jDfIy4hL9XBxYA8kPoqrWRdEbR8Ic1ibcsNTR5kaHF05qCC-rCOn2qOBLGXGSB4Bnbj42b4Wxt7WCdEWagd5bmR-uJvoQD9y-oYdbCLQ49EsEe-C_3Q06wCNwhS8MPLXw5ot7O_xHZ0rTz-Zpje7_OqbqwyZsozTjuv6Xk0_ewcUppED-iqupabXFNGgvEcp0Qql63w83Smc4oILwZVc6ZmJOSN9FiCfGjtEdmqABJlLzc1q6_jmHuU5OymP-lfZq58OEx4DSxZY
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: 1088

{
  "id" : "usr_3W6ILFLBtsPfmyX4caNxBd",
  "name" : "wg5bsbg2Vj",
  "email" : "nAi5Zvig@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "write",
  "study" : {
    "id" : "sdy_1J6G6dn4IxfbB8ZFj6vGxX",
    "project_id" : "pjt_UxwN7z8KssW1xcVaQATw6",
    "name" : "APGzzv12JT",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_1wuaYhqTKE1k0ymVoG9m1b",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "NFTDOah1ec",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_3W6ILFLBtsPfmyX4caNxBd",
      "name" : "wg5bsbg2Vj",
      "email" : "nAi5Zvig@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5xeIxSjw89VLMZ5YkrFIO9",
      "name" : "A5ALhYPI1n",
      "email" : "uekMRlnk@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:27.730637Z",
    "updated_at" : "2026-05-08T16:04:27.730637Z"
  }
}

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_7EA7cu6gmxOt5qb1pkb4DG/users/usr_348urBJb70NbWnaIA4WgjE HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzZjdhOTZhYy01OTU1LTQyMjQtYjg0Yi1mNzY1MThkMTZlZmQiLCJqdGkiOiI5NDBhYWI1ZC0xNmZjLTQ0MDAtOWYwZC0zMTRmYjBhZDNjZjUiLCJpYXQiOjE3NzgyNTI2NjksIm5iZiI6MTc3ODI1MjY2OSwiZXhwIjoxNzc4MzM5MDY5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzI3R1kxNlBVNndDSlBBTGx3M1h1d0kiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.aOCip6X0XTGPBDpSw0aQXGCwwqHtapA9uelCBUY3JoFGFs_BuqxM2cvS2NKcaPYmQaF9NQ1U8u4ZVx7s-QkWKz4G7s7WPXnDSYu2YWOK05qupO4tEfTypwW9vyIEknPC0XWQMmCyDgXfcUJpJccYraTx3OTluA_bniQce8mu0TIoNTw037uJkwLTO5NyDZsHwqDZwUH2pQXr9FaU5SRRldMm5Bu8ZKFSXUVStzjJaI1zTuk12CC5tefxr4CPXGMRbT2dn156XXy97sy6RAD6xMoOq0waDSW5I_9yfSjogQ3jecPO4h_S-aVZb4aGe3e4nIcbfiZNZBC5J7kdU-DvBJmhi759lE1MwpMaih6qnHZGjc9tpnYt-NmRUMZMZ6dIKcv7Qcc4WUJB0vr02NyqHHXeoLZu7wUk8quRPMly0jsTLbH1vqb9iVUbM5OnSYmaMSBhBwNLPbrXTD-cZfjcEf6K430XqtuoxlqKGk1LUCkSWo_TXf8jDBsuFGlv2XmSnduxj--2B797YV0nU_u0Y6WEt5wZurPn7S1C7RJeEUV6W2rbz2-9oFiZR4mMUScourJSF-f-ns2LxQ854rDc-sgYSgkxJZw3i29M-zPLXL6TOcaNictl5s2Jt48dv8p9jyB3M_W52M52qEs8M3r8wp6ylVJiUlq12IBGAKGrD_c
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: 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: 1087

{
  "id" : "usr_348urBJb70NbWnaIA4WgjE",
  "name" : "vVryOE3fO1",
  "email" : "pvUADQtC@benchling.com",
  "timezone" : "UTC",
  "type" : "author",
  "access" : "read",
  "study" : {
    "id" : "sdy_7EA7cu6gmxOt5qb1pkb4DG",
    "project_id" : "pjt_2wmlIe4nDhFzm3l3xehwIX",
    "name" : "xdYCGPUvnV",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_aVzEM6E3rPOFyGVay3Z4R",
    "type" : "internal",
    "started_on" : "2026-05-08",
    "status" : "in_progress",
    "description" : "2BYVtUBQN2",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_7QVjLtFIGWV6R3Km26MkpZ",
      "name" : "OdqnZIfzbw",
      "email" : "W1uY36Vc@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_5WwTSxGCzfaIk7EN09y1ec",
      "name" : "AjhoRMOvB2",
      "email" : "iiFM8evk@benchling.com",
      "timezone" : "UTC"
    },
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:04:29.180462Z",
    "updated_at" : "2026-05-08T16:04:29.180462Z"
  }
}

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_3irumpxa82ZCgEdILmQBo/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyMzdiMDE5Mi1lM2ExLTQ2ZGYtYTVlOS1hNWFmZjA3ZjY4NDciLCJqdGkiOiJkMTViNTg5MC0yMDcxLTRlZWEtYmQ2ZS1hMTg4OGY5YzI0MDYiLCJpYXQiOjE3NzgyNTI2NjcsIm5iZiI6MTc3ODI1MjY2NywiZXhwIjoxNzc4MzM5MDY3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX1JhUDFDWlI5Y0hMQllEelI0VnlvSSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.ZbsrET1zpoWp4-ukuEYwt3LyhbAP1NHIjN8qNNPzzqGYUEtuoEmUZ39lN1UzeDzSjXD9bKRUC6TmLl48n11Zh2Q3VXIA-sRuKan1aTA8AeQibBQSgzwI1wdnTHuIL1NwTunwRZDRBBkyrLKvJgeCx1X1DqYeBJjIqqfu5MSZiXqg3ieOimD5JLVO0gjZ7LRVRNv4FdFJa7qjlLuBzqZ-wChES0aIsvgF94Xy-lCDsU2ajmvCGpdff-Ic8mWWeiXw41rFKGNYal4ZR7TcpsrCKQ2B2HM2IXusmKYd2UMWYI83KgHa1LxiTWi5CVnYrYdRbSKoVaLqSgcjMjQNTqfaiF83WrjVNU_pwnHVjv71WcoB4_qpUJNyq-5p0X4eDUgd7M7OJs9lg6bxgfIMAKW0vNb4DEkboOh-AjzYF0-ALlq8sUWkwpR0X2K8WIKJSs1yINWR4hbRIXzZyzUsU0YSVmmOCDYbyNgIj9r5v3hsCKG8xFAHF7mA0QO0Pm6EoYAcKxKKgvXNOke9e4TMXR-hqUcSu3Fq5FTfNtoEl0f6WTCERlmW2ZOiNiYtnfrHKKXMBVMChJ22lvftEo7pZFxKR2KDlxpts4uyVs688monBhH_d0sLR_RvlH8bhx-wg0br8welWvCa5KivsdG7MVi2_TR1NNv91vZtt1_MVay-pVQ
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: 5152

{
  "data" : [ {
    "id" : "usr_2MvdGVNZDHP0geqfhLvFsU",
    "name" : "leEgXL7Aiv",
    "email" : "riqT5qxK@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_3irumpxa82ZCgEdILmQBo",
      "project_id" : "pjt_1rg0vzEKnmzZkumYDkZWGX",
      "name" : "9fZauTgAsq",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hGq9WelxdorR3SWeTIQIs",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "XHB002KIAQ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2MvdGVNZDHP0geqfhLvFsU",
        "name" : "leEgXL7Aiv",
        "email" : "riqT5qxK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6ni1lq2xkbZEdjKvWjB9Pw",
        "name" : "a08nNMwgmh",
        "email" : "qQAqVrCs@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:27.359640Z",
      "updated_at" : "2026-05-08T16:04:27.359640Z"
    }
  }, {
    "id" : "usr_6ni1lq2xkbZEdjKvWjB9Pw",
    "name" : "a08nNMwgmh",
    "email" : "qQAqVrCs@benchling.com",
    "timezone" : "UTC",
    "type" : "owner",
    "access" : "write",
    "study" : {
      "id" : "sdy_3irumpxa82ZCgEdILmQBo",
      "project_id" : "pjt_1rg0vzEKnmzZkumYDkZWGX",
      "name" : "9fZauTgAsq",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hGq9WelxdorR3SWeTIQIs",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "XHB002KIAQ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2MvdGVNZDHP0geqfhLvFsU",
        "name" : "leEgXL7Aiv",
        "email" : "riqT5qxK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6ni1lq2xkbZEdjKvWjB9Pw",
        "name" : "a08nNMwgmh",
        "email" : "qQAqVrCs@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:27.359640Z",
      "updated_at" : "2026-05-08T16:04:27.359640Z"
    }
  }, {
    "id" : "usr_49ypjdMpz6utvOAgCz8P9h",
    "name" : "0P96QqWwDh",
    "email" : "vozmdj1E@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "read",
    "study" : {
      "id" : "sdy_3irumpxa82ZCgEdILmQBo",
      "project_id" : "pjt_1rg0vzEKnmzZkumYDkZWGX",
      "name" : "9fZauTgAsq",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hGq9WelxdorR3SWeTIQIs",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "XHB002KIAQ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2MvdGVNZDHP0geqfhLvFsU",
        "name" : "leEgXL7Aiv",
        "email" : "riqT5qxK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6ni1lq2xkbZEdjKvWjB9Pw",
        "name" : "a08nNMwgmh",
        "email" : "qQAqVrCs@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:27.359640Z",
      "updated_at" : "2026-05-08T16:04:27.359640Z"
    }
  }, {
    "id" : "usr_6j4oGKGPcfHemZDGfynJOO",
    "name" : "ypI5sYsDRm",
    "email" : "ToDqhY60@benchling.com",
    "timezone" : "UTC",
    "type" : "team",
    "access" : "write",
    "study" : {
      "id" : "sdy_3irumpxa82ZCgEdILmQBo",
      "project_id" : "pjt_1rg0vzEKnmzZkumYDkZWGX",
      "name" : "9fZauTgAsq",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hGq9WelxdorR3SWeTIQIs",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "XHB002KIAQ",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_2MvdGVNZDHP0geqfhLvFsU",
        "name" : "leEgXL7Aiv",
        "email" : "riqT5qxK@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6ni1lq2xkbZEdjKvWjB9Pw",
        "name" : "a08nNMwgmh",
        "email" : "qQAqVrCs@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:04:27.359640Z",
      "updated_at" : "2026-05-08T16:04:27.359640Z"
    }
  } ],
  "links" : {
    "first" : "http://localhost:8080/api/public/v1/studies/sdy_3irumpxa82ZCgEdILmQBo/users?page=1",
    "last" : "http://localhost:8080/api/public/v1/studies/sdy_3irumpxa82ZCgEdILmQBo/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_3irumpxa82ZCgEdILmQBo/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_2WTG8ZthTz5XC4WTK8z8we/users/usr_3oxgtVTuIoblIP2yO899EZ HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4ZDU5ZDAyNS04ZjhlLTQ4ZDItYmRiMy1jZDExMzIxYjY0NGQiLCJqdGkiOiIwZTQxMDM4ZS1kZTk4LTRhODItYTIzMy01Mzk5YzdmNTYxYWUiLCJpYXQiOjE3NzgyNTI2NjksIm5iZiI6MTc3ODI1MjY2OSwiZXhwIjoxNzc4MzM5MDY5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzJDN1pHbTNUQlZxNEptNU1rb1V4UzQiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.P96Rljzsvc-YlDhQxjAzPHIswUVy4s4G_wp7hR25PUePYIgocxTzoXAB1lt8Oea1zEi3kEkZey8tl2HtJlCYd9OpD9fms_8RE00fu1gg4p38BAnsx4iSu3mzWq-PE42coWA9X4qjhI1JiCA0VdbXt-VgiiV8-BGZtsvsZqb1vLTUn8AH_Z3eYFdBWbVPXvUh_BaY1IrDL9VbDRmj1ERTu1mCaYu8UIMaEopZprQJ6EPHWXhRH7sp5SVIFllUjO1gxS1veGXOUVrQJthGsohIBwbsFN94QX3OZ7onN9KBf-t55YN2EDPyrV-1jC_ZVaV5ZKfkxhxQvyzAzPA07Pkwz6lAU7IMq7QKf1BE2bqFGPWEmXKLvABYu9rTASs-HU6I2QxhGdrxxmZB1-VJREI_bTxFk5xp9J87AuhRqWWT2J82eWIpv9HLVE9g0SaRwfu2OWcKMx28z9pO-rLPyRoCI0s0mOnU5u_1FoNCXupWEM5NR1HVuTOtqtO7zLAphmkLeMwnrN4el4eduOr1CEM0OAfhjsHziV7krzG-nQcBXyhclMp9Kpn4lQwIzznuX1WDsj8KrWsdRxjxriYc84evqqjRY_oMJtDgIue7_ZHCEBfh84F499udl3tz7bhpottk6P_GEAUUe1W7td8d2C8QCSb0PAAou6fuHEHbuE3UNC4
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: 22

{
  "deleted" : true
}

Team Glossary Resources

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_4lWkndNIz16NFri4DCjVt2 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2YWQ1ZDUxMC0yOTMzLTRjMzQtOTkxYy1mZGZlNjAwODNlYzQiLCJqdGkiOiI2ODNmMTY3Yy00NmE5LTQ2ZDctYWMyYi1mZDRkYjRlYzgzOGUiLCJpYXQiOjE3NzgyNTI2MTQsIm5iZiI6MTc3ODI1MjYxNCwiZXhwIjoxNzc4MzM5MDE0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZmM1FOdVZwbnk3ZHlUQ00zS3VjUUkiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.VRjUScSapRstzCjbR1TnlB60pQt2QHVWumG13YU3Ulkw6kOuzyTBzZysF2XT01yv9EZbqzrfrwj6uhCuT7jydhW-4M5hk4CIb34OZ8OG7RPKojz6anG4qunurtcMdA3bdeHQIQla8DsTm1-fYhZpjI7Jbj3ADE7Ie0HKni8KsHoZ7g1ls4RNkOm0gir8kpmw2JKzEKiX3ldlcDtLNqOnJRRXaAeke4Qbjz_aHXVEKf7MnH1AMtN0St94X3uxnoV50OzMmgGNKgsXaimYFJJt5-HJet6ZBp90dn7S_jd2jv_xlGsUDnxdGruF3KiVuQjXvJg8hK13Huvl9gN3_i-19OKRA_mvvpw-8uY5pScDV-TEVYxdPoltIzFuwzwuiDR04M1PXdZWueceIiRcL_6LO-ur3JZm8MI-Nf2BEddVqATbA773F5OgEmDKqxuKTILqml-aRN6ATgwna-kSzUMAF67xMpbkjp0TVUhtiFBKYVlgjaU2z25wWlMUNRIb3j_YarjGPsrG0V0kM7kAK-L9oE9THDvo5vruUh5EyD-O9OlSJX0Hu6K2aKdX75uO7Cm1NlCjVv9zCu5wXgldL4OsJ3AFX4GC1rADCtoi3YalnVrmaXE-pKjg1q5_OW7siPq49WRQgLSSuRArY2nVEqtPooqjb_e3fipkzVENveETqc4
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: 253

{
  "id" : "tgy_4lWkndNIz16NFri4DCjVt2",
  "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_1fleIRG4uuCYv9P1HMRpy1 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlZjc0MWI5OS04ZjUwLTQzZGUtOWM2NS1jMzRiYmEyYjJmNDIiLCJqdGkiOiIzYzQ3YmE4Ni1mYzY5LTRhYzAtYmYxOC05ODZiMjljZjEwYzgiLCJpYXQiOjE3NzgyNTI2MTQsIm5iZiI6MTc3ODI1MjYxNCwiZXhwIjoxNzc4MzM5MDE0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX2lOZFRycnl3ZlNnR1NOT1V5Y2dRUCIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.QgMTO02VIu1aCh1BndeXpfld2RCYQ0yqJonGGPRHc054wp31aTt95_0_ZDWH9dfdVAfesynA7lB6Q96qtmEMqw7rGWbHDMiGCHb9sY5wkoxHEZl6vROaIC5-8tQQDWF7nr16XQ-6_kiIu8frXYJE54_RhX7dxlyU3A3PYwmOH9Xapos5vQeFoCirmZllpJnoo1Wiy0yeThu0FJ3LDqT1Ne8wleTPH5aEBXyoPf_owaZ9EMUuoMvVez6gZM5UWz5hYzq95o4n9XSTNpbKaLTKoZHAN1suub--ajIhvfXjxgAFcry9I9chYGAjXH1GhHF5FGKR_GMb8IjgRGTRk6ndDDQLLLSfOJQ9uhSlbauZ3mo0AneNEnEc_ITAJ8PO7Wz0yEvfz9XbmHfNCAvmJcO50bPLiZ41jv2PB3RJR4IA4jwp9UFm6FS9uDMm9vcIOu9FxkDkB7KigbHBvN_eWGxsetnrlHEZBTTQEutVMPNbBckzVOp03xEl7aoki6C_YbyDH514ZPRg_jZgILakv4qOIqb7SxVysjDgYp9BlCT0XJB_s9XN95a4-Rvoe_L4ELNrSAyBMPohnJq7QZUgoMVaj6ufJOKkJBmCCae4q_B0JL4dHnOU0UtmHecllaqdvAgHIAdVNKwLN0R3pIx7byZnxOq-XUFpjHwuTrfUG-TH0CE
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: 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: 253

{
  "id" : "tgy_1fleIRG4uuCYv9P1HMRpy1",
  "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.eyJhdWQiOiJlMTVlMWE5MS1iZDcwLTQ4MTEtOGM1ZC1jN2FjYjJkNGQxNjEiLCJqdGkiOiI0MmMwZDYwMi0yZmY4LTQ3MWEtYmVkZC02Zjg3OGQ0YmUyZTAiLCJpYXQiOjE3NzgyNTI2MTQsIm5iZiI6MTc3ODI1MjYxNCwiZXhwIjoxNzc4MzM5MDE0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzExVHNnQmI0Um5JaW9tYUYxTFRObXIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.iz6OLEqjoXdvEW0xdKs_z56QuY8Q4X7MnSm60BMAJ0B7WsulRTOG6GSOVAW5FvPbMFk3IcdJWWCwzvr35h4Em720cTHMUmQ-jvggZBGXAdiLwSMabh9ZhkTEE57uyDmX0aSpyFwxVZqlrkROTQhh1pW-3FpkXi06Ja0BLTEufqu2gINdp2zAhWyG7gAH4627ZXPve2FULp3-N3-ngV5wyaRf4LYNBH5Pd9K_BdY4WCA5wpg4fCswrUpXjs26nTN8E9EsOmA6w_J5Ar4EMAFmflhqBC3nMi92GfyDmRNIOhN6-b9Yg10swigyHYisHPMzCTlwuhfRnAsTiaL7AHSNGfq_xLyX-81-_fmO7ExHFMpOF5KYGtxiXSlpaFd5l3pXHbA-MDoCE1W2MOuPP6kF7PFnCK30ZC_CvTppmhxEWEZIEaMFyfd8aTXWDgaEVkSwhD2q5JbcMMtw4_lK3aEn3KisJYEEQvIf29LnhUb8OFnOIeFbgn5FtrR-5DObRT6E-_9037bFtd_D8HGPQ0UBpgUJ0pUIW7dYaRu3lY-WrmZisJ6QbmPDh-WAVRCaTxQYUaLlACGjcfNsVkazuXqd6UOIOdPTBsI7Fn-jY9cwwqs8NjutC-PWSh4ANB-_9OiZUv-TdnqacM08RlpVIFSqTUeWG8nYAhJjX9WaKuiekiY
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: 693

{
  "data" : [ {
    "id" : "tgy_5nKpgjX9RjEY06kC2HPS8X",
    "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_4dfbh7t1ixjTorOqcfW7YR HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2OWJiOWNkYi01MTUzLTQ4NDktOGIwMi1lNGFiNzBiNmZmOTIiLCJqdGkiOiIzYzczYzRlZC1mZThjLTRiYmYtYTA4ZS0xZGFlMTQwZDM2Y2QiLCJpYXQiOjE3NzgyNTI2MTQsIm5iZiI6MTc3ODI1MjYxNCwiZXhwIjoxNzc4MzM5MDE0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzZESGdKbFRvRE5HdDdocUFUdFZPNUEiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.HMfk3YDg_4KtGm4MoCIiHxX6lGpIhPt-dHJed0I82fJt6gSL-Sg-DWx7Xos63FTRRHWvneyq0NaTEwC5Jm0MsIU7PvZSfm5ZU0a50ClKiUicM3_U-G6ZgJdB0yAN622C13JhS69DFVUVvw_uwtCJzUmYMns_EA8A8xxLn05RNTenEIheD51H6aV75_gK4kx1hLgk15g7a8LSexIrOY6ER3TQltDJXwTpkk6L6qUlLISBuxMuFKBQWR7f_B7rhqrzspT1LBZUt1nmPSrSWzGrp3SEBxATXmccV0gZvO2Csu-icn5jF_kU8m_ci0VboyQyuTq1ybFVgolDjwTZJaCwYOWurMUDZmGfuuUa1ZTQgBj4qTq2WzlWT_9JUfLC0-gY5wZ9Hic0C1BfsxKBDDIwTCy3WqpXPkDLft1ip2dQAnd5o13DM8MkLXNngcF9ZLUWEQLDlk7Z9vfKacIWCzoNOSNiGlg-7sSXBJsJRLsbuIcJtKIv4-mMxnR2LwUrbse_monguKHmCH1Z_RvN9I8A5zJyyjAA2T2qsc7zIM14xw-V4wEXh2lwihR9USJ3F-qMXmzW7pVtqb1W4xqjmp9IeElnUmFV2jB-fjFMYT5gpP-UXho4rfVrwAzsctfEHlvFVVRFKHfqFP27Mx2QtrSc5fWD_h5wodbbpHGNLwo1YQ0
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
}

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.eyJhdWQiOiI4NTI0NTU3NS0wMjJiLTQ4YzAtODJkNi1mMzAwNGYzYmIxODYiLCJqdGkiOiJmZjVjOTJmNC1kNWY1LTQyNDItOTI0Ni01YjBlZGQ4MzEwN2MiLCJpYXQiOjE3NzgyNTI3MTIsIm5iZiI6MTc3ODI1MjcxMiwiZXhwIjoxNzc4MzM5MTEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzN0NjFuYjBOTkpGUmNRSTVpaGh2SyIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.JnvFvZXk4rAhGVhXQSI3ohpiiB3Sjr_KcXU6Wi5aC_D42K9XFK3ubQjrwk_ktppqMLARDW5MiMiutrVHKKrfr-dflycPFB-JaTY4LoyF1Szg8LgizS943WftFaDyFnssiqSdSE2kYDSQsQpzMVSzoh7I_EG7MNhjvKGeGlhwyoFscZ6VZfAXbbypFmSDHdB4-CBrKGzPtvMTL3U9K7qOK8GHhaXxFJblXrhq2NUwhYYEMosZSjZe-FKvkyzWYdxWVRcNezGs0nGSEDGffMZcq4eWQCEghnqA7Pf8XnHES2q3oCqoXleMxCW3Z_pq6x2iTyqH0hV7bL5Tfnsut4Lq3QkkrNIIxAx2aVicBDG3VsvMR3zu7vNccHiism9GOZJGDm0hN6r1z6SXNexbU0wRLrk5OoC1skIAQwfjxtvVJB0BZnXHUC4ZNQbvapg3EuNhDHf8Bk1Q7CmBxjtjZ80fXD1jdSQpIFnvAeOGJMcCgnCdhOLv8FhRPUHysKC_kDIAFN8Nz98IoWNjjwvrrBY5kAwCHPgXG6fuaR0-PJyDrJmbj3X0Cn0shWXTS6Wl3PkL0PnTi3-bdVILN-KWUjOCUgFCEgImOCnqI8AxNiV4C-rm9Mi6yF0u02Sa6gGNuevZT0ALeLoEUXGvC5sZ8oCCXQBTornAH7646gjm_B4MMkI
Content-Length: 146
Host: localhost:8080

{
  "name" : "gPI8N8pQt9",
  "email" : "d0x4Dpv1@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: 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: 305

{
  "id" : "usr_3frsoOGpudQiSza1JrkfJK",
  "name" : "gPI8N8pQt9",
  "email" : "d0x4Dpv1@benchling.com",
  "timezone" : "UTC",
  "status" : "pending",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-05-08T16:05:12.123829Z",
  "updated_at" : "2026-05-08T16:05:12.123829Z"
}

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_1wIU0MqwKieRG6BucTGkBg HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZDA1ODI3Ny0zMmVlLTQ4NTYtOWQ2YS04NzhhODNkYmM4ZDYiLCJqdGkiOiI2Y2ZjNmEyOS1mYmU2LTRjYzEtOGUwYS1hYzljNmM1OWFjYjAiLCJpYXQiOjE3NzgyNTI3MTIsIm5iZiI6MTc3ODI1MjcxMiwiZXhwIjoxNzc4MzM5MTEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzdnQTdaelh0dlMzSFJkRHVRVWx6UzIiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.Tli4wvC0XseVpytBa4Ccmi4t7n6eqvE_oZbNHnGRF94Bk4N0Pe7U4_bEfPQeA4mh5TjO4hFVY_roionf0jUe3kBX3jWIcgx1jtmrn5MspmikLjxh0cmSQVM47hOeh1ITXEs9ruiZxVxLPwFWLQhaaWqVgaZHmSccBSfeIF15Xx0Py4Um2jRQEwKi5oehUHCviFFuy1u2bLPkJKy50-8CNQS6zWmWvJ8WELxP1mBgLk4s9uu-Ckr1W-2_YDcDJmBRiepfFPTMmorijuWo1DAZpjBi_PGjrTf0K37YOzeTW66JuJgdYd9ofGYeerbe_baQSr01FDqAwvMYNZIelEbvc3HK0m5RcyTJgrm2yfPeuG96tMniEgv5VcM3XanEwEaEamNAZ6GChHWrEz8XI1Ir8uIrwQkkxEqoqUnBE2mNJ3v7VpGdl9bFHUFjwT2s2wJGPOLFV9vkXXzEmlkaLByrYiGquRcYzxE_kOZECRtGoRXN8ywaPpJXvzc6-SUJAYbrH_CjOh_vfvSJTTAhKQNFKkLqEG376GK8cFvmoXlauNigvSt6ENCJsKLGFL_JTdDL_eQkNaONvp6Ggb-PygyoP2nX0RbvjHQCCtCbtW6Lwjj6uXPqFKwWtRohG65BdQRdaNOYXXCIQbhdwDg42VLdDg1JobMtlJd2VK2rvBRbljw
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: 309

{
  "id" : "usr_1wIU0MqwKieRG6BucTGkBg",
  "name" : "gIVvI Overwatch",
  "email" : "hf4bB9nt@benchling.com",
  "timezone" : "UTC",
  "status" : "active",
  "metadata" : {
    "user-internal-id" : "USER-1234"
  },
  "created_at" : "2026-05-08T16:05:12.834973Z",
  "updated_at" : "2026-05-08T16:05:12.834973Z"
}

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_6tNFNUynck6uVmPrKGDaAl HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkZmY0N2VhNy03MmFmLTRlYmMtYmY3Ni01MDIxNDc2YzU1NmUiLCJqdGkiOiJjM2EwNTU1OC02ZGJjLTQzNzktOTRiNy05MzdhMGFmMWQzMGYiLCJpYXQiOjE3NzgyNTI3MTIsIm5iZiI6MTc3ODI1MjcxMiwiZXhwIjoxNzc4MzM5MTEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuXzFldlJEcHdaTmJldjE1V21QT3VQTEUiLCJybCI6WyIxOjMwMDozMDprIiwiMToxMDAwOjMwOnQiXSwicmxfZW5mb3JjZWQiOnRydWV9.GjiVf7R2cK00gdt9dJ-By61gkH8UMxumMJZIKm8OG-UjY14vt5DjKg8d7rGeAEeZxyN3-gGZOigZ-1ObRkH2ZJCqBywAAowtStesmT7O6qXGYR9soo5dTIkxpiF2Lx0BCsqlk23HeAgMH1_4hN5MRJXJpjVgdxbSGIFw4aQRn-NIELP0Bq9UamtnqKWMvIp48_ERGBmUEpQNsO-t1o1QuBrDurT0GNICU872sSbfIIYHM9peQbS54-Ur7zqcW6fvaESHDXClD2PUQpNLbR9d-n-TUTTpDfc1C-4N2D3xLY4jH_Is8lVcow7urPu2Y3apInNOsc49NlNcL2I2muDe3sJ30vezNobmSMuj0Fg-doKe2vQ2SimeNmy032ea9QWBM9s5pqr3QTl8Ll0fcpJT5835Kc3dk8xTkvYm0SdIkC7T7KHYTC-cuGVVazyWeDiev5JhMvVkwoIREsKyGzftuDwQFywMCI59A9TN9WTRVdiT9y9xj1bAJl6B11BlvcC8OxdFBvRu38Xvy7hIKpoHOjiXrLJs-DhtLgun-0ze48iJvNOJxEysI2_60FS7KYJimXuzAL3dRLzlUK3ar3Z01ZABPaE3wNgEzgSEq8tTFdulG9mWdOdB91G2QCpiFrngwMJV8NrCFQVqp4TUnqunMWPVshpE7l5eFFw_UN9e3c8
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: 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: 323

{
  "id" : "usr_6tNFNUynck6uVmPrKGDaAl",
  "name" : "Benchling In Vivo",
  "email" : "HcEJVbVu@benchling.com",
  "timezone" : "Europe/London",
  "status" : "inactive",
  "metadata" : {
    "user-internal-id" : "USER-4321"
  },
  "created_at" : "2026-05-08T16:05:09.628700Z",
  "updated_at" : "2026-05-08T16:05:12.647065Z"
}

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.eyJhdWQiOiI3NWNiOTM1Yy0yOWRjLTQ1ZGEtOGZkZS1mZWQ5M2VkYWZlZDUiLCJqdGkiOiJlNzU2OGYzMi04NDY2LTRmZjMtYjA1MC1mM2M4YzM3MTE5YzUiLCJpYXQiOjE3NzgyNTI3MTIsIm5iZiI6MTc3ODI1MjcxMiwiZXhwIjoxNzc4MzM5MTEyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdLCJ0ZW5hbnRfYXBpX2lkIjoidGVuX3FTeU0wS1NPNXJab1U5TXJadkpxcSIsInJsIjpbIjE6MzAwOjMwOmsiLCIxOjEwMDA6MzA6dCJdLCJybF9lbmZvcmNlZCI6dHJ1ZX0.AGGDsQJyNkuqWumZ7N4yBkYjf4xBsqFNxcP5I-T9EyXBAqkD6eSLcgySaYk4buZJfmCKPxOTIaPQgw7ZsI0IDPe89mMLePSgIMgwUszELbcU4oKHJ9JdfTUjsJn3PS9c2U7jsYic_EvdivhZmImNLBK7Ihq8f3D51wjHlmGXRLl2TDdDfD18J3H3y5Wri8vaeupwbY00JAAfGXIIxC-axpVDXMma7dDpS9sELqQkeuypiQqP0q4jmYnP94uuM0WoIroHV-CCpKB5axmqvYCDr7N2mf-AZVOw-Fa6Mw4ko9CXFyDjN2mGSblr3stQGN6AT02MpiDssZepH4KR2tih9dm5BunbvWHVwmd0L0qhHvl2lX0yMPHbIvaWo9UfWTDkJENzyppqH2P5NigqAQQCwrcK-AUeySYZA4o1oKTpg98I5J6PDS9JiMPUm9KFCoKJ-8-XBJAJx0hM4HKslKDTvVIFn5OVdBfe4zLfmo2SEU8yM4eZORsKiBB6I2WYNXxi9L6nIpCPmkhIYpG2pr7fjzD4hO35GZZL76V6Y3RpwU-rgpawhzjmbLYi2ekMbozl963X0L_jx4_5P9TGNRZSv4p-admrblz-wusaKdNDw4GPSPCpbvipSpy9cSVpfYq-bPcvN5YGE40cdErUeMGU6hzuRDU526ct07Kw6WsuMao
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: 725

{
  "data" : [ {
    "id" : "usr_5iZRIz9mCunu0EkhCeoJe1",
    "name" : "XiQNs Overwatch",
    "email" : "ru6pUTto@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:05:12.229009Z",
    "updated_at" : "2026-05-08T16:05:12.229009Z"
  } ],
  "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_2L0bcXlrGLS44qBnyDeBjK",
  "client_id" : "d2cf97ea-9e4b-473b-86f6-f2812d586f4d",
  "event" : "animal.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.558349Z",
  "payload" : {
    "id" : "aml_3nzhQhtylCVyDkSnay0Gg0",
    "catalog" : "A0000001",
    "name" : "RryM0gYFp8",
    "number" : 1,
    "strain" : "wWbWoQ0xt4",
    "species" : "3ewXxd5HJi",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "6hNP7ZjDIY",
    "ear" : "zmWul43tKz",
    "tag" : "gZLWaGRk4i",
    "donor" : "jUdQR3RkRI",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : null,
    "terminated_by" : null,
    "terminated_reason" : null,
    "disease_survivor" : null,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_KjZQacDDKGEfssVxDKYbX",
      "project_id" : "pjt_1siFhDE4pQ7a1ZZyhO4ovG",
      "name" : "9LUnymgfFY",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2RV0achx2Ur1kRSRJlnx6k",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "cLeiFloWfu",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_17EgEVs9eECVDZEyeN588u",
        "name" : "MCcQ6R16eC",
        "email" : "J9SnJ76e@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_14NKYn84HYiv3OGP9P98ZX",
        "name" : "02mPLiR70N",
        "email" : "fw1bs4lZ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:17.269516Z",
      "updated_at" : "2026-05-08T16:05:17.269516Z"
    },
    "study_group" : {
      "id" : "grp_4QQaDQU0t3GD83OgTVUdO7",
      "study_id" : "sdy_KjZQacDDKGEfssVxDKYbX",
      "name" : "CC84OnK6hw",
      "no" : 1281323543,
      "color" : "RRd1cPvyhB",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:05:17.435463Z",
      "updated_at" : "2026-05-08T16:05:17.435463Z"
    },
    "cage" : {
      "id" : "cge_3Sv7OmCQpdvTx13zjiFHpw",
      "study_id" : "sdy_KjZQacDDKGEfssVxDKYbX",
      "name" : "e4HL3srXWX",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:05:17.421814Z",
      "updated_at" : "2026-05-08T16:05:17.421814Z"
    },
    "created_at" : "2026-05-08T16:05:17.450431Z",
    "updated_at" : "2026-05-08T16:05:17.450431Z"
  }
}

animal.updated

Triggered when an animal is updated.

{
  "id" : "whe_36CM9D1y2Dpp6YRSwh1dH0",
  "client_id" : "d268d73c-d28e-4f8b-8a2c-4a6532133f24",
  "event" : "animal.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.692753Z",
  "payload" : {
    "id" : "aml_5dqXJiB4kLqDRVkSncnLcI",
    "catalog" : "A0000001",
    "name" : "J5uANnBeLC",
    "number" : 1,
    "strain" : "bYDAsRMt7U",
    "species" : "XM5heM6bSK",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "6MmiZvW2pI",
    "ear" : "nDWEhh5Iea",
    "tag" : "JAVXeJgX5j",
    "donor" : "GQtuFwHqKM",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_48byX7QFfGz3HyqX66Deox",
      "name" : "JH4S1vd6Hs",
      "email" : "QkTUOJ3r@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5v2xpszySeSBA8rVAKHc2j",
      "title" : "Found dead",
      "comment" : "Qg5rcQPbmj"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "project_id" : "pjt_7d7BR8cnSYpBl27cSxpsi7",
      "name" : "hX88swfNj9",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TlkvMqMqBDdTzm8X81I7m",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "TZQjaotaau",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_14vvtoq741QfkkPARKQMSM",
        "name" : "p8vk5KeTxS",
        "email" : "ytbiGkyu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2AGA7dkF7RUvXw7X7wTfif",
        "name" : "3q1upwyKgR",
        "email" : "hNl5g3ee@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.425808Z",
      "updated_at" : "2026-05-08T16:05:14.425808Z"
    },
    "study_group" : {
      "id" : "grp_73324OGty2kgZ5s65B3Fd8",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "6cVBYh9L2t",
      "no" : 107419067,
      "color" : "evPjccZJhc",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:05:14.588148Z",
      "updated_at" : "2026-05-08T16:05:14.588148Z"
    },
    "cage" : {
      "id" : "cge_5elFVvFWGe5PMUMQ72E21x",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "BZmaVHEh7B",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:05:14.577822Z",
      "updated_at" : "2026-05-08T16:05:14.577822Z"
    },
    "created_at" : "2026-05-08T16:05:14.594208Z",
    "updated_at" : "2026-05-08T16:05:14.594208Z"
  }
}

animal.deleted

Triggered when an animal is deleted.

{
  "id" : "whe_sY4rSz93940ClUAnsRXlJ",
  "client_id" : "773844c9-3033-44e7-aa4d-230ad30bf0e9",
  "event" : "animal.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.694247Z",
  "payload" : {
    "id" : "aml_5dqXJiB4kLqDRVkSncnLcI",
    "catalog" : "A0000001",
    "name" : "J5uANnBeLC",
    "number" : 1,
    "strain" : "bYDAsRMt7U",
    "species" : "XM5heM6bSK",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "6MmiZvW2pI",
    "ear" : "nDWEhh5Iea",
    "tag" : "JAVXeJgX5j",
    "donor" : "GQtuFwHqKM",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_48byX7QFfGz3HyqX66Deox",
      "name" : "JH4S1vd6Hs",
      "email" : "QkTUOJ3r@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5v2xpszySeSBA8rVAKHc2j",
      "title" : "Found dead",
      "comment" : "Qg5rcQPbmj"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "project_id" : "pjt_7d7BR8cnSYpBl27cSxpsi7",
      "name" : "hX88swfNj9",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TlkvMqMqBDdTzm8X81I7m",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "TZQjaotaau",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_14vvtoq741QfkkPARKQMSM",
        "name" : "p8vk5KeTxS",
        "email" : "ytbiGkyu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2AGA7dkF7RUvXw7X7wTfif",
        "name" : "3q1upwyKgR",
        "email" : "hNl5g3ee@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.425808Z",
      "updated_at" : "2026-05-08T16:05:14.425808Z"
    },
    "study_group" : {
      "id" : "grp_73324OGty2kgZ5s65B3Fd8",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "6cVBYh9L2t",
      "no" : 107419067,
      "color" : "evPjccZJhc",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:05:14.588148Z",
      "updated_at" : "2026-05-08T16:05:14.588148Z"
    },
    "cage" : {
      "id" : "cge_5elFVvFWGe5PMUMQ72E21x",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "BZmaVHEh7B",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:05:14.577822Z",
      "updated_at" : "2026-05-08T16:05:14.577822Z"
    },
    "created_at" : "2026-05-08T16:05:14.594208Z",
    "updated_at" : "2026-05-08T16:05:14.594208Z"
  }
}

animal.metadata.updated

Triggered when an animal metadata is updated.

{
  "id" : "whe_6AyjYerx6ou6oKcfjsZ8J",
  "client_id" : "35a0bf3a-8322-41f2-be23-e91897f97492",
  "event" : "animal.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.695067Z",
  "payload" : {
    "id" : "aml_5dqXJiB4kLqDRVkSncnLcI",
    "catalog" : "A0000001",
    "name" : "J5uANnBeLC",
    "number" : 1,
    "strain" : "bYDAsRMt7U",
    "species" : "XM5heM6bSK",
    "sex" : "m",
    "dob" : "2026-05-07",
    "tail" : "6MmiZvW2pI",
    "ear" : "nDWEhh5Iea",
    "tag" : "JAVXeJgX5j",
    "donor" : "GQtuFwHqKM",
    "tracking_date" : "2026-05-08",
    "disease_induction_date" : "2026-05-08",
    "terminated_at" : "2026-05-08",
    "terminated_by" : {
      "id" : "usr_48byX7QFfGz3HyqX66Deox",
      "name" : "JH4S1vd6Hs",
      "email" : "QkTUOJ3r@benchling.com",
      "timezone" : "UTC"
    },
    "terminated_reason" : {
      "glossary_id" : "gly_5v2xpszySeSBA8rVAKHc2j",
      "title" : "Found dead",
      "comment" : "Qg5rcQPbmj"
    },
    "disease_survivor" : false,
    "metadata" : {
      "animal-internal-id" : "ANIMAL-1234"
    },
    "study" : {
      "id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "project_id" : "pjt_7d7BR8cnSYpBl27cSxpsi7",
      "name" : "hX88swfNj9",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_TlkvMqMqBDdTzm8X81I7m",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "TZQjaotaau",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_14vvtoq741QfkkPARKQMSM",
        "name" : "p8vk5KeTxS",
        "email" : "ytbiGkyu@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2AGA7dkF7RUvXw7X7wTfif",
        "name" : "3q1upwyKgR",
        "email" : "hNl5g3ee@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.425808Z",
      "updated_at" : "2026-05-08T16:05:14.425808Z"
    },
    "study_group" : {
      "id" : "grp_73324OGty2kgZ5s65B3Fd8",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "6cVBYh9L2t",
      "no" : 107419067,
      "color" : "evPjccZJhc",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-internal-id" : "GROUP-1234"
      },
      "created_at" : "2026-05-08T16:05:14.588148Z",
      "updated_at" : "2026-05-08T16:05:14.588148Z"
    },
    "cage" : {
      "id" : "cge_5elFVvFWGe5PMUMQ72E21x",
      "study_id" : "sdy_JZcuTKjiTAPWjTmJQqEF6",
      "name" : "BZmaVHEh7B",
      "catalog" : "C0000001",
      "metadata" : {
        "cage-internal-id" : "CAGE-1234"
      },
      "created_at" : "2026-05-08T16:05:14.577822Z",
      "updated_at" : "2026-05-08T16:05:14.577822Z"
    },
    "created_at" : "2026-05-08T16:05:14.594208Z",
    "updated_at" : "2026-05-08T16:05:14.594208Z"
  }
}

Animal Dosage

animal.dosage.created

Triggered when an animal dosage is created.

{
  "id" : "whe_5TViSAMJxO5OS32bYgUfvM",
  "client_id" : "e68c44ce-c727-4831-8df1-f9035999d8be",
  "event" : "animal.dosage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.130757Z",
  "payload" : {
    "id" : "dsg_yUILZ7WoCdZX5jh03A9LX",
    "name" : "Example dosage",
    "dosed_at" : "2026-05-08T16:05:14.072637Z",
    "comments" : "50feHvDhBB",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "7.00",
      "display_unit" : "mg/kg",
      "display_value" : "7.00"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "13.58",
      "display_unit" : "ml/kg",
      "display_value" : "13.58"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "23.63",
      "display_unit" : "mg/ml",
      "display_value" : "23.63"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "31.48",
      "display_unit" : "µL",
      "display_value" : "31.48"
    },
    "study" : {
      "id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "project_id" : "pjt_43xPNRixT4DAH9KH518tn",
      "name" : "H41UqmwVUb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3vrVyNiam8d8UHutSubWLg",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9GdSCwA7ry",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7I0WpVAZ5j4LgLzVCBL4PE",
        "name" : "HlFpWpknss",
        "email" : "9chQhkkg@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5b2DR6e4wFiPLt3EUoGG64",
        "name" : "eAiD6vcpRv",
        "email" : "qcfEpz64@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.887656Z",
      "updated_at" : "2026-05-08T16:05:13.887656Z"
    },
    "animal" : {
      "id" : "aml_41jYtEccE8Vc4CEvdVMTiO",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "study_group_id" : "grp_5Y7NLuKJnHF1BkHJfBWpCd",
      "cage_id" : "cge_1PELg3iG1mocer0AQXuTmi",
      "catalog" : "A0000001",
      "name" : "JmamKX2jtu",
      "number" : 1,
      "strain" : "l2CquDh51g",
      "species" : "nhLV0ew07w",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "0cccMaV4hR",
      "ear" : "Un0taR1GbC",
      "tag" : "jtMBueUZ7K",
      "donor" : "h93t8ZYs1q",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:14.052672Z",
      "updated_at" : "2026-05-08T16:05:14.052672Z",
      "disease_induction_date" : "2026-05-08"
    },
    "measurement" : {
      "id" : "mst_4Oms3uk4bRKkvBHxTUQMdq",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "animal_id" : "aml_41jYtEccE8Vc4CEvdVMTiO",
      "measured_at" : "2026-05-08",
      "calculations" : [ {
        "id" : "vbl_4cWwZMEhOaxhw4X02yAHxG",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_7bOSPKZzCJPUD6gepdQFAB",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_29KXP9ggLTgjJgpWxq55HX",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_7QVrdXWSnFIoLWbC56Ulid",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ ]
      } ],
      "created_at" : "2026-05-08T16:05:14.059496Z",
      "updated_at" : "2026-05-08T16:05:14.059496Z"
    },
    "user" : {
      "id" : "usr_3i6qVDsMRXyVtonAcIRuEe",
      "name" : "H1RJE Overwatch",
      "email" : "ccBRvy34@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:05:13.858480Z",
      "updated_at" : "2026-05-08T16:05:13.858480Z"
    },
    "treatment" : {
      "id" : "tmt_3l0ahnpGKHHKQqRYGd7KtQ",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "type" : "volume",
      "name" : "dquly4VhKQ",
      "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-05-08T16:05:14.068000Z",
      "updated_at" : "2026-05-08T16:05:14.068000Z",
      "external_entity_id" : "7ABYisDg7z"
    },
    "created_at" : "2026-05-08T16:05:14.072646Z",
    "updated_at" : "2026-05-08T16:05:14.072646Z"
  }
}

animal.dosage.deleted

Triggered when an animal dosage is deleted.

{
  "id" : "whe_g3WGXKktXoFLUEEGK9GY4",
  "client_id" : "147198b7-49c7-4a48-aa5e-43a4b0722588",
  "event" : "animal.dosage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.132110Z",
  "payload" : {
    "id" : "dsg_yUILZ7WoCdZX5jh03A9LX",
    "name" : "Example dosage",
    "dosed_at" : "2026-05-08T16:05:14.072637Z",
    "comments" : "50feHvDhBB",
    "weight_at_dosing" : null,
    "dose" : {
      "unit" : "mg/kg",
      "value" : "7.00",
      "display_unit" : "mg/kg",
      "display_value" : "7.00"
    },
    "dose_volume" : {
      "unit" : "ml/kg",
      "value" : "13.58",
      "display_unit" : "ml/kg",
      "display_value" : "13.58"
    },
    "stock" : {
      "unit" : "mg/ml",
      "value" : "23.63",
      "display_unit" : "mg/ml",
      "display_value" : "23.63"
    },
    "volume" : {
      "unit" : "µL",
      "value" : "31.48",
      "display_unit" : "µL",
      "display_value" : "31.48"
    },
    "study" : {
      "id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "project_id" : "pjt_43xPNRixT4DAH9KH518tn",
      "name" : "H41UqmwVUb",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3vrVyNiam8d8UHutSubWLg",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9GdSCwA7ry",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7I0WpVAZ5j4LgLzVCBL4PE",
        "name" : "HlFpWpknss",
        "email" : "9chQhkkg@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5b2DR6e4wFiPLt3EUoGG64",
        "name" : "eAiD6vcpRv",
        "email" : "qcfEpz64@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.887656Z",
      "updated_at" : "2026-05-08T16:05:13.887656Z"
    },
    "animal" : {
      "id" : "aml_41jYtEccE8Vc4CEvdVMTiO",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "study_group_id" : "grp_5Y7NLuKJnHF1BkHJfBWpCd",
      "cage_id" : "cge_1PELg3iG1mocer0AQXuTmi",
      "catalog" : "A0000001",
      "name" : "JmamKX2jtu",
      "number" : 1,
      "strain" : "l2CquDh51g",
      "species" : "nhLV0ew07w",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "0cccMaV4hR",
      "ear" : "Un0taR1GbC",
      "tag" : "jtMBueUZ7K",
      "donor" : "h93t8ZYs1q",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:14.052672Z",
      "updated_at" : "2026-05-08T16:05:14.052672Z",
      "disease_induction_date" : "2026-05-08"
    },
    "measurement" : {
      "id" : "mst_4Oms3uk4bRKkvBHxTUQMdq",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "animal_id" : "aml_41jYtEccE8Vc4CEvdVMTiO",
      "measured_at" : "2026-05-08",
      "calculations" : [ {
        "id" : "vbl_4cWwZMEhOaxhw4X02yAHxG",
        "key" : "tumour_volume",
        "name" : "Tumour Volume",
        "unit" : "mm³",
        "excluded" : false,
        "value" : "75",
        "formula" : "(width * width * length) / 2",
        "variables" : [ {
          "id" : "vbl_7bOSPKZzCJPUD6gepdQFAB",
          "key" : "width",
          "value" : "5",
          "unit" : "mm"
        }, {
          "id" : "vbl_29KXP9ggLTgjJgpWxq55HX",
          "key" : "length",
          "value" : "6",
          "unit" : "mm"
        } ]
      }, {
        "id" : "vbl_7QVrdXWSnFIoLWbC56Ulid",
        "key" : "weight",
        "name" : "Weight",
        "unit" : "g",
        "excluded" : false,
        "value" : "55",
        "formula" : "weight",
        "variables" : [ ]
      } ],
      "created_at" : "2026-05-08T16:05:14.059496Z",
      "updated_at" : "2026-05-08T16:05:14.059496Z"
    },
    "user" : {
      "id" : "usr_3i6qVDsMRXyVtonAcIRuEe",
      "name" : "H1RJE Overwatch",
      "email" : "ccBRvy34@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:05:13.858480Z",
      "updated_at" : "2026-05-08T16:05:13.858480Z"
    },
    "treatment" : {
      "id" : "tmt_3l0ahnpGKHHKQqRYGd7KtQ",
      "study_id" : "sdy_6t3m4Kfv4a0OXB9xkk0jM",
      "type" : "volume",
      "name" : "dquly4VhKQ",
      "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-05-08T16:05:14.068000Z",
      "updated_at" : "2026-05-08T16:05:14.068000Z",
      "external_entity_id" : "7ABYisDg7z"
    },
    "created_at" : "2026-05-08T16:05:14.072646Z",
    "updated_at" : "2026-05-08T16:05:14.072646Z"
  }
}

Animal Measurement

animal.measurement.created

Triggered when an animal measurement is created.

{
  "id" : "whe_3gJx6sFmn3lrzLecTl8v11",
  "client_id" : "03cb98c2-db4c-4927-8f99-2160da85ce08",
  "event" : "animal.measurement.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.809489Z",
  "payload" : {
    "id" : "mst_6jcWPfchtUniBaq6YI2F7f",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_4OtcmXuuXdimFUUd7KmLgk",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6wgRm8LnqoZbTdnBiqMXoY",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_7n38aMxlcmVhUEAMk8Ljxi",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1mAz5mnXVsgnnT9425VGZc",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "project_id" : "pjt_7DKfRmgRbmCwKfUs8SuTZB",
      "name" : "uycF2gE77K",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2A6jgST7wNU7fgvMLWlFsh",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "rDPeduiktk",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_65Z1iD3df5Gl7XzPnVo94E",
        "name" : "UkY9Ml9VkK",
        "email" : "43KXF9ZM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7cqAt3rzYZZd9AgE4QK5rK",
        "name" : "8GyilYXE0M",
        "email" : "txOK0tc9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:17.582999Z",
      "updated_at" : "2026-05-08T16:05:17.582999Z"
    },
    "animal" : {
      "id" : "aml_4CHdhoHxbwV8nPQnqoS48b",
      "study_id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "study_group_id" : "grp_5Fa3qQZTtZXK6ULaUVDzPo",
      "cage_id" : "cge_6FTExIaEnTnRV04i2rh5Vq",
      "catalog" : "A0000001",
      "name" : "bLGzyLYa8j",
      "number" : 1,
      "strain" : "4osZ6TdAw6",
      "species" : "DWtBM4j60Y",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "ehCHPG9Diy",
      "ear" : "W06yRitwIR",
      "tag" : "1wOscaPhHQ",
      "donor" : "SC22PEjmCS",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:17.755132Z",
      "updated_at" : "2026-05-08T16:05:17.755132Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_4FIwISfHzIQ3xC3Y07sczu",
      "name" : "Z69HdOrP3P",
      "email" : "3bHyEogh@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-05-08T16:05:17.565390Z",
      "updated_at" : "2026-05-08T16:05:17.565390Z"
    },
    "created_at" : "2026-05-08T16:05:17.761604Z",
    "updated_at" : "2026-05-08T16:05:17.761604Z"
  }
}

animal.measurement.updated

Triggered when an animal measurement is updated.

{
  "id" : "whe_3MFwjGAnniY3mhSeVNaMXK",
  "client_id" : "76cd706f-2993-402e-9029-e2bd0e6ef9a4",
  "event" : "animal.measurement.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.810592Z",
  "payload" : {
    "id" : "mst_6jcWPfchtUniBaq6YI2F7f",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_4OtcmXuuXdimFUUd7KmLgk",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6wgRm8LnqoZbTdnBiqMXoY",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_7n38aMxlcmVhUEAMk8Ljxi",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1mAz5mnXVsgnnT9425VGZc",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "project_id" : "pjt_7DKfRmgRbmCwKfUs8SuTZB",
      "name" : "uycF2gE77K",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2A6jgST7wNU7fgvMLWlFsh",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "rDPeduiktk",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_65Z1iD3df5Gl7XzPnVo94E",
        "name" : "UkY9Ml9VkK",
        "email" : "43KXF9ZM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7cqAt3rzYZZd9AgE4QK5rK",
        "name" : "8GyilYXE0M",
        "email" : "txOK0tc9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:17.582999Z",
      "updated_at" : "2026-05-08T16:05:17.582999Z"
    },
    "animal" : {
      "id" : "aml_4CHdhoHxbwV8nPQnqoS48b",
      "study_id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "study_group_id" : "grp_5Fa3qQZTtZXK6ULaUVDzPo",
      "cage_id" : "cge_6FTExIaEnTnRV04i2rh5Vq",
      "catalog" : "A0000001",
      "name" : "bLGzyLYa8j",
      "number" : 1,
      "strain" : "4osZ6TdAw6",
      "species" : "DWtBM4j60Y",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "ehCHPG9Diy",
      "ear" : "W06yRitwIR",
      "tag" : "1wOscaPhHQ",
      "donor" : "SC22PEjmCS",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:17.755132Z",
      "updated_at" : "2026-05-08T16:05:17.755132Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_4FIwISfHzIQ3xC3Y07sczu",
      "name" : "Z69HdOrP3P",
      "email" : "3bHyEogh@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-05-08T16:05:17.565390Z",
      "updated_at" : "2026-05-08T16:05:17.565390Z"
    },
    "created_at" : "2026-05-08T16:05:17.761604Z",
    "updated_at" : "2026-05-08T16:05:17.761604Z"
  }
}

animal.measurement.deleted

Triggered when an animal measurement is delete.

{
  "id" : "whe_3oaQd9v9hAkIp5iU2KSn6w",
  "client_id" : "b2df24fa-d16a-4d83-9aa8-89534c34045a",
  "event" : "animal.measurement.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.811212Z",
  "payload" : {
    "id" : "mst_6jcWPfchtUniBaq6YI2F7f",
    "measured_at" : "2026-05-08",
    "calculations" : [ {
      "id" : "vbl_4OtcmXuuXdimFUUd7KmLgk",
      "key" : "tumour_volume",
      "name" : "Tumour Volume",
      "unit" : "mm³",
      "excluded" : false,
      "value" : "75",
      "formula" : "(width * width * length) / 2",
      "variables" : [ {
        "id" : "vbl_6wgRm8LnqoZbTdnBiqMXoY",
        "key" : "width",
        "value" : "5",
        "unit" : "mm"
      }, {
        "id" : "vbl_7n38aMxlcmVhUEAMk8Ljxi",
        "key" : "length",
        "value" : "6",
        "unit" : "mm"
      } ]
    }, {
      "id" : "vbl_1mAz5mnXVsgnnT9425VGZc",
      "key" : "weight",
      "name" : "Weight",
      "unit" : "g",
      "excluded" : false,
      "value" : "55",
      "formula" : "weight",
      "variables" : [ ]
    } ],
    "study" : {
      "id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "project_id" : "pjt_7DKfRmgRbmCwKfUs8SuTZB",
      "name" : "uycF2gE77K",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_2A6jgST7wNU7fgvMLWlFsh",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "rDPeduiktk",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_65Z1iD3df5Gl7XzPnVo94E",
        "name" : "UkY9Ml9VkK",
        "email" : "43KXF9ZM@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_7cqAt3rzYZZd9AgE4QK5rK",
        "name" : "8GyilYXE0M",
        "email" : "txOK0tc9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:17.582999Z",
      "updated_at" : "2026-05-08T16:05:17.582999Z"
    },
    "animal" : {
      "id" : "aml_4CHdhoHxbwV8nPQnqoS48b",
      "study_id" : "sdy_3Br2Dng92Raz29YjsxjVfp",
      "study_group_id" : "grp_5Fa3qQZTtZXK6ULaUVDzPo",
      "cage_id" : "cge_6FTExIaEnTnRV04i2rh5Vq",
      "catalog" : "A0000001",
      "name" : "bLGzyLYa8j",
      "number" : 1,
      "strain" : "4osZ6TdAw6",
      "species" : "DWtBM4j60Y",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "ehCHPG9Diy",
      "ear" : "W06yRitwIR",
      "tag" : "1wOscaPhHQ",
      "donor" : "SC22PEjmCS",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:17.755132Z",
      "updated_at" : "2026-05-08T16:05:17.755132Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_4FIwISfHzIQ3xC3Y07sczu",
      "name" : "Z69HdOrP3P",
      "email" : "3bHyEogh@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : null,
      "created_at" : "2026-05-08T16:05:17.565390Z",
      "updated_at" : "2026-05-08T16:05:17.565390Z"
    },
    "created_at" : "2026-05-08T16:05:17.761604Z",
    "updated_at" : "2026-05-08T16:05:17.761604Z"
  }
}

Animal Observation

animal.observation.created

Triggered when an animal observation is created.

{
  "id" : "whe_40ZlRqHSIdPleDeTooFJq6",
  "client_id" : "035b597a-7d4e-4c7b-81d5-a4c51fde7df6",
  "event" : "animal.observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.599420Z",
  "payload" : {
    "id" : "obs_4MikMf014Q3iMB9goYDULw",
    "glossary_id" : "gly_SeDHyHfu5m4GuWpGGDs3H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:05:15.571902Z",
    "study" : {
      "id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "project_id" : "pjt_356cKyrvhoscRWhR73Mp2C",
      "name" : "a7BcH0sjFZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48veqgX9kuCeoQx87s0ahM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9o1PrrCrzp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_12y3TyQwz9ETC4eLYMNCI7",
        "name" : "wYXs9V6AmK",
        "email" : "lUHQqBWE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_64rTncWmY1s2IaMXaBHGk8",
        "name" : "roUbl4kpxR",
        "email" : "3dAAZjCQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.322352Z",
      "updated_at" : "2026-05-08T16:05:15.322352Z"
    },
    "animal" : {
      "id" : "aml_50YzaQwSrTVCz7k086ZK0q",
      "study_id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "study_group_id" : "grp_4TiKuqqHIR064jaKdJR5gS",
      "cage_id" : "cge_4JurIvy03INifCj6xQJ0j",
      "catalog" : "A0000001",
      "name" : "GDNdZ8jgpJ",
      "number" : 1,
      "strain" : "RO9WfAOi1V",
      "species" : "mRTwxUSQAN",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "l7ad1hh1J2",
      "ear" : "DdfqNYzb6P",
      "tag" : "5G8i9wxiIk",
      "donor" : "gnizwLFgiY",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_3VEOKnJCHM8ldcBIke3NNd",
        "name" : "gNt0aXBatv",
        "email" : "BM1Rf5Pz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3LxX4s0TPeKOBrhJE7Osqn",
        "title" : "Found dead",
        "comment" : "tm0UB223f7"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.494354Z",
      "updated_at" : "2026-05-08T16:05:15.494354Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_31f05KkJaGOib5ofOOHHzX",
      "name" : "o7SfD Overwatch",
      "email" : "7XQs57Hc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:05:15.253528Z",
      "updated_at" : "2026-05-08T16:05:15.253528Z"
    },
    "created_at" : "2026-05-08T16:05:15.571933Z",
    "updated_at" : "2026-05-08T16:05:15.571933Z"
  }
}

animal.observation.updated

Triggered when an animal observation is updated.

{
  "id" : "whe_6AU4muZZBkA4EpwTXIpmKD",
  "client_id" : "ffbe2347-9360-470d-ba36-8572c4e40601",
  "event" : "animal.observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.600841Z",
  "payload" : {
    "id" : "obs_4MikMf014Q3iMB9goYDULw",
    "glossary_id" : "gly_SeDHyHfu5m4GuWpGGDs3H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:05:15.571902Z",
    "study" : {
      "id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "project_id" : "pjt_356cKyrvhoscRWhR73Mp2C",
      "name" : "a7BcH0sjFZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48veqgX9kuCeoQx87s0ahM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9o1PrrCrzp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_12y3TyQwz9ETC4eLYMNCI7",
        "name" : "wYXs9V6AmK",
        "email" : "lUHQqBWE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_64rTncWmY1s2IaMXaBHGk8",
        "name" : "roUbl4kpxR",
        "email" : "3dAAZjCQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.322352Z",
      "updated_at" : "2026-05-08T16:05:15.322352Z"
    },
    "animal" : {
      "id" : "aml_50YzaQwSrTVCz7k086ZK0q",
      "study_id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "study_group_id" : "grp_4TiKuqqHIR064jaKdJR5gS",
      "cage_id" : "cge_4JurIvy03INifCj6xQJ0j",
      "catalog" : "A0000001",
      "name" : "GDNdZ8jgpJ",
      "number" : 1,
      "strain" : "RO9WfAOi1V",
      "species" : "mRTwxUSQAN",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "l7ad1hh1J2",
      "ear" : "DdfqNYzb6P",
      "tag" : "5G8i9wxiIk",
      "donor" : "gnizwLFgiY",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_3VEOKnJCHM8ldcBIke3NNd",
        "name" : "gNt0aXBatv",
        "email" : "BM1Rf5Pz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3LxX4s0TPeKOBrhJE7Osqn",
        "title" : "Found dead",
        "comment" : "tm0UB223f7"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.494354Z",
      "updated_at" : "2026-05-08T16:05:15.494354Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_31f05KkJaGOib5ofOOHHzX",
      "name" : "o7SfD Overwatch",
      "email" : "7XQs57Hc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:05:15.253528Z",
      "updated_at" : "2026-05-08T16:05:15.253528Z"
    },
    "created_at" : "2026-05-08T16:05:15.571933Z",
    "updated_at" : "2026-05-08T16:05:15.571933Z"
  }
}

animal.observation.deleted

Triggered when an animal observation is deleted.

{
  "id" : "whe_1Z56rtRteu0Tgj6iffcu2M",
  "client_id" : "4ae4848c-78f7-46db-b0dc-a5533f96c87f",
  "event" : "animal.observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.601879Z",
  "payload" : {
    "id" : "obs_4MikMf014Q3iMB9goYDULw",
    "glossary_id" : "gly_SeDHyHfu5m4GuWpGGDs3H",
    "team_glossary_api_id" : null,
    "title" : null,
    "label" : null,
    "text" : "Example text",
    "type" : "severity",
    "value" : "Severe",
    "observed_at" : "2026-05-08T16:05:15.571902Z",
    "study" : {
      "id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "project_id" : "pjt_356cKyrvhoscRWhR73Mp2C",
      "name" : "a7BcH0sjFZ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_48veqgX9kuCeoQx87s0ahM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9o1PrrCrzp",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_12y3TyQwz9ETC4eLYMNCI7",
        "name" : "wYXs9V6AmK",
        "email" : "lUHQqBWE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_64rTncWmY1s2IaMXaBHGk8",
        "name" : "roUbl4kpxR",
        "email" : "3dAAZjCQ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.322352Z",
      "updated_at" : "2026-05-08T16:05:15.322352Z"
    },
    "animal" : {
      "id" : "aml_50YzaQwSrTVCz7k086ZK0q",
      "study_id" : "sdy_12yCeBPDI7WPKwQqUkb9S8",
      "study_group_id" : "grp_4TiKuqqHIR064jaKdJR5gS",
      "cage_id" : "cge_4JurIvy03INifCj6xQJ0j",
      "catalog" : "A0000001",
      "name" : "GDNdZ8jgpJ",
      "number" : 1,
      "strain" : "RO9WfAOi1V",
      "species" : "mRTwxUSQAN",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "l7ad1hh1J2",
      "ear" : "DdfqNYzb6P",
      "tag" : "5G8i9wxiIk",
      "donor" : "gnizwLFgiY",
      "tracking_date" : "2026-05-08",
      "terminated_at" : "2026-05-08",
      "terminated_by" : {
        "id" : "usr_3VEOKnJCHM8ldcBIke3NNd",
        "name" : "gNt0aXBatv",
        "email" : "BM1Rf5Pz@benchling.com",
        "timezone" : "UTC"
      },
      "terminated_reason" : {
        "glossary_id" : "gly_3LxX4s0TPeKOBrhJE7Osqn",
        "title" : "Found dead",
        "comment" : "tm0UB223f7"
      },
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.494354Z",
      "updated_at" : "2026-05-08T16:05:15.494354Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_31f05KkJaGOib5ofOOHHzX",
      "name" : "o7SfD Overwatch",
      "email" : "7XQs57Hc@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "user-internal-id" : "USER-1234"
      },
      "created_at" : "2026-05-08T16:05:15.253528Z",
      "updated_at" : "2026-05-08T16:05:15.253528Z"
    },
    "created_at" : "2026-05-08T16:05:15.571933Z",
    "updated_at" : "2026-05-08T16:05:15.571933Z"
  }
}

Animal Sample

animal.sample.created

Triggered when an animal sample is created.

{
  "id" : "whe_6GUNfAIUa3KaAr0G1CTLg8",
  "client_id" : "5ed1aa6a-94f9-4b89-8740-0104c77fc2cf",
  "event" : "animal.sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.102631Z",
  "payload" : {
    "id" : "spl_4T4gpFZpynj56Wkjn1d2WZ",
    "sample_id" : "S772621838",
    "sample_definition_id" : "sdf_1bdsOlVnsjsC5l4xgDjS2P",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:05:16.072307Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1427250008" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "project_id" : "pjt_6jq0PrRx6JT5SOnixlVJA",
      "name" : "4yF7agfIRG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ycCagnuCLO19T5GJmgbCJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "ju155TUVpX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6Dj7IdbMykADVZeOQlLCqc",
        "name" : "jc4W7GQpnh",
        "email" : "VRWMHqAU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_lirXP3vCaRNe9YWPW73qK",
        "name" : "Nvp0k8GbYv",
        "email" : "oKtQNndU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.832385Z",
      "updated_at" : "2026-05-08T16:05:15.832385Z"
    },
    "animal" : {
      "id" : "aml_65bBPt4MdDoMkCr7FUmkdO",
      "study_id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "study_group_id" : "grp_rfUZmBs8qMOcvhw0o7WgQ",
      "cage_id" : "cge_4KVkIUkDFWyuDDbrDlRoIl",
      "catalog" : "A0000001",
      "name" : "vk7OPmccJr",
      "number" : 1,
      "strain" : "pPSh4rEj6K",
      "species" : "QxEzvjUx6j",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "P8s5uvMJ2h",
      "ear" : "ElOhZT3jFr",
      "tag" : "2n2plvkJri",
      "donor" : "alEsIuipCU",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.992175Z",
      "updated_at" : "2026-05-08T16:05:15.992175Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_5yVEnVRTOnsugltRqQ2lpj",
      "name" : "VQ2e5NFZgH",
      "email" : "Eo6Eklem@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "GCu7Y5K1Gi" : "CaVkAaaUmg"
      },
      "created_at" : "2026-05-08T16:05:16.061430Z",
      "updated_at" : "2026-05-08T16:05:16.061430Z"
    },
    "created_at" : "2026-05-08T16:05:16.072389Z",
    "updated_at" : "2026-05-08T16:05:16.072389Z"
  }
}

animal.sample.updated

Triggered when an animal sample is updated.

{
  "id" : "whe_2Hxl7gdgSLcmpBK0eELwC1",
  "client_id" : "f253b910-1815-4009-869f-dd77631eb262",
  "event" : "animal.sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.104057Z",
  "payload" : {
    "id" : "spl_4T4gpFZpynj56Wkjn1d2WZ",
    "sample_id" : "S772621838",
    "sample_definition_id" : "sdf_1bdsOlVnsjsC5l4xgDjS2P",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:05:16.072307Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1427250008" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "project_id" : "pjt_6jq0PrRx6JT5SOnixlVJA",
      "name" : "4yF7agfIRG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ycCagnuCLO19T5GJmgbCJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "ju155TUVpX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6Dj7IdbMykADVZeOQlLCqc",
        "name" : "jc4W7GQpnh",
        "email" : "VRWMHqAU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_lirXP3vCaRNe9YWPW73qK",
        "name" : "Nvp0k8GbYv",
        "email" : "oKtQNndU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.832385Z",
      "updated_at" : "2026-05-08T16:05:15.832385Z"
    },
    "animal" : {
      "id" : "aml_65bBPt4MdDoMkCr7FUmkdO",
      "study_id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "study_group_id" : "grp_rfUZmBs8qMOcvhw0o7WgQ",
      "cage_id" : "cge_4KVkIUkDFWyuDDbrDlRoIl",
      "catalog" : "A0000001",
      "name" : "vk7OPmccJr",
      "number" : 1,
      "strain" : "pPSh4rEj6K",
      "species" : "QxEzvjUx6j",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "P8s5uvMJ2h",
      "ear" : "ElOhZT3jFr",
      "tag" : "2n2plvkJri",
      "donor" : "alEsIuipCU",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.992175Z",
      "updated_at" : "2026-05-08T16:05:15.992175Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_5yVEnVRTOnsugltRqQ2lpj",
      "name" : "VQ2e5NFZgH",
      "email" : "Eo6Eklem@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "GCu7Y5K1Gi" : "CaVkAaaUmg"
      },
      "created_at" : "2026-05-08T16:05:16.061430Z",
      "updated_at" : "2026-05-08T16:05:16.061430Z"
    },
    "created_at" : "2026-05-08T16:05:16.072389Z",
    "updated_at" : "2026-05-08T16:05:16.072389Z"
  }
}

animal.sample.deleted

Triggered when an animal sample is deleted.

{
  "id" : "whe_2he5SFtTB0ild42VHdpugP",
  "client_id" : "852441a8-0d3f-4b32-a872-2a42388a1a80",
  "event" : "animal.sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.104804Z",
  "payload" : {
    "id" : "spl_4T4gpFZpynj56Wkjn1d2WZ",
    "sample_id" : "S772621838",
    "sample_definition_id" : "sdf_1bdsOlVnsjsC5l4xgDjS2P",
    "type" : "Blood",
    "label" : "BLOOD",
    "status" : "collected",
    "timepoint" : "PT15M",
    "collected_at" : "2026-05-08T18:05:16.072307Z",
    "details" : [ {
      "key" : "volume",
      "unit" : "ml",
      "value" : "5"
    } ],
    "comments" : "A blood sample",
    "metadata" : {
      "sample-internal-id-1427250008" : "SMPL-1234"
    },
    "study" : {
      "id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "project_id" : "pjt_6jq0PrRx6JT5SOnixlVJA",
      "name" : "4yF7agfIRG",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_ycCagnuCLO19T5GJmgbCJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "ju155TUVpX",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6Dj7IdbMykADVZeOQlLCqc",
        "name" : "jc4W7GQpnh",
        "email" : "VRWMHqAU@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_lirXP3vCaRNe9YWPW73qK",
        "name" : "Nvp0k8GbYv",
        "email" : "oKtQNndU@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:15.832385Z",
      "updated_at" : "2026-05-08T16:05:15.832385Z"
    },
    "animal" : {
      "id" : "aml_65bBPt4MdDoMkCr7FUmkdO",
      "study_id" : "sdy_4Kt6BLA8JL33iyWVgTiIsM",
      "study_group_id" : "grp_rfUZmBs8qMOcvhw0o7WgQ",
      "cage_id" : "cge_4KVkIUkDFWyuDDbrDlRoIl",
      "catalog" : "A0000001",
      "name" : "vk7OPmccJr",
      "number" : 1,
      "strain" : "pPSh4rEj6K",
      "species" : "QxEzvjUx6j",
      "sex" : "m",
      "dob" : "2026-05-07",
      "tail" : "P8s5uvMJ2h",
      "ear" : "ElOhZT3jFr",
      "tag" : "2n2plvkJri",
      "donor" : "alEsIuipCU",
      "tracking_date" : "2026-05-08",
      "terminated_at" : null,
      "terminated_by" : null,
      "terminated_reason" : null,
      "disease_survivor" : null,
      "metadata" : {
        "animal-internal-id" : "ANIMAL-1234"
      },
      "created_at" : "2026-05-08T16:05:15.992175Z",
      "updated_at" : "2026-05-08T16:05:15.992175Z",
      "disease_induction_date" : "2026-05-08"
    },
    "user" : {
      "id" : "usr_5yVEnVRTOnsugltRqQ2lpj",
      "name" : "VQ2e5NFZgH",
      "email" : "Eo6Eklem@benchling.com",
      "timezone" : "UTC",
      "status" : "active",
      "metadata" : {
        "GCu7Y5K1Gi" : "CaVkAaaUmg"
      },
      "created_at" : "2026-05-08T16:05:16.061430Z",
      "updated_at" : "2026-05-08T16:05:16.061430Z"
    },
    "created_at" : "2026-05-08T16:05:16.072389Z",
    "updated_at" : "2026-05-08T16:05:16.072389Z"
  }
}

Cage

cage.created

Triggered when an cage is created.

{
  "id" : "whe_19dZT5CWI4aPszZZ9pnatt",
  "client_id" : "18e437f2-9de7-45cd-bbb8-1f314c6db7bf",
  "event" : "cage.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.352955Z",
  "payload" : {
    "id" : "cge_4p2p0pxuKoSnLvXxji8iCL",
    "name" : "Dyc0PP1cF5",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_309UpjBrdd2LxIezS4jayN",
      "project_id" : "pjt_5UwKct8BKeyQgiccOpbQ1z",
      "name" : "Maq4NGAAQP",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3Wgn3Ob1tUJSDaFGLbqxQM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "MNMVn6J9bt",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_YQ1nAQf0dw4pexGDFy2L2",
        "name" : "OqIRQ64lum",
        "email" : "xVTi1TkI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5BmxBuS4O24sWfbhmYnfDx",
        "name" : "e3m4dPOcGA",
        "email" : "AMca5HLp@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.178141Z",
      "updated_at" : "2026-05-08T16:05:13.178141Z"
    },
    "created_at" : "2026-05-08T16:05:13.327699Z",
    "updated_at" : "2026-05-08T16:05:13.327699Z"
  }
}

cage.updated

Triggered when an cage is updated.

{
  "id" : "whe_2ddkqyzK05rcsav6dXly9j",
  "client_id" : "f0523e57-da2c-46ca-a1db-685755ac146d",
  "event" : "cage.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.354389Z",
  "payload" : {
    "id" : "cge_4p2p0pxuKoSnLvXxji8iCL",
    "name" : "Dyc0PP1cF5",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_309UpjBrdd2LxIezS4jayN",
      "project_id" : "pjt_5UwKct8BKeyQgiccOpbQ1z",
      "name" : "Maq4NGAAQP",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3Wgn3Ob1tUJSDaFGLbqxQM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "MNMVn6J9bt",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_YQ1nAQf0dw4pexGDFy2L2",
        "name" : "OqIRQ64lum",
        "email" : "xVTi1TkI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5BmxBuS4O24sWfbhmYnfDx",
        "name" : "e3m4dPOcGA",
        "email" : "AMca5HLp@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.178141Z",
      "updated_at" : "2026-05-08T16:05:13.178141Z"
    },
    "created_at" : "2026-05-08T16:05:13.327699Z",
    "updated_at" : "2026-05-08T16:05:13.327699Z"
  }
}

cage.deleted

Triggered when an cage is deleted.

{
  "id" : "whe_3kjeVJAKg5XtBcW2m7Lv3j",
  "client_id" : "7d9d640b-539f-4f32-b130-a7280d89f754",
  "event" : "cage.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.355058Z",
  "payload" : {
    "id" : "cge_4p2p0pxuKoSnLvXxji8iCL",
    "name" : "Dyc0PP1cF5",
    "catalog" : "C0000001",
    "metadata" : {
      "cage-internal-id" : "CAGE-1234"
    },
    "study" : {
      "id" : "sdy_309UpjBrdd2LxIezS4jayN",
      "project_id" : "pjt_5UwKct8BKeyQgiccOpbQ1z",
      "name" : "Maq4NGAAQP",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_3Wgn3Ob1tUJSDaFGLbqxQM",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "MNMVn6J9bt",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_YQ1nAQf0dw4pexGDFy2L2",
        "name" : "OqIRQ64lum",
        "email" : "xVTi1TkI@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_5BmxBuS4O24sWfbhmYnfDx",
        "name" : "e3m4dPOcGA",
        "email" : "AMca5HLp@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.178141Z",
      "updated_at" : "2026-05-08T16:05:13.178141Z"
    },
    "created_at" : "2026-05-08T16:05:13.327699Z",
    "updated_at" : "2026-05-08T16:05:13.327699Z"
  }
}

Species

species.created

Triggered when a species is created.

{
  "id" : "whe_31vyywvvWaueuo6kNTAFQ9",
  "client_id" : "e62f17ee-31eb-41f0-8a62-731d146ecb19",
  "event" : "species.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.852047Z",
  "payload" : {
    "id" : "spc_36dGrsdLKs2RAuuCaUrsvp",
    "name" : "fTgK86PIXj",
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.836927Z",
    "updated_at" : "2026-05-08T16:05:16.836927Z"
  }
}

species.updated

Triggered when a species is updated.

{
  "id" : "whe_1fPbLCVmpRqFXRkcPTVLf9",
  "client_id" : "1fe89130-99aa-4123-a459-42d74937d6a1",
  "event" : "species.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.852983Z",
  "payload" : {
    "id" : "spc_36dGrsdLKs2RAuuCaUrsvp",
    "name" : "fTgK86PIXj",
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.836927Z",
    "updated_at" : "2026-05-08T16:05:16.836927Z"
  }
}

species.deleted

Triggered when a species is deleted.

{
  "id" : "whe_31QLpAg0OZTH2RhjTAGeoR",
  "client_id" : "56bb92f6-cb20-47a8-a2d4-4cef7138f3c7",
  "event" : "species.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.853521Z",
  "payload" : {
    "id" : "spc_36dGrsdLKs2RAuuCaUrsvp",
    "name" : "fTgK86PIXj",
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.836927Z",
    "updated_at" : "2026-05-08T16:05:16.836927Z"
  }
}

Strain

strain.created

Triggered when a strain is created.

{
  "id" : "whe_4BkgcWpENJHXRwi3jxMAS9",
  "client_id" : "f97648f7-b3bf-4fed-bb25-2b2e9888a71d",
  "event" : "strain.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.664247Z",
  "payload" : {
    "id" : "stn_10D2ur4vZJQmooyG4UNWcV",
    "name" : "27N729W5hK",
    "species" : {
      "id" : "spc_27rpJzqdYE3GK2p5fGqe1a",
      "name" : "HHAlwS1ktY",
      "active" : true,
      "created_at" : "2026-05-08T16:05:16.642824Z",
      "updated_at" : "2026-05-08T16:05:16.642824Z"
    },
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.644857Z",
    "updated_at" : "2026-05-08T16:05:16.644857Z"
  }
}

strain.updated

Triggered when a strain is updated.

{
  "id" : "whe_2X9eP4A7FPPCazDJYkDICI",
  "client_id" : "1259a935-844e-47d6-9984-fa44c88503e7",
  "event" : "strain.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.665421Z",
  "payload" : {
    "id" : "stn_10D2ur4vZJQmooyG4UNWcV",
    "name" : "27N729W5hK",
    "species" : {
      "id" : "spc_27rpJzqdYE3GK2p5fGqe1a",
      "name" : "HHAlwS1ktY",
      "active" : true,
      "created_at" : "2026-05-08T16:05:16.642824Z",
      "updated_at" : "2026-05-08T16:05:16.642824Z"
    },
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.644857Z",
    "updated_at" : "2026-05-08T16:05:16.644857Z"
  }
}

strain.deleted

Triggered when a strain is deleted.

{
  "id" : "whe_CQPKK9MfKJqq2ENB2W8mk",
  "client_id" : "ee45a58d-b7a3-4cef-a016-5a686e7ab899",
  "event" : "strain.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.666244Z",
  "payload" : {
    "id" : "stn_10D2ur4vZJQmooyG4UNWcV",
    "name" : "27N729W5hK",
    "species" : {
      "id" : "spc_27rpJzqdYE3GK2p5fGqe1a",
      "name" : "HHAlwS1ktY",
      "active" : true,
      "created_at" : "2026-05-08T16:05:16.642824Z",
      "updated_at" : "2026-05-08T16:05:16.642824Z"
    },
    "active" : true,
    "created_at" : "2026-05-08T16:05:16.644857Z",
    "updated_at" : "2026-05-08T16:05:16.644857Z"
  }
}

Study

study.created

Triggered when a study is created.

{
  "id" : "whe_5zPRXhEzLjuTIHr7dEEA8L",
  "client_id" : "74ec3ba4-a16c-4ce1-9297-a5c75f4b1faa",
  "event" : "study.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.403804Z",
  "payload" : {
    "id" : "sdy_7c8bKLvtBiJ95FLkV5tEFj",
    "name" : "RH2n5smwnC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4zKXmi3cPCM3cCfw1hHcZV",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "ZxlWFsllax",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_5ytyCqeCebkIgy1OGK9vlc",
      "name" : "5XsKyKzvfJ",
      "email" : "NFfFkS3T@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1qPmJcTvXGRTh1Gemj1k8w",
      "name" : "UnuKP5abN5",
      "email" : "8sHCOdLT@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_3aEU1W5M2c4qF65zJ7WxZ4",
      "name" : "0WNcvE0jiV",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:05:14.223410Z",
      "updated_at" : "2026-05-08T16:05:14.223410Z"
    },
    "started_on" : "2026-05-08",
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:14.235228Z",
    "updated_at" : "2026-05-08T16:05:14.235228Z"
  }
}

study.updated

Triggered when a study is updated.

{
  "id" : "whe_1lfLBYhxzoPjDWv0RNRTXL",
  "client_id" : "09f50f58-b84d-47c7-b55f-cfb1972a3ffa",
  "event" : "study.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.405153Z",
  "payload" : {
    "id" : "sdy_7c8bKLvtBiJ95FLkV5tEFj",
    "name" : "RH2n5smwnC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4zKXmi3cPCM3cCfw1hHcZV",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "ZxlWFsllax",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_5ytyCqeCebkIgy1OGK9vlc",
      "name" : "5XsKyKzvfJ",
      "email" : "NFfFkS3T@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1qPmJcTvXGRTh1Gemj1k8w",
      "name" : "UnuKP5abN5",
      "email" : "8sHCOdLT@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_3aEU1W5M2c4qF65zJ7WxZ4",
      "name" : "0WNcvE0jiV",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:05:14.223410Z",
      "updated_at" : "2026-05-08T16:05:14.223410Z"
    },
    "started_on" : "2026-05-08",
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:14.235228Z",
    "updated_at" : "2026-05-08T16:05:14.235228Z"
  }
}

study.deleted

Triggered when a study is deleted.

{
  "id" : "whe_7EwcG2dTs8F2wrDW2TEEC0",
  "client_id" : "ee96f6b5-cf7d-49d6-a6ed-e8b11ae29e09",
  "event" : "study.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.405906Z",
  "payload" : {
    "id" : "sdy_7c8bKLvtBiJ95FLkV5tEFj",
    "name" : "RH2n5smwnC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4zKXmi3cPCM3cCfw1hHcZV",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "ZxlWFsllax",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_5ytyCqeCebkIgy1OGK9vlc",
      "name" : "5XsKyKzvfJ",
      "email" : "NFfFkS3T@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1qPmJcTvXGRTh1Gemj1k8w",
      "name" : "UnuKP5abN5",
      "email" : "8sHCOdLT@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_3aEU1W5M2c4qF65zJ7WxZ4",
      "name" : "0WNcvE0jiV",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:05:14.223410Z",
      "updated_at" : "2026-05-08T16:05:14.223410Z"
    },
    "started_on" : "2026-05-08",
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:14.235228Z",
    "updated_at" : "2026-05-08T16:05:14.235228Z"
  }
}

study.metadata.updated

Triggered when a study metadata is updated.

{
  "id" : "whe_74TTGeSKW2VakWgVD2d27J",
  "client_id" : "8536e486-938f-48c8-8443-9029c75b6139",
  "event" : "study.metadata.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.406711Z",
  "payload" : {
    "id" : "sdy_7c8bKLvtBiJ95FLkV5tEFj",
    "name" : "RH2n5smwnC",
    "code" : "CD-26-445",
    "study_code_id" : "sdc_4zKXmi3cPCM3cCfw1hHcZV",
    "type" : "internal",
    "status" : "in_progress",
    "description" : "ZxlWFsllax",
    "timezone" : "America/Los_Angeles",
    "metadata" : {
      "study-internal-id" : "STUDY-1234"
    },
    "author" : {
      "id" : "usr_5ytyCqeCebkIgy1OGK9vlc",
      "name" : "5XsKyKzvfJ",
      "email" : "NFfFkS3T@benchling.com",
      "timezone" : "UTC"
    },
    "owner" : {
      "id" : "usr_1qPmJcTvXGRTh1Gemj1k8w",
      "name" : "UnuKP5abN5",
      "email" : "8sHCOdLT@benchling.com",
      "timezone" : "UTC"
    },
    "project" : {
      "id" : "pjt_3aEU1W5M2c4qF65zJ7WxZ4",
      "name" : "0WNcvE0jiV",
      "metadata" : {
        "project-internal-id" : "PROJ-1234"
      },
      "created_at" : "2026-05-08T16:05:14.223410Z",
      "updated_at" : "2026-05-08T16:05:14.223410Z"
    },
    "started_on" : "2026-05-08",
    "completed_at" : null,
    "canceled_at" : null,
    "created_at" : "2026-05-08T16:05:14.235228Z",
    "updated_at" : "2026-05-08T16:05:14.235228Z"
  }
}

Study Group

study.group.created

Triggered when a study group is created.

{
  "id" : "whe_6ZuxJP7aYt24HmbY0RmXdY",
  "client_id" : "f56c6789-cb1b-4d34-9202-2f1b36d9826c",
  "event" : "study.group.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.891973Z",
  "payload" : {
    "id" : "grp_5BiLU0Ov9xk8C1aNXFCq1h",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_4R7BPDw7g5ePCTHnpUGMGi",
      "project_id" : "pjt_6XQNvwwRi8rcMsGStQCJ3C",
      "name" : "qSOpE2MUyw",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_15O9QvY2p6LZmcg52Cf0Tp",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "Qp4QFAf7lD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6FP1TEhC0cZPEoo2Z2StYz",
        "name" : "VHOp3CJze9",
        "email" : "7BMrKPt6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_jjTlZEjmNAe2eDK2oTS4b",
        "name" : "2A9x1ay0x8",
        "email" : "BTFrbnI4@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.709161Z",
      "updated_at" : "2026-05-08T16:05:14.709161Z"
    },
    "created_at" : "2026-05-08T16:05:14.859304Z",
    "updated_at" : "2026-05-08T16:05:14.859304Z"
  }
}

study.group.updated

Triggered when a study group is updated.

{
  "id" : "whe_1nqk6brEHhDiUKJGFMV5N2",
  "client_id" : "4663d064-7e9e-4a11-9c33-5c6961e2aff6",
  "event" : "study.group.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.893070Z",
  "payload" : {
    "id" : "grp_5BiLU0Ov9xk8C1aNXFCq1h",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_4R7BPDw7g5ePCTHnpUGMGi",
      "project_id" : "pjt_6XQNvwwRi8rcMsGStQCJ3C",
      "name" : "qSOpE2MUyw",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_15O9QvY2p6LZmcg52Cf0Tp",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "Qp4QFAf7lD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6FP1TEhC0cZPEoo2Z2StYz",
        "name" : "VHOp3CJze9",
        "email" : "7BMrKPt6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_jjTlZEjmNAe2eDK2oTS4b",
        "name" : "2A9x1ay0x8",
        "email" : "BTFrbnI4@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.709161Z",
      "updated_at" : "2026-05-08T16:05:14.709161Z"
    },
    "created_at" : "2026-05-08T16:05:14.859304Z",
    "updated_at" : "2026-05-08T16:05:14.859304Z"
  }
}

study.group.deleted

Triggered when a study group is deleted.

{
  "id" : "whe_1uFlJyQWiJTmgRyfzMaRDA",
  "client_id" : "33a8a037-96cf-4ca7-a0be-1d34d8520ed7",
  "event" : "study.group.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.893610Z",
  "payload" : {
    "id" : "grp_5BiLU0Ov9xk8C1aNXFCq1h",
    "name" : "A",
    "no" : 1,
    "color" : "#34e8eb",
    "max_animals" : 10,
    "control" : false,
    "metadata" : {
      "study-group-internal-id" : "SYSGROUP-A1"
    },
    "study" : {
      "id" : "sdy_4R7BPDw7g5ePCTHnpUGMGi",
      "project_id" : "pjt_6XQNvwwRi8rcMsGStQCJ3C",
      "name" : "qSOpE2MUyw",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_15O9QvY2p6LZmcg52Cf0Tp",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "Qp4QFAf7lD",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_6FP1TEhC0cZPEoo2Z2StYz",
        "name" : "VHOp3CJze9",
        "email" : "7BMrKPt6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_jjTlZEjmNAe2eDK2oTS4b",
        "name" : "2A9x1ay0x8",
        "email" : "BTFrbnI4@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.709161Z",
      "updated_at" : "2026-05-08T16:05:14.709161Z"
    },
    "created_at" : "2026-05-08T16:05:14.859304Z",
    "updated_at" : "2026-05-08T16:05:14.859304Z"
  }
}

Study Request

study.request.created

Triggered when a request is created.

{
  "id" : "whe_7ShbGdMm6ADyM2Hvof92Bk",
  "client_id" : "e9bbc267-f7f5-402e-8c9f-9fac8c83f686",
  "event" : "study.request.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.155565Z",
  "payload" : {
    "id" : "req_6cW8eybtXDDNbauJ2RAFvK",
    "user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "assigned_user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "status" : "pending",
    "due_date" : "2026-05-08",
    "groups" : [ {
      "ref" : "slYQHZQ1ER",
      "label" : "HkGdG7SL7d"
    } ],
    "fields" : [ {
      "group_ref" : "slYQHZQ1ER",
      "label" : "XGAjaCJYPz",
      "value" : "lVeyahE37T",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_4Uk775ym2Yk2l3WPDTFrOp",
      "project_id" : "pjt_5sq7ro54H0xHc5P8BijcHS",
      "name" : "gzA0qjz1FJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_50VowZJSey6UipSogpRear",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9s3u2GpPG8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1c99abaPgiaaa0TJRijlPP",
        "name" : "xFs9gkrR6S",
        "email" : "GTpf3ajr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1H49tIsIyYVrwjQpG2AC48",
        "name" : "U3Dry0bhtc",
        "email" : "9d2N5uP2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:12.895392Z",
      "updated_at" : "2026-05-08T16:05:12.895392Z"
    },
    "created_at" : "2026-05-08T16:05:13.134270Z",
    "updated_at" : "2026-05-08T16:05:13.134270Z"
  }
}

study.request.updated

Triggered when a request is updated.

{
  "id" : "whe_3mkfz8tKPKRUizWeFP8oTP",
  "client_id" : "42bab91d-999c-411a-b124-1b8355af61f6",
  "event" : "study.request.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.156767Z",
  "payload" : {
    "id" : "req_6cW8eybtXDDNbauJ2RAFvK",
    "user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "assigned_user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "status" : "pending",
    "due_date" : "2026-05-08",
    "groups" : [ {
      "ref" : "slYQHZQ1ER",
      "label" : "HkGdG7SL7d"
    } ],
    "fields" : [ {
      "group_ref" : "slYQHZQ1ER",
      "label" : "XGAjaCJYPz",
      "value" : "lVeyahE37T",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_4Uk775ym2Yk2l3WPDTFrOp",
      "project_id" : "pjt_5sq7ro54H0xHc5P8BijcHS",
      "name" : "gzA0qjz1FJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_50VowZJSey6UipSogpRear",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9s3u2GpPG8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1c99abaPgiaaa0TJRijlPP",
        "name" : "xFs9gkrR6S",
        "email" : "GTpf3ajr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1H49tIsIyYVrwjQpG2AC48",
        "name" : "U3Dry0bhtc",
        "email" : "9d2N5uP2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:12.895392Z",
      "updated_at" : "2026-05-08T16:05:12.895392Z"
    },
    "created_at" : "2026-05-08T16:05:13.134270Z",
    "updated_at" : "2026-05-08T16:05:13.134270Z"
  }
}

study.request.deleted

Triggered when a request is deleted.

{
  "id" : "whe_705xEHk9CFXKbSqVzEDtTW",
  "client_id" : "ee692592-8f3d-44a8-98c3-9b09efdf9eb0",
  "event" : "study.request.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.157382Z",
  "payload" : {
    "id" : "req_6cW8eybtXDDNbauJ2RAFvK",
    "user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "assigned_user_id" : "usr_6obQY07bYeDB5nV88uzCRd",
    "status" : "pending",
    "due_date" : "2026-05-08",
    "groups" : [ {
      "ref" : "slYQHZQ1ER",
      "label" : "HkGdG7SL7d"
    } ],
    "fields" : [ {
      "group_ref" : "slYQHZQ1ER",
      "label" : "XGAjaCJYPz",
      "value" : "lVeyahE37T",
      "options" : [ null ]
    } ],
    "study" : {
      "id" : "sdy_4Uk775ym2Yk2l3WPDTFrOp",
      "project_id" : "pjt_5sq7ro54H0xHc5P8BijcHS",
      "name" : "gzA0qjz1FJ",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_50VowZJSey6UipSogpRear",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "9s3u2GpPG8",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_1c99abaPgiaaa0TJRijlPP",
        "name" : "xFs9gkrR6S",
        "email" : "GTpf3ajr@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_1H49tIsIyYVrwjQpG2AC48",
        "name" : "U3Dry0bhtc",
        "email" : "9d2N5uP2@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:12.895392Z",
      "updated_at" : "2026-05-08T16:05:12.895392Z"
    },
    "created_at" : "2026-05-08T16:05:13.134270Z",
    "updated_at" : "2026-05-08T16:05:13.134270Z"
  }
}

Study Sample Plan [BETA]

study.sample_definition.created

Triggered when a sample plan definition is created.

{
  "id" : "whe_3Db64MaJ7GYnlBdcbfN9eH",
  "client_id" : "b95d5c30-52e0-49b3-b2e8-d3754ea3ee61",
  "event" : "study.sample_definition.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.786161Z",
  "payload" : {
    "id" : "sdf_3hDFqcw8NoygaUMnIfDPjq",
    "sample_type" : {
      "team_glossary_id" : "tgy_oBFZfmnP09yuByrpBDrao",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "unit" : "5",
      "value" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1L3MbFn2TlJHvfyPEdLyMK",
      "project_id" : "pjt_4NhraGuq0SPUAymxDoEDwv",
      "name" : "bZ9lgaJOn2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hYDlaY0CmwilDne5dnFgJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "7Tkp8n8Tjm",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5ug60oneAVPcPxWeYZALZQ",
        "name" : "wQFlLbog1w",
        "email" : "QxqBe7rB@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_412gR0q8XuQU1rMxaM29l8",
        "name" : "drLGikuwzJ",
        "email" : "WGiEJqKv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.592148Z",
      "updated_at" : "2026-05-08T16:05:13.592148Z"
    },
    "created_at" : "2026-05-08T16:05:13.739449Z",
    "updated_at" : "2026-05-08T16:05:13.739449Z"
  }
}

study.sample_definition.updated

Triggered when a sample plan definition is updated.

{
  "id" : "whe_1Rwe7HKvQSfCnIen9Hxcdj",
  "client_id" : "2520e970-e3be-4de3-804d-0800c60636eb",
  "event" : "study.sample_definition.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.787739Z",
  "payload" : {
    "id" : "sdf_3hDFqcw8NoygaUMnIfDPjq",
    "sample_type" : {
      "team_glossary_id" : "tgy_oBFZfmnP09yuByrpBDrao",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "unit" : "5",
      "value" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1L3MbFn2TlJHvfyPEdLyMK",
      "project_id" : "pjt_4NhraGuq0SPUAymxDoEDwv",
      "name" : "bZ9lgaJOn2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hYDlaY0CmwilDne5dnFgJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "7Tkp8n8Tjm",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5ug60oneAVPcPxWeYZALZQ",
        "name" : "wQFlLbog1w",
        "email" : "QxqBe7rB@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_412gR0q8XuQU1rMxaM29l8",
        "name" : "drLGikuwzJ",
        "email" : "WGiEJqKv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.592148Z",
      "updated_at" : "2026-05-08T16:05:13.592148Z"
    },
    "created_at" : "2026-05-08T16:05:13.739449Z",
    "updated_at" : "2026-05-08T16:05:13.739449Z"
  }
}

study.sample_definition.deleted

Triggered when a sample plan definition is deleted.

{
  "id" : "whe_3cz4ZJTMK7anNAXNUmMYIS",
  "client_id" : "e953307f-4a09-4df0-806f-d70b3655f9cf",
  "event" : "study.sample_definition.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:13.789234Z",
  "payload" : {
    "id" : "sdf_3hDFqcw8NoygaUMnIfDPjq",
    "sample_type" : {
      "team_glossary_id" : "tgy_oBFZfmnP09yuByrpBDrao",
      "title" : "Blood Sample"
    },
    "name" : "Whole Blood - Baseline",
    "timepoints" : [ "PT0S", "PT30M" ],
    "details" : [ {
      "key" : "volume",
      "unit" : "5",
      "value" : "ml"
    } ],
    "metadata" : {
      "storage-condition" : "-20°C Freezer"
    },
    "study" : {
      "id" : "sdy_1L3MbFn2TlJHvfyPEdLyMK",
      "project_id" : "pjt_4NhraGuq0SPUAymxDoEDwv",
      "name" : "bZ9lgaJOn2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1hYDlaY0CmwilDne5dnFgJ",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "7Tkp8n8Tjm",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_5ug60oneAVPcPxWeYZALZQ",
        "name" : "wQFlLbog1w",
        "email" : "QxqBe7rB@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_412gR0q8XuQU1rMxaM29l8",
        "name" : "drLGikuwzJ",
        "email" : "WGiEJqKv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:13.592148Z",
      "updated_at" : "2026-05-08T16:05:13.592148Z"
    },
    "created_at" : "2026-05-08T16:05:13.739449Z",
    "updated_at" : "2026-05-08T16:05:13.739449Z"
  }
}

Study Task Spec [BETA]

study.task_spec.created

Triggered when a study task spec is created.

{
  "id" : "whe_7X4joD6saOV88USQKdnnS8",
  "client_id" : "0d206f97-5e12-445a-a26a-99d24739a888",
  "event" : "study.task_spec.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.167280Z",
  "payload" : {
    "id" : "tsp_4HqB9Rof4XhUuR6uVcoibP",
    "title" : "q4DTDmrLFV Task",
    "description" : "A87fDt4CzX Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-05-08",
          "end" : "2026-05-09"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6BKhZUP7gdLDOtyLd7iwcZ",
      "project_id" : "pjt_56SUTJswHlOxHGZCAVoKRI",
      "name" : "yK2rfVhoD2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1be9iH6HFU6tzmv6gx5wYd",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "qbZ55YVs64",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_19Op6oYDkAZjxQTomUXqfi",
        "name" : "qBMS4UzkDV",
        "email" : "1dwCqxU6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60w1JWO63WNjRUEinz8Ltc",
        "name" : "AnyJW1CRSS",
        "email" : "vwM7C7Wv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.913941Z",
      "updated_at" : "2026-05-08T16:05:14.913941Z"
    },
    "created_at" : "2026-05-08T16:05:15.140463Z",
    "updated_at" : "2026-05-08T16:05:15.140463Z"
  }
}

study.task_spec.updated

Triggered when a study task spec is updated.

{
  "id" : "whe_6EtM1Mb2ZpqkokgZIxinJC",
  "client_id" : "60696d6b-d889-42fc-b78a-eec6a630f9a2",
  "event" : "study.task_spec.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.168347Z",
  "payload" : {
    "id" : "tsp_4HqB9Rof4XhUuR6uVcoibP",
    "title" : "q4DTDmrLFV Task",
    "description" : "A87fDt4CzX Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-05-08",
          "end" : "2026-05-09"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6BKhZUP7gdLDOtyLd7iwcZ",
      "project_id" : "pjt_56SUTJswHlOxHGZCAVoKRI",
      "name" : "yK2rfVhoD2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1be9iH6HFU6tzmv6gx5wYd",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "qbZ55YVs64",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_19Op6oYDkAZjxQTomUXqfi",
        "name" : "qBMS4UzkDV",
        "email" : "1dwCqxU6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60w1JWO63WNjRUEinz8Ltc",
        "name" : "AnyJW1CRSS",
        "email" : "vwM7C7Wv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.913941Z",
      "updated_at" : "2026-05-08T16:05:14.913941Z"
    },
    "created_at" : "2026-05-08T16:05:15.140463Z",
    "updated_at" : "2026-05-08T16:05:15.140463Z"
  }
}

study.task_spec.deleted

Triggered when a study task spec is deleted.

{
  "id" : "whe_7SM4TrZkDgALZ0ZR7WiHO3",
  "client_id" : "7370a9a6-a4f8-4b80-a801-d52e1eecde92",
  "event" : "study.task_spec.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.178015Z",
  "payload" : {
    "id" : "tsp_4HqB9Rof4XhUuR6uVcoibP",
    "title" : "q4DTDmrLFV Task",
    "description" : "A87fDt4CzX Description",
    "type" : "other",
    "execution" : null,
    "schedule" : {
      "time" : {
        "type" : "all_day"
      },
      "timezone" : "America/Los_Angeles",
      "type" : "one_off",
      "one_off" : {
        "duration" : {
          "start" : "2026-05-08",
          "end" : "2026-05-09"
        }
      }
    },
    "target" : {
      "type" : "animal"
    },
    "study" : {
      "id" : "sdy_6BKhZUP7gdLDOtyLd7iwcZ",
      "project_id" : "pjt_56SUTJswHlOxHGZCAVoKRI",
      "name" : "yK2rfVhoD2",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_1be9iH6HFU6tzmv6gx5wYd",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "qbZ55YVs64",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_19Op6oYDkAZjxQTomUXqfi",
        "name" : "qBMS4UzkDV",
        "email" : "1dwCqxU6@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_60w1JWO63WNjRUEinz8Ltc",
        "name" : "AnyJW1CRSS",
        "email" : "vwM7C7Wv@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:14.913941Z",
      "updated_at" : "2026-05-08T16:05:14.913941Z"
    },
    "created_at" : "2026-05-08T16:05:15.140463Z",
    "updated_at" : "2026-05-08T16:05:15.140463Z"
  }
}

Study Treatment

study.treatment.created

Triggered when a treatment is created.

{
  "id" : "whe_7QVjnBdw1uUayb3n7fe4Df",
  "client_id" : "7662a6e8-9d63-472e-98c5-2069a98e27c6",
  "event" : "study.treatment.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.453957Z",
  "payload" : {
    "id" : "tmt_394tlTWGjc2doqAH3VieV5",
    "type" : "concentration_vgkg",
    "name" : "FaQTJcwbFi",
    "label" : "Test Treatment Label",
    "external_entity_id" : "iiwTuW0XrE",
    "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_9c03qDH72SD4Wex3LKo2r",
      "project_id" : "pjt_5SAOYVdeqZQe0ZB8JLCNHd",
      "name" : "w3hPMoykLz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5P3laJxBihfU7X2Dr9eroo",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "pReGnmQ3AR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_3tBL0Fspgteu7BQhuN08JL",
        "name" : "bPBdd0vWu4",
        "email" : "vlPl9ujE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2fZHmHXiJ1cLUNst32KQCd",
        "name" : "0W1QJC7OX7",
        "email" : "oAxUNkJJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.117752Z",
      "updated_at" : "2026-05-08T16:05:16.117752Z"
    },
    "created_at" : "2026-05-08T16:05:16.396842Z",
    "updated_at" : "2026-05-08T16:05:16.396842Z"
  }
}

study.treatment.updated

Triggered when a treatment is updated.

{
  "id" : "whe_3cEIenduVeP6sABA4dnhqJ",
  "client_id" : "eb633ace-411b-4045-b78c-0c32dc572301",
  "event" : "study.treatment.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.455167Z",
  "payload" : {
    "id" : "tmt_394tlTWGjc2doqAH3VieV5",
    "type" : "concentration_vgkg",
    "name" : "FaQTJcwbFi",
    "label" : "Test Treatment Label",
    "external_entity_id" : "iiwTuW0XrE",
    "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_9c03qDH72SD4Wex3LKo2r",
      "project_id" : "pjt_5SAOYVdeqZQe0ZB8JLCNHd",
      "name" : "w3hPMoykLz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5P3laJxBihfU7X2Dr9eroo",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "pReGnmQ3AR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_3tBL0Fspgteu7BQhuN08JL",
        "name" : "bPBdd0vWu4",
        "email" : "vlPl9ujE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2fZHmHXiJ1cLUNst32KQCd",
        "name" : "0W1QJC7OX7",
        "email" : "oAxUNkJJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.117752Z",
      "updated_at" : "2026-05-08T16:05:16.117752Z"
    },
    "created_at" : "2026-05-08T16:05:16.396842Z",
    "updated_at" : "2026-05-08T16:05:16.396842Z"
  }
}

study.treatment.deleted

Triggered when a treatment is deleted.

{
  "id" : "whe_42wTTV7vxtLaE8TPsID9dD",
  "client_id" : "bc11f785-c2a8-47c5-86d9-0cd5ac64d39c",
  "event" : "study.treatment.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.456398Z",
  "payload" : {
    "id" : "tmt_394tlTWGjc2doqAH3VieV5",
    "type" : "concentration_vgkg",
    "name" : "FaQTJcwbFi",
    "label" : "Test Treatment Label",
    "external_entity_id" : "iiwTuW0XrE",
    "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_9c03qDH72SD4Wex3LKo2r",
      "project_id" : "pjt_5SAOYVdeqZQe0ZB8JLCNHd",
      "name" : "w3hPMoykLz",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_5P3laJxBihfU7X2Dr9eroo",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "pReGnmQ3AR",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_3tBL0Fspgteu7BQhuN08JL",
        "name" : "bPBdd0vWu4",
        "email" : "vlPl9ujE@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_2fZHmHXiJ1cLUNst32KQCd",
        "name" : "0W1QJC7OX7",
        "email" : "oAxUNkJJ@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.117752Z",
      "updated_at" : "2026-05-08T16:05:16.117752Z"
    },
    "created_at" : "2026-05-08T16:05:16.396842Z",
    "updated_at" : "2026-05-08T16:05:16.396842Z"
  }
}

study.treatment.assigned

Triggered when a treatment is assigned to a study group.

{
  "id" : "whe_2kBIxuG6UycwHzNr9xC2sb",
  "client_id" : "50125671-779c-465d-afac-4806e844599f",
  "event" : "study.treatment.assigned",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.810779Z",
  "payload" : {
    "treatment" : {
      "id" : "tmt_54XkVHMdm5ZKJ5UPm3thgZ",
      "type" : "volume",
      "name" : "1ILMdi64S9",
      "label" : "Test Treatment Label",
      "external_entity_id" : "B1u45MYcDd",
      "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_60KvrPkMpfNt9vGqjJyUvG",
        "project_id" : "pjt_7Jff4lOQROPp3sdOtiFiME",
        "name" : "z25MXA150n",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_6dZ4uPncOLH3O9UVN6d53B",
        "type" : "internal",
        "started_on" : "2026-05-08",
        "status" : "in_progress",
        "description" : "A5kM5PTMMC",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "author" : {
          "id" : "usr_5X4YkBtD8AwBXjZmPmyjBO",
          "name" : "Sy8FtkVsse",
          "email" : "T8ncFGGQ@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_2dWBuBgOTmyDMxUA4tHbJ2",
          "name" : "ZXQkuE7nBh",
          "email" : "Kq1l2RDz@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-05-08T16:05:15.631040Z",
        "updated_at" : "2026-05-08T16:05:15.631040Z"
      },
      "created_at" : "2026-05-08T16:05:15.794519Z",
      "updated_at" : "2026-05-08T16:05:15.794519Z"
    },
    "study_group" : {
      "id" : "grp_3ILSKrF1W4XeCEiZlJNKCP",
      "name" : "JhYkxloEGA",
      "no" : 1214630964,
      "color" : "#b187a3",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_60KvrPkMpfNt9vGqjJyUvG",
        "project_id" : "pjt_7Jff4lOQROPp3sdOtiFiME",
        "name" : "z25MXA150n",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_6dZ4uPncOLH3O9UVN6d53B",
        "type" : "internal",
        "started_on" : "2026-05-08",
        "status" : "in_progress",
        "description" : "A5kM5PTMMC",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "author" : {
          "id" : "usr_5X4YkBtD8AwBXjZmPmyjBO",
          "name" : "Sy8FtkVsse",
          "email" : "T8ncFGGQ@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_2dWBuBgOTmyDMxUA4tHbJ2",
          "name" : "ZXQkuE7nBh",
          "email" : "Kq1l2RDz@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-05-08T16:05:15.631040Z",
        "updated_at" : "2026-05-08T16:05:15.631040Z"
      },
      "created_at" : "2026-05-08T16:05:15.786174Z",
      "updated_at" : "2026-05-08T16:05:15.786174Z"
    }
  }
}

study.treatment.unassigned

Triggered when a treatment is unassigned from a study group.

{
  "id" : "whe_5YBbQ7Lzild9pHOrfDWBTG",
  "client_id" : "a39851bd-a472-4a20-b3b1-75ccb1b2c7ae",
  "event" : "study.treatment.unassigned",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:15.812008Z",
  "payload" : {
    "treatment" : {
      "id" : "tmt_54XkVHMdm5ZKJ5UPm3thgZ",
      "type" : "volume",
      "name" : "1ILMdi64S9",
      "label" : "Test Treatment Label",
      "external_entity_id" : "B1u45MYcDd",
      "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_60KvrPkMpfNt9vGqjJyUvG",
        "project_id" : "pjt_7Jff4lOQROPp3sdOtiFiME",
        "name" : "z25MXA150n",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_6dZ4uPncOLH3O9UVN6d53B",
        "type" : "internal",
        "started_on" : "2026-05-08",
        "status" : "in_progress",
        "description" : "A5kM5PTMMC",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "author" : {
          "id" : "usr_5X4YkBtD8AwBXjZmPmyjBO",
          "name" : "Sy8FtkVsse",
          "email" : "T8ncFGGQ@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_2dWBuBgOTmyDMxUA4tHbJ2",
          "name" : "ZXQkuE7nBh",
          "email" : "Kq1l2RDz@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-05-08T16:05:15.631040Z",
        "updated_at" : "2026-05-08T16:05:15.631040Z"
      },
      "created_at" : "2026-05-08T16:05:15.794519Z",
      "updated_at" : "2026-05-08T16:05:15.794519Z"
    },
    "study_group" : {
      "id" : "grp_3ILSKrF1W4XeCEiZlJNKCP",
      "name" : "JhYkxloEGA",
      "no" : 1214630964,
      "color" : "#b187a3",
      "max_animals" : 10,
      "control" : false,
      "metadata" : {
        "study-group-external-id" : "GROUP-1234"
      },
      "study" : {
        "id" : "sdy_60KvrPkMpfNt9vGqjJyUvG",
        "project_id" : "pjt_7Jff4lOQROPp3sdOtiFiME",
        "name" : "z25MXA150n",
        "code" : "CD-26-445",
        "study_code_id" : "sdc_6dZ4uPncOLH3O9UVN6d53B",
        "type" : "internal",
        "started_on" : "2026-05-08",
        "status" : "in_progress",
        "description" : "A5kM5PTMMC",
        "timezone" : "America/Los_Angeles",
        "metadata" : {
          "study-internal-id" : "STUDY-1234"
        },
        "author" : {
          "id" : "usr_5X4YkBtD8AwBXjZmPmyjBO",
          "name" : "Sy8FtkVsse",
          "email" : "T8ncFGGQ@benchling.com",
          "timezone" : "UTC"
        },
        "owner" : {
          "id" : "usr_2dWBuBgOTmyDMxUA4tHbJ2",
          "name" : "ZXQkuE7nBh",
          "email" : "Kq1l2RDz@benchling.com",
          "timezone" : "UTC"
        },
        "completed_at" : null,
        "canceled_at" : null,
        "created_at" : "2026-05-08T16:05:15.631040Z",
        "updated_at" : "2026-05-08T16:05:15.631040Z"
      },
      "created_at" : "2026-05-08T16:05:15.786174Z",
      "updated_at" : "2026-05-08T16:05:15.786174Z"
    }
  }
}

Study User

study.user.created

Triggered when a study user is created.

{
  "id" : "whe_4YvzqSaYN6oYL5Bdha19K8",
  "client_id" : "5e30f710-e85a-403e-9b7c-eef2372965da",
  "event" : "study.user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.157103Z",
  "payload" : {
    "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
    "name" : "iKffBMJhoC",
    "email" : "a8aRtik3@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_4zzg0xBwussQJGeNCn1Egb",
      "project_id" : "pjt_67TzrBuGrc7L7k1d4dSCOA",
      "name" : "089bRRNAMg",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_30k4MnkTwVcqq5KpDZgOzy",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "KG4cD7Z7To",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
        "name" : "iKffBMJhoC",
        "email" : "a8aRtik3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6BWMraVEqZOLhUwKJlAZSN",
        "name" : "KFKPtXzFHK",
        "email" : "Wlq9ZqD9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.866900Z",
      "updated_at" : "2026-05-08T16:05:16.866900Z"
    }
  }
}

study.user.updated

Triggered when a study user is updated.

{
  "id" : "whe_AQy9isggWgZQHG10Cnp1O",
  "client_id" : "16bcb2fa-6324-41b7-b765-18d00f2d419d",
  "event" : "study.user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.158112Z",
  "payload" : {
    "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
    "name" : "iKffBMJhoC",
    "email" : "a8aRtik3@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_4zzg0xBwussQJGeNCn1Egb",
      "project_id" : "pjt_67TzrBuGrc7L7k1d4dSCOA",
      "name" : "089bRRNAMg",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_30k4MnkTwVcqq5KpDZgOzy",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "KG4cD7Z7To",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
        "name" : "iKffBMJhoC",
        "email" : "a8aRtik3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6BWMraVEqZOLhUwKJlAZSN",
        "name" : "KFKPtXzFHK",
        "email" : "Wlq9ZqD9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.866900Z",
      "updated_at" : "2026-05-08T16:05:16.866900Z"
    }
  }
}

study.user.deleted

Triggered when a study user is deleted.

{
  "id" : "whe_7jzTxLGoTXg9FXcbKyfHbP",
  "client_id" : "a1cab1b3-9154-4e29-9fc5-bdb809a60424",
  "event" : "study.user.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.158737Z",
  "payload" : {
    "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
    "name" : "iKffBMJhoC",
    "email" : "a8aRtik3@benchling.com",
    "timezone" : "UTC",
    "type" : "author",
    "access" : "write",
    "study" : {
      "id" : "sdy_4zzg0xBwussQJGeNCn1Egb",
      "project_id" : "pjt_67TzrBuGrc7L7k1d4dSCOA",
      "name" : "089bRRNAMg",
      "code" : "CD-26-445",
      "study_code_id" : "sdc_30k4MnkTwVcqq5KpDZgOzy",
      "type" : "internal",
      "started_on" : "2026-05-08",
      "status" : "in_progress",
      "description" : "KG4cD7Z7To",
      "timezone" : "America/Los_Angeles",
      "metadata" : {
        "study-internal-id" : "STUDY-1234"
      },
      "author" : {
        "id" : "usr_7dILGsAZIngHaDHWYCmfEn",
        "name" : "iKffBMJhoC",
        "email" : "a8aRtik3@benchling.com",
        "timezone" : "UTC"
      },
      "owner" : {
        "id" : "usr_6BWMraVEqZOLhUwKJlAZSN",
        "name" : "KFKPtXzFHK",
        "email" : "Wlq9ZqD9@benchling.com",
        "timezone" : "UTC"
      },
      "completed_at" : null,
      "canceled_at" : null,
      "created_at" : "2026-05-08T16:05:16.866900Z",
      "updated_at" : "2026-05-08T16:05:16.866900Z"
    }
  }
}

Team Glossary Observation [BETA]

team.glossary_observation.created

Triggered when a team glossary observation is created.

{
  "id" : "whe_27CEDM4AV3Z4xtpP1tkHjI",
  "client_id" : "8c581039-a5c9-4f40-aff5-eb6bb24e8376",
  "event" : "team.glossary_observation.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.479142Z",
  "payload" : {
    "id" : "tgy_6gyAoWkU3toSuA9vDCKGDL",
    "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_12prLztn4U9l3sBLjsghIT",
  "client_id" : "87b8e504-cf2f-4a86-ae7f-0e67bac85079",
  "event" : "team.glossary_observation.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.482192Z",
  "payload" : {
    "id" : "tgy_6gyAoWkU3toSuA9vDCKGDL",
    "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_2eNELhjY1SodKS3pIz7B0H",
  "client_id" : "52c8c682-dd39-414b-bc47-cd3e17a22048",
  "event" : "team.glossary_observation.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:16.483860Z",
  "payload" : {
    "id" : "tgy_6gyAoWkU3toSuA9vDCKGDL",
    "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_1eCXUACwWKnIQI4Z9vF2BC",
  "client_id" : "c0f2cffb-5e98-4d85-897c-b51845dcc791",
  "event" : "team.glossary_sample.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.214374Z",
  "payload" : {
    "id" : "tgy_1s15zltkJz52wWmY6yYvXv",
    "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_1V1UchFw4t5zTFpWhsIKK6",
  "client_id" : "f2c5e325-db5f-49b1-9cc8-e364b0d51578",
  "event" : "team.glossary_sample.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.215328Z",
  "payload" : {
    "id" : "tgy_1s15zltkJz52wWmY6yYvXv",
    "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_5VUgyv99H8WjFkwu6g6r8G",
  "client_id" : "85eee689-e1b8-46f5-b4d0-c210ddf07ff9",
  "event" : "team.glossary_sample.deleted",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:14.215936Z",
  "payload" : {
    "id" : "tgy_1s15zltkJz52wWmY6yYvXv",
    "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_4N9olP4Nr13JVIcyOETPCC",
  "client_id" : "b536c0bb-0b2b-4d19-89fd-72b84e5efe26",
  "event" : "user.created",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.249651Z",
  "payload" : {
    "id" : "usr_2ZTVEQQvEnpmeSr1gVph6a",
    "name" : "kmpOF Overwatch",
    "email" : "t7z2eTN8@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:05:17.225052Z",
    "updated_at" : "2026-05-08T16:05:17.225052Z"
  }
}

user.updated

Triggered when a user is updated on a team.

{
  "id" : "whe_6jwg7x6vKqJ7sKE6EOa5aD",
  "client_id" : "f6911a40-9256-46f7-a6b1-36de74011f85",
  "event" : "user.updated",
  "version" : "2022-12-14",
  "created_at" : "2026-05-08T16:05:17.250965Z",
  "payload" : {
    "id" : "usr_2ZTVEQQvEnpmeSr1gVph6a",
    "name" : "kmpOF Overwatch",
    "email" : "t7z2eTN8@benchling.com",
    "timezone" : "UTC",
    "status" : "active",
    "metadata" : {
      "user-internal-id" : "USER-1234"
    },
    "created_at" : "2026-05-08T16:05:17.225052Z",
    "updated_at" : "2026-05-08T16:05:17.225052Z"
  }
}

API Reference v2022-12-14