Skip to content

Function: getProjectProperty() ​

ts
function getProjectProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/cloud/api/projectProperties.ts:43

Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ projectIdOrKey: string; propertyKey: string; }-
parameters.projectIdOrKeystringThe project ID or project key (case sensitive).
parameters.propertyKey?stringThe project property key. Use Get project property keys to get a list of all project property keys.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>