# Broad Institute Entities API

**Canonical:** https://apis.io/apis/broad-institute/broad-institute-entities-api/  
**Provider:** Broad Institute — https://apis.io/providers/broad-institute/  
**Base URL:** https://api.firecloud.org  
**Documentation:** https://app.terra.bio

Broad Institute Entities API is one of 23 APIs that [Broad Institute](https://apis.io/providers/broad-institute/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Entities API from Broad Institute — 20 operation(s) for entities.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities` | List of entity types in a workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities_with_type` | List of entities in a workspace with type and attribute information |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/copy` | Copy entities from one workspace to another |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/delete` | Bulk delete entities from a workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}` | List of entities in a workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/{entityName}` | Get entity in a workspace |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/{entityName}` | Update entity in a workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/{entityName}/evaluate` | Evaluate entity expression |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/{entityName}/rename` | rename entity in a workspace |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/tsv` | Download a TSV file containing workspace entities |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/tsv` | Save TSV file containing workspace entities to the workspace bucket |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/paired-tsv` | Download a TSV of files in the workspace's bucket, paired by naming convention |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entityQuery/{entityType}` | Paginated query for entities in a workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importEntities` | Import entities from a tsv file |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importPFB` | List PFB import jobs in this workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importPFB` | Import PFB data from an Avro file |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importPFB/{jobId}` | Use the importJob API instead |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importJob` | List asynchronous import jobs in this workspace |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importJob` | Import data from a PFB file or TDR snapshot |
| GET | `/api/workspaces/{workspaceNamespace}/{workspaceName}/importJob/{jobId}` | Report status on an asynchronous import job |
| POST | `/api/workspaces/{workspaceNamespace}/{workspaceName}/flexibleImportEntities` | Import entities from a tsv file |
| GET | `/cookie-authed/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/tsv` | TSV file containing workspace entities of the specified type |
| POST | `/cookie-authed/workspaces/{workspaceNamespace}/{workspaceName}/entities/{entityType}/tsv` | TSV file containing workspace entities of the specified type |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entityTypes/{entityType}` | rename entity type in a workspace |
| DELETE | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entityTypes/{entityType}` | delete all entities of a type in a workspace |
| PATCH | `/api/workspaces/{workspaceNamespace}/{workspaceName}/entityTypes/{entityType}/attributes/{attributeName}` | Change attribute name for an entity type |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/broad-institute/openapi/broad-institute-entities-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workflow-description-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-workspace-details-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-submission-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-tool-schema.json
- **JSONSchema** — https://artifacts.apis.io/broad-institute/json-schema/broad-institute-configuration-response-schema.json

## Other Broad Institute APIs (12)

- [Broad Institute Billing V2 API](https://apis.io/apis/broad-institute/broad-institute-billingv2-api/)
- [Broad Institute CromIAM Engine (for Job Manager) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-engine-for-job-manager-api/)
- [Broad Institute CromIAM Workflows (for Admin) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-workflows-for-admin-api/)
- [Broad Institute CromIAM Workflows (for Job Manager) API](https://apis.io/apis/broad-institute/broad-institute-cromiam-workflows-for-job-manager-api/)
- [Broad Institute GA4GH Tool Registry API](https://apis.io/apis/broad-institute/broad-institute-ga4gh-tool-registry-api/)
- [Broad Institute Groups API](https://apis.io/apis/broad-institute/broad-institute-groups-api/)
- [Broad Institute Method Configurations API](https://apis.io/apis/broad-institute/broad-institute-method-configurations-api/)
- [Broad Institute Method Repository API](https://apis.io/apis/broad-institute/broad-institute-method-repository-api/)
- [Broad Institute NIH API](https://apis.io/apis/broad-institute/broad-institute-nih-api/)
- [Broad Institute Notifications API](https://apis.io/apis/broad-institute/broad-institute-notifications-api/)
- [Broad Institute OAuth API](https://apis.io/apis/broad-institute/broad-institute-oauth-api/)
- [Broad Institute Profile API](https://apis.io/apis/broad-institute/broad-institute-profile-api/)

## Tags

Entities

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/broad-institute/broad-institute-entities-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/broad-institute/.