--- title: "Get Run by ID" method: GET path: "/api/v3/run/{run_id}" tags: ["Run"] --- # Get Run by ID `GET /api/v3/run/{run_id}` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/run/{run_id}` - Auth: HTTP bearer Get a single Run by ID. ## Path parameters - `run_id` string, required ## Query parameters - `returning` string[] - `omit` string[] ## Headers - `EARLY-ACCESS` string ## Response `200` OK - Run: A Run represents an execution instance of a lab automation workflow in Benchling, capturing the inputs, outputs, and metadata for a single assay or instrument operation. Runs conform to a RunSchema that defines their structure including input generators (see AutomationInputGenerator) for creating worklists and output processors (see AutomationOutputProcessor) for parsing instrument results. Runs are typically embedded in notebook entries (via the entry field) and can generate associated Analyses for data processing. Each run tracks validation status (VALID or INVALID) with optional comments, enabling quality control workflows. Runs belong to a Project for access control and can be archived when superseded or invalidated. Also known as "assay runs" in the lab automation context. - `__typename` string - `archiveReason` string, nullable: If the Run is archived, reason for archiving - `archived` boolean: Whether the Run is archived - `createdAt` string, datetime, nullable: DateTime at which the run was created - `id` string - `isReviewed` boolean, nullable: Whether this run is in a reviewed entry - `modifiedAt` string, datetime, nullable: DateTime at which the run was last modified - `project` ProjectRef - `__typename` string - `id` string, api_id - `schema` RunSchemaRef - `__typename` string - `id` string, api_id - `validationComment` string, nullable: Comment for this run's validation status - `validationStatus` 'VALID' | 'INVALID': Validation status of this run - must be either VALID or INVALID - `creator` PrincipalRef - `__typename` string - `id` string, api_id - `entry` DocumentLikeRef - `__typename` string - `id` string, api_id - `schemaFields` SchemaFieldValue[], nullable: Schema field values that belong to the run - `__typename` string - `fieldDefinition` SchemaFieldDefinitionRef - `__typename` string - `id` string, api_id - `id` string - `linkedEntityId` string, nullable - `value` union: Types of values that Benchling can interpret. - object: A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns). - `__typename` 'ArrayValue', required: Discriminator value: ArrayValue - `value` SingularBenchlingValue[] - union: A union of value types that can appear as elements within an ArrayValue. Identical to BenchlingValue but excludes ArrayValue to prevent nesting. Keep in sync with BenchlingValue. - object: A type that represents boolean values. - … - object: A type that represents datetime values. - … - object: A type that represents date values. - … - object: A type that represents decimal value as strings. - … - object: A type that represents integer values. - … - object: A type that represents JSON values. - … - object: A type that represents a list of links to other objects. - … - object: A type that represents links to other objects. - … - object: A type that represents text (string) values with an associated URL. - … - object: A type that represents text (string) values. - … - object: A type that represents boolean values. - `__typename` 'BooleanValue', required: Discriminator value: BooleanValue - `value` boolean: The boolean value. - object: A type that represents datetime values. - `__typename` 'DateTimeValue', required: Discriminator value: DateTimeValue - `value` string, datetime: The datetime value with UTC as the timezone. - object: A type that represents date values. - `__typename` 'DateValue', required: Discriminator value: DateValue - `value` string, date: The date value. - object: A type that represents decimal value as strings. - `__typename` 'DecimalValue', required: Discriminator value: DecimalValue - `numericValue` number, double, nullable: Deprecated. The float representation of the decimal value. - `value` string, nullable: The decimal value in a string representation - object: A type that represents integer values. - `__typename` 'IntegerValue', required: Discriminator value: IntegerValue - `value` integer: The integer value. - object: A type that represents JSON values. - `__typename` 'JsonValue', required: Discriminator value: JsonValue - `value` union: The JSON value. - object - string[] - string - number, double - boolean - object: A type that represents a list of links to other objects. - `__typename` 'ObjectLinkListValue', required: Discriminator value: ObjectLinkListValue - `value` LinkableDomainObject[]: The list of objects that this value links to. Inaccessible objects may be returned instead if the object is not found with the current permission set. - union: A union representing items that can be linked to. If you have a type that can be linked to, it can only be added once it's in beta. - object: AaSequence variant - … - object: Attachment variant - … - object: Box variant - … - object: Container variant - … - object: CustomEntity variant - … - object: DnaOligo variant - … - object: DnaSequence variant - … - object: DropdownOption variant - … - object: Entry variant - … - object: Inaccessible variant - … - object: Location variant - … - object: MatrixPlate variant - … - object: Mixture variant - … - object: Molecule variant - … - object: OligoConjugate variant - … - object: OligoDuplex variant - … - object: Protein variant - … - object: Result variant - … - object: RnaOligo variant - … - object: RnaSequence variant - … - object: Run variant - … - object: WellPlate variant - … - object: A type that represents links to other objects. - `__typename` 'ObjectLinkValue', required: Discriminator value: ObjectLinkValue - `value` union: A union representing items that can be linked to. If you have a type that can be linked to, it can only be added once it's in beta. - object: AaSequence variant - `__typename` 'AaSequence', required: Discriminator value: AaSequence - `id` string, api_id - object: Attachment variant - `__typename` 'Attachment', required: Discriminator value: Attachment - `id` string, api_id - object: Box variant - `__typename` 'Box', required: Discriminator value: Box - `id` string, api_id - object: Container variant - `__typename` 'Container', required: Discriminator value: Container - `id` string, api_id - object: CustomEntity variant - `__typename` 'CustomEntity', required: Discriminator value: CustomEntity - `id` string, api_id - object: DnaOligo variant - `__typename` 'DnaOligo', required: Discriminator value: DnaOligo - `id` string, api_id - object: DnaSequence variant - `__typename` 'DnaSequence', required: Discriminator value: DnaSequence - `id` string, api_id - object: DropdownOption variant - `__typename` 'DropdownOption', required: Discriminator value: DropdownOption - `id` string, api_id - object: Entry variant - `__typename` 'Entry', required: Discriminator value: Entry - `id` string, api_id - object: Inaccessible variant - `__typename` 'Inaccessible', required: Discriminator value: Inaccessible - `id` string, api_id - object: Location variant - `__typename` 'Location', required: Discriminator value: Location - `id` string, api_id - object: MatrixPlate variant - `__typename` 'MatrixPlate', required: Discriminator value: MatrixPlate - `id` string, api_id - object: Mixture variant - `__typename` 'Mixture', required: Discriminator value: Mixture - `id` string, api_id - object: Molecule variant - `__typename` 'Molecule', required: Discriminator value: Molecule - `id` string, api_id - object: OligoConjugate variant - `__typename` 'OligoConjugate', required: Discriminator value: OligoConjugate - `id` string, api_id - object: OligoDuplex variant - `__typename` 'OligoDuplex', required: Discriminator value: OligoDuplex - `id` string, api_id - object: Protein variant - `__typename` 'Protein', required: Discriminator value: Protein - `id` string, api_id - object: Result variant - `__typename` 'Result', required: Discriminator value: Result - `id` string, api_id - object: RnaOligo variant - `__typename` 'RnaOligo', required: Discriminator value: RnaOligo - `id` string, api_id - object: RnaSequence variant - `__typename` 'RnaSequence', required: Discriminator value: RnaSequence - `id` string, api_id - object: Run variant - `__typename` 'Run', required: Discriminator value: Run - `id` string, api_id - object: WellPlate variant - `__typename` 'WellPlate', required: Discriminator value: WellPlate - `id` string, api_id - object: A type that represents text (string) values with an associated URL. - `__typename` string, required - `url` string: The URL associated with the value. Please use `TextValue` if you don't want a URL. - `value` string: The text value. It may or may not be an empty string. - object: A type that represents text (string) values. - `__typename` string, required - `value` string: The text value. It may or may not be an empty string. ## Other responses - `400`: Bad Request - `403`: Forbidden - `404`: Not Found - `429`: Too Many Requests - `500`: Internal Server Error --- [API](https://skmtc.dev/benchling/apis/benchling-api.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api/revisions/c9f087b98b8b?raw)