---
title: "Get WarehouseCredential by ID"
method: GET
path: "/api/v3/warehouse-credential/{warehouse_credential_id}"
tags: ["Warehouse Credential"]
---

# Get WarehouseCredential by ID

`GET /api/v3/warehouse-credential/{warehouse_credential_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/warehouse-credential/{warehouse_credential_id}`
- Auth: HTTP bearer

Get a single WarehouseCredential by ID.

## Path parameters

- `warehouse_credential_id` string, required

## Query parameters

- `returning` string[]
- `omit` string[]

## Response `200`

OK

- WarehouseCredential: Represents credentials for connecting to Benchling's data warehouse, enabling users to query data using SQL tools like database clients or BI platforms. This includes all warehouse login types: user-generated Direct Access credentials, as well as temporary Insights and Agent credentials. Each WarehouseCredential is tied to a specific Benchling `user` whose permissions determine what data is accessible through those credentials. Credentials can have an optional `expiresAt` date for time-limited access and can be permanently disabled via the `revoked` flag. Once revoked, credentials cannot be reactivated. Users can create multiple credentials (up to a per-user limit) with different `label` values to distinguish between uses.
  - `__typename` string
  - `createdAt` string, datetime, nullable
  - `expiresAt` string, datetime, nullable: The time after which new connections using the username/password will not be permitted. Upon expiration, currently open connections are not terminated.
  - `id` string
  - `label` string, nullable: An optional label defined by the user who created the WarehouseCredential.
  - `modifiedAt` string, datetime, nullable
  - `revoked` boolean: Indicates whether or not the WarehouseCredential has been revoked. When a WarehouseCredential is revoked, the credentials are deleted in the warehouse and can not be reactivated.
  - `user` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `username` string: The username to connect to the warehouse.

## 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/3873a10bf7b8?raw)
