space

class pyatlassian.atlassian_confluence.space.SpaceMixin

For detailed API document, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-group-space

get_spaces(ids: list[int] = _NOTHING(), keys: list[str] = _NOTHING(), type: str = _NOTHING(), status: str = _NOTHING(), labels: list[str] = _NOTHING(), favorited_by: str = _NOTHING(), not_favorited_by: str = _NOTHING(), sort: str = _NOTHING(), description_format: str = _NOTHING(), include_icon: bool = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, _url: str = None) → Dict[str, Any]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-get

Parameters:

req_kwargs – additional requests.request() kwargs

pagi_get_spaces(ids: list[int] = _NOTHING(), keys: list[str] = _NOTHING(), type: str = _NOTHING(), status: str = _NOTHING(), labels: list[str] = _NOTHING(), favorited_by: str = _NOTHING(), not_favorited_by: str = _NOTHING(), sort: str = _NOTHING(), description_format: str = _NOTHING(), include_icon: bool = _NOTHING(), cursor: str = _NOTHING(), limit: int = _NOTHING(), req_kwargs: Dict[str, Any] | None = None, total_max_results: int = 9999) → Iterable[Dict[str, Any]]

For detailed parameter descriptions, see: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space/#api-spaces-get

Parameters:

• req_kwargs – additional requests.request() kwargs

• total_max_results – total max results to fetch in all response