get_spaces

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesRequestQueryParams(ids: list[int] = OPT, keys: list[str] = OPT, type: str = OPT, status: str = OPT, labels: list[str] = OPT, favorited_by: str = OPT, not_favorited_by: str = OPT, sort: str = OPT, description_format: str = OPT, include_icon: bool = OPT, cursor: str = OPT, limit: int = OPT)[source]
class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesRequest(path_params: ~sanhe_confluence_sdk.methods.model.PathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)[source]

See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-get

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponseResultDescriptionPlain(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

BodyType schema for plain text representation.

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponseResultDescriptionView(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

BodyType schema for view (HTML) representation.

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponseResultDescription(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

SpaceDescription schema.

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponseResultIcon(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

SpaceIcon schema.

SpaceLinks schema.

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponseResult(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

SpaceBulk schema - represents a single space in the results array.

property type: str

SpaceType enum: global, collaboration, knowledge_base, personal, etc.

property status: str

SpaceStatus enum: current, archived.

property createdAt: str

ISO 8601 date-time string.

class sanhe_confluence_sdk.methods.space.get_spaces.GetSpacesResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

MultiEntityResult<SpaceBulk> schema - top level response.