Skip to content

Function: getSpacePropertyById()

ts
function getSpacePropertyById(client, parameters): Promise<{
[key: string]: unknown;
  authorId?: string;
  createdAt?: Date;
  id?: string;
  key?: string;
  value?: unknown;
  version?:   | {
   [key: string]: unknown;
     authorId?: string;
     createdAt?: Date;
     message?: string;
     number?: number;
   }
     | null;
}>;

Defined in: src/v2/api/spaceProperties.ts:59

Retrieve a space property by its id.

Permissions required: Permission to access the Confluence site ('Can use' global permission) and 'View' permission for the space.

Parameters

ParameterTypeDescription
clientClient-
parameters{ propertyId: number; spaceId: number; }-
parameters.propertyIdnumberThe ID of the property to be retrieved.
parameters.spaceIdnumberThe ID of the space the property belongs to.

Returns

Promise&lt;{ [key: string]: unknown; authorId?: string; createdAt?: Date; id?: string; key?: string; value?: unknown; version?: | { [key: string]: unknown; authorId?: string; createdAt?: Date; message?: string; number?: number; } | null; }>