Function: getSpaceProperties()

function getSpaceProperties(client, parameters): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  results?: object[];
}>;

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

Returns all properties for the given space. Space properties are a key-value storage associated with a space. The limit parameter specifies the maximum number of results returned in a single response. Use the link response header to paginate through additional results.

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

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ cursor?: string; key?: string; limit?: number; spaceId: number; }	-
parameters.cursor?	string	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
parameters.key?	string	The key of the space property to retrieve. This should be used when a user knows the key of their property, but needs to retrieve the id for use in other methods.
parameters.limit?	number	Maximum number of pages per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
parameters.spaceId	number	The ID of the space for which space properties should be returned.

Returns

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; results?: object[]; }>