Skip to main content

Get Credentials

Fetch the list of stored credentials for a given integration entity. The entity name is automatically uppercased by the SDK.

Function Signature

client.workflow.getCredentials(params: GetCredentialsParams): Promise<BolticSuccessResponse<CredentialsListData> | BolticErrorResponse>

Parameters

ParameterTypeRequiredDefaultDescription
entitystringIntegration name (e.g., "asana", "freshsales"). Automatically uppercased.
current_pagenumber1Page number for pagination
page_sizenumber999Number of items per page

Basic Usage

import { createClient } from "@boltic/sdk";

const client = createClient("your-api-key");

const result = await client.workflow.getCredentials({
entity: "asana",
});

if (result.error) {
console.error("Failed:", result.error.message);
} else {
console.log("Credentials:", result.data);
}

With Pagination

const result = await client.workflow.getCredentials({
entity: "freshsales",
current_page: 1,
page_size: 10,
});

if (!result.error) {
console.log("Credentials:", result.data);
}

Return Value

Success Response

{
data: {
// Credentials list data
[key: string]: unknown;
},
message?: string;
}