List all animals

GET

https://acme-api.invivo.benchling.com/api/public/v1/animals

GET

/api/public/v1/animals

curl -G https://acme-api.invivo.benchling.com/api/public/v1/animals \
     -H "Authorization: Bearer <token>" \
     -d cage_id=cge_5mR8kWpQnL3xTv7YzBcDfH \
     -d sex=m

{
  "data": [
    {
      "id": "aml_71H39zdfOc89pNIutQSI22",
      "name": "Animal 1",
      "number": 1,
      "catalog": "A0000001",
      "species": "Mus musculus",
      "strain": "C57BL/6J",
      "sex": "m",
      "dob": "2026-09-09",
      "donor": null,
      "ear": "2R",
      "tag": "T-0041",
      "tail": "1",
      "study": {
        "id": "sdy_6y9Wop1uArRjD93UiQ5qFy",
        "project_id": "pjt_7IrvD7jMtAGvBl4AQUUr3g",
        "name": "Benchling In Vivo",
        "code": "CD-26-445",
        "study_code_id": "sdc_n6vkWmmHoACZ15pTxztHk",
        "type": "internal",
        "status": "in_progress",
        "description": "Efficacy study in a xenograft model.",
        "timezone": "America/Los_Angeles",
        "metadata": {
          "study-internal-id": "STUDY-1234"
        },
        "author": {
          "id": "usr_72aeLmlraBB7Ekzu2zTsMW",
          "name": "Jo Harper",
          "email": "jo.harper@example.com",
          "timezone": "UTC"
        },
        "owner": {
          "id": "usr_5TSgutt2ZHPnKOdYbaNlRo",
          "name": "Sam Ellis",
          "email": "sam.ellis@example.com",
          "timezone": "UTC"
        },
        "started_on": "2026-09-10",
        "tracking_day_base": 0,
        "completed_at": null,
        "canceled_at": null,
        "created_at": "2026-09-10T07:27:34.132511Z",
        "updated_at": "2026-09-10T07:27:34.132511Z"
      },
      "study_group": {
        "id": "grp_1OEdawZKhmLCf88R4AnCZm",
        "study_id": "sdy_6y9Wop1uArRjD93UiQ5qFy",
        "name": "Vehicle",
        "no": 1,
        "color": "#e9429d",
        "max_animals": 10,
        "control": true,
        "metadata": {
          "study-group-internal-id": "GROUP-1234"
        },
        "created_at": "2026-09-10T07:27:10.770562Z",
        "updated_at": "2026-09-10T07:27:10.770562Z"
      },
      "cage": {
        "id": "cge_6uFo3TUYezxtFuImb9kk8K",
        "study_id": "sdy_6y9Wop1uArRjD93UiQ5qFy",
        "name": "Cage 1",
        "catalog": "C0000001",
        "metadata": {
          "cage-internal-id": "CAGE-1234"
        },
        "created_at": "2026-09-10T07:27:10.734591Z",
        "updated_at": "2026-09-10T07:27:10.734591Z"
      },
      "tracking_date": "2026-09-10",
      "disease_induction_date": "2026-09-10",
      "disease_survivor": false,
      "terminated_at": null,
      "terminated_by": null,
      "terminated_reason": null,
      "metadata": {
        "animal-internal-id": "ANIMAL-1234"
      },
      "created_at": "2026-09-10T07:27:10.785238Z",
      "updated_at": "2026-09-10T07:27:10.785238Z"
    }
  ],
  "links": {
    "first": "https://acme-api.invivo.benchling.com/api/public/v1/animals?page=1",
    "last": "https://acme-api.invivo.benchling.com/api/public/v1/animals?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://acme-api.invivo.benchling.com/api/public/v1/animals",
    "per_page": 10,
    "to": 1,
    "total": 1
  }
}

Returns a list of the animals in your colony, whether or not they are on a study. To list only the animals on one study, use the study's own animals endpoint instead.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

perPageintegerOptional1-100Defaults to 10

The number of results to return per page, up to a maximum of 100.

pageintegerOptional>=1Defaults to 1

The page of results to return. The first page is 1.

namestringOptional

Filter resources to return by name, matching case-insensitively on any part of the name.

cage_idstringOptionalformat: "^cge_[a-zA-Z0-9]{10,22}$"

Filter animals to return to those housed in a single cage.

catalogstringOptional

Filter resources to return by catalog number, matching case-insensitively on any part of the number.

sexenumOptional

Filter animals to return by sex. A value outside the enumeration is rejected with 400 rather than treated as a metadata slug filter.

Allowed values:

metadatastringOptional

Filter results by metadata value, matching against any metadata key. To filter on a specific key instead, pass the metadata slug itself as a query parameter, e.g. ?study-internal-id=STUDY-1234. Those slug parameters vary by team glossary and so cannot be enumerated here.

Response headers

X-RateLimit-LimitintegerOptional

The number of requests permitted in the current rate limit window.

X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional

The number of seconds until the current rate limit window resets.

Response

A page of animals.

datalist of objects

The animals on this page of results.

linksobject

Absolute URLs for navigating a paginated collection.

metaobject

Pagination counters describing the returned page of results.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

Authentication

Headers

Query parameters

Response headers

Response

Errors