--- title: "List Study items" method: GET path: "/api/v3/study/items" tags: ["Study"] --- # List Study items `GET /api/v3/study/items` ## Request - Base URL: `https://{tenant_name}.benchling.com` - URL: `https://{tenant_name}.benchling.com/api/v3/study/items` - Auth: HTTP bearer List Study items. ## Query parameters - `archiveReason.anyOf` string[] - `archived.anyOf` boolean[] - `createdAt.gt` string, datetime - `createdAt.gte` string, datetime - `createdAt.lt` string, datetime - `createdAt.lte` string, datetime - `id.anyOf` string[] - `modifiedAt.gt` string, datetime - `modifiedAt.gte` string, datetime - `modifiedAt.lt` string, datetime - `modifiedAt.lte` string, datetime - `name.anyOf` string[] - `name.anyOf.caseSensitive` string[] - `nextToken` string - `omit` string[] - `pageSize` integer - `phase.anyOf` string[] - `returning` string[] - `sort` 'createdAt:asc' | 'createdAt:desc' | 'modifiedAt:asc' | 'modifiedAt:desc' ## Response `200` OK - StudyPaginatedList - `items` Study[] - `__typename` string - `archiveDatetime` string, datetime, nullable: No longer supported. - `archiveReason` string, nullable - `archiveUser` PrincipalRef - `__typename` string - `id` string, api_id - `archived` boolean - `authors` string, uri, nullable: Users and apps designated as authors of the study. - `createdAt` string, datetime, nullable - `creator` PrincipalRef - `__typename` string - `id` string, api_id - `description` string, nullable - `designEntry` EntryRef - `__typename` string - `id` string, api_id - `displayId` string, nullable: Human-readable identifier for the study. For schemas with auto-generated IDs, assigned by the server at creation. For MANUAL schemas, may be set at creation or update. - `folder` FolderRef - `__typename` string - `id` string, api_id - `id` string - `modifiedAt` string, datetime, nullable - `name` string - `phase` 'DESIGN' | 'EXECUTION' | 'COMPLETE' - `schema` StudySchemaRef - `__typename` string - `id` string, api_id - `schemaFields` SchemaFieldValue[], nullable - `__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. - `__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: 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 - … - 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 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. - `studySchema` StudySchemaRef - `__typename` string - `id` string, api_id - `nextToken` string, nullable ## 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)