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 Collaboration API

A Collaboration indicates that a Principal or Group is granted a Policy on a Resource.Some Collaborations represent Ownership, while others indicate that a Resource was shared with the Principalor Group.

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

Tagged areas include Collaboration. 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 8 paths, and defines 20 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 8 paths 20 schemas 1 DELETE2 GET3 PATCH4 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 Collaboration 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 8 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 3 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Collaboration 10

A Collaboration indicates that a Principal or Group is granted a Policy on a Resource. Some Collaborations represent Ownership, while others indicate that a Resource was shared wi…

POST
/collaboration
Create Collaboration
Collaboration.Create 1 param body → 201400403404429500
GET
/collaboration/items
List Collaboration items
Collaboration.List 17 params → 200400403404429500
DELETE
/collaboration/{collaboration_id}
Delete Collaboration
Collaboration.Delete 2 params → 204400403404429500
GET
/collaboration/{collaboration_id}
Get Collaboration by ID
Collaboration.Get 4 params → 200400403404429500
PATCH
/collaboration/{collaboration_id}
Update Collaboration
Collaboration.Update 2 params body → 200400403404429500
POST
/collaboration:batch-create
Batch create Collaboration
Collaboration.BatchCreate 1 param body → 201400403404429500
POST
/collaboration:batch-delete
Batch delete Collaboration
Collaboration.BatchDelete 1 param body → 200400403404429500
PATCH
/collaboration:batch-update
Batch update Collaboration
Collaboration.BatchUpdate 1 param body → 200400403404429500
POST
/collaboration:bulk-create
Bulk create Collaboration
Collaboration.BulkCreate 1 param body → 202400403404429500
PATCH
/collaboration:bulk-update
Bulk update Collaboration
Collaboration.BulkUpdate 1 param body → 202400403404429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Collaboration (9 properties), Team (9 properties), Organization (7 properties), InternalServerError (6 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
CollaborationPaginatedList
object
2 properties
PolicyRef
object
2 properties
UpdateCollaborationInput
object
2 properties
DeleteCollaborationInputWithPathParams
object
1 property 1 required
InternalServerError
object
6 properties 5 required
AsyncTaskLink
object
2 properties
Group
object
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
CreateCollaborationInput
object
4 properties 3 required
CollaboratorReferenceInput
object
2 properties 1 required
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
UpdateCollaborationInputWithPathParams
object
3 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
GeneralError
object
5 properties 5 required
CollaboratableRef
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchling-collaboration-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 Collaboration 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.