How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchling Project API

A top-level organizational container in Benchling that groups related work and controlsaccess permissions. Projects contain Folders (see `Folder`) which in turn hold entities,notebook entries, and other items. Each project has an owner (see `Owner`—typically aUser or Organization) and access is managed through collaborations (see `Collaboration`).Projects serve as the primary unit for sharing and permission management: users who arenot collaborators on a project cannot access its contents. The isDataModsEnabled flagcontrols whether data modification tracking is active for items in this project.

Benchling Project API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.

This API exposes 10 operations across 9 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, /api/v3.

10 operations 9 paths 34 schemas 4 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://{tenant}.benchling.com/api/v2
Authentication
HTTP Basic, HTTP Basic, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

Benchling Project API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicApiKeyAuth). It accepts HTTP basic authentication (basicClientIdSecretAuth). It supports OAuth 2.0 (oAuth) using the clientCredentials flow. By default, every request must be authenticated.

  • basicApiKeyAuth — Use issued API key for standard access to the API
  • basicClientIdSecretAuth — Auth used as part of client credentials OAuth flow prior to receiving a bearer token.
  • oAuth — OAuth2 Client Credentials flow intended for service access

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 4 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Project 10

A top-level organizational container in Benchling that groups related work and controls access permissions. Projects contain Folders (see Folder) which in turn hold entities, note…

POST
/project
Create Project
Project.Create 1 param body → 201400403404429500
GET
/project/items
List Project items
Project.List 16 params → 200400403404429500
GET
/project/{project_id}
Get Project by ID
Project.Get 4 params → 200400403404429500
PATCH
/project/{project_id}
Update Project
Project.Update 2 params body → 200400403404429500
GET
/project/{project_id}/collaborations/items
List Collaboration items
Project.collaborations.List 2 params → 200400403404429500
GET
/project/{project_id}/review-processes/items
List ReviewProcess items
Project.reviewProcesses.List 2 params → 200400403404429500
POST
/project:batch-create
Batch create Project
Project.BatchCreate 1 param body → 201400403404429500
PATCH
/project:batch-update
Batch update Project
Project.BatchUpdate 1 param body → 200400403404429500
POST
/project:bulk-create
Bulk create Project
Project.BulkCreate 1 param body → 202400403404429500
PATCH
/project:bulk-update
Bulk update Project
Project.BulkUpdate 1 param body → 202400403404429500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are Project (15 properties), Collaboration (9 properties), Team (9 properties), UpdateProjectInputWithPathParams (9 properties). Each schema is shown below with its type and property counts.

GroupCollaboratorInfo
object
Represents a Group that is the subject of a Collaboration, along with sub-group information. In Group Collaborations, the Resource may be shared with a sub-gro…
3 properties
ProjectUpdatedWebhookV3
Message body of a v3.project.updated event.
ReviewProcessStageRef
object
2 properties
WebhookApp
object
The Benchling App the webhook was delivered to.
1 property 1 required
PolicyRef
object
2 properties
V3UpdateEventBase
Fields common to every v3 update event message.
OwnerRef
object
2 properties
ReviewProcessUnpaginatedList
object
1 property
UpdateProjectInput
object
8 properties
CollaborationUnpaginatedList
object
1 property
Project
object
A top-level organizational container in Benchling that groups related work and controls access permissions. Projects contain Folders (see Folder) which in turn…
15 properties
InternalServerError
object
6 properties 5 required
AsyncTaskLink
object
2 properties
WebhookAppDefinition
object
The app definition the receiving app was installed from.
2 properties 2 required
Group
object
ProjectCreatedWebhookV3
Message body of a v3.project.created event.
BulkImport
object
1 property 1 required
Team
object
Represents a subgroup of users within an Organization, enabling finer-grained user management and data sharing. Teams belong to exactly one organization, and u…
9 properties
PrincipalRef
object
2 properties
PrincipalCollaboratorInfo
object
Represents a Principal that is the subject for a Collaboration.
2 properties
ReviewProcess
object
Defines a review process configuration that specifies how entries and other reviewable items should be reviewed. A ReviewProcess belongs to an Organization and…
8 properties
ProjectUpdatedWebhookEnvelopeV3
Request body Benchling sends for a v3.project.updated event.
ReviewProcessVersion
object
A specific version of a ReviewProcess configuration. Review processes are versioned to allow changes to review requirements while preserving the rules that app…
4 properties
OrganizationRef
object
2 properties
Organization
object
Represents a group of users within Benchling, typically corresponding to a company, department, or research group. Organizations provide a many-to-many relatio…
7 properties
V3EventBase
object
Fields common to every v3 event message.
6 properties 6 required
UpdateProjectInputWithPathParams
object
9 properties 1 required
Collaboration
object
A Collaboration indicates that a Principal or Group is granted a Policy on a Resource. Some Collaborations represent Ownership, while others indicate that a Re…
9 properties
ProjectCreatedWebhookEnvelopeV3
Request body Benchling sends for a v3.project.created event.
CreateProjectInput
object
5 properties 2 required
WebhookEnvelopeBaseV0
object
Fields common to every webhook request body. The event itself is carried in the message property of the event-specific payload.
5 properties 5 required
GeneralError
object
5 properties 5 required
ProjectPaginatedList
object
2 properties
CollaboratableRef
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-project-api-openapi.yml Raw ↑

Other APIs Benchling publishes across the network.

Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
Where this information came from

This is an independent, third-party profile of Benchling Project API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.