---
title: "GET analyses instances"
method: GET
path: "/api/v1/analyses"
---

# GET analyses instances

`GET /api/v1/analyses`

## Query parameters

- `page` integer
- `per_page` integer
- `sort` string, nullable
- `where` string, nullable

## Response `200`

OK

- Analyses[]
  - `$uri` string, required
  - `analysis_type` 'classification' | 'panel' | 'alignment' | 'control' | 'report' | 'functional' | 'workflow' | 'mlst' | 'assembly_run', required
  - `complete` boolean
  - `created_at` string, date-time, required — Timestamp for when the object was created on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.
  - `error_msg` string, nullable — The error message from the analysis, if it failed.
  - `job` object, required — A reference to the versioned job underlying the analysis, e.g., `{"$ref": "/api/v1/jobs/d512cb556241440f"}`.
    - `__DOLLAR_REF__` string, uri
  - `job_args` object — The arguments passed into this analysis (can be `null`).
  - `sample` object, required — A reference to the sample underlying the analysis, e.g., `{"$ref": "/api/v1/sample/0ee172af60e84f61"}`.
    - `__DOLLAR_REF__` string, uri
  - `success` boolean
  - `updated_at` string, date-time, nullable — Timestamp for when the object was last updated on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.

---

[API](https://skmtc.net/onecodex/apis/one-codex-api-v1.md) · [All operations](https://skmtc.net/onecodex/apis/one-codex-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onecodex/one-codex-api-v1/versions/fe9d9bfc8a6a/schema)