---
title: "Get Pearl Credentials"
method: GET
path: "/v2/Pearl/Credential/{pearlId}"
tags: ["Pearl"]
---

# Get Pearl Credentials

`GET /v2/Pearl/Credential/{pearlId}`

## Request

- Base URL: `https://api.nlpearl.ai`
- URL: `https://api.nlpearl.ai/v2/Pearl/Credential/{pearlId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/Credential/:pearlId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the API credentials (Id and Name only) available to the specified Pearl. Use a returned Id as the CredentialId of an API action in the Pearl flow.

## Path parameters

- `pearlId` string, required

## Response `200`

The credentials available to the specified Pearl.

- CredentialApiView[]
  - `id` string, nullable: The credential ID. Use this value as the CredentialId of an API action.
  - `name` string, nullable: The display name of the credential.

## Other responses

- `400`: Error

---

[API](https://skmtc.dev/nlpearl/apis/nlpearl-client-api.md) - [All operations](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/revisions/52d64fc5d6e9?raw)