get /v1/organizations/{organizationId}/spaces/{offset}

List spaces

Returns spaces in the organization. Supports filtering, sorting, and name search via query parameters. If no status is provided, only active spaces are returned. You can further refine results with searchQuery, labelIds, excludeLabelIds, and spaceTypes.

path params

organizationIdstring required

offsetinteger required

query params

statusstring

Enum values:

active

archived

hidden

deleted

sortBystring

Enum values:

created_at_asc

created_at_desc

last_activity_asc

last_activity_desc

searchQuerystring

labelIdsarray of strings

excludeLabelIdsboolean

spaceTypesarray of strings

Enum values:

SPACE_TYPE_UNSPECIFIED

SPACE_TYPE_PERSONAL

SPACE_TYPE_COMMUNITY

SPACE_TYPE_COURSE

SPACE_TYPE_PROJECT

SPACE_TYPE_TEAM

SPACE_TYPE_KNOWLEDGE

SPACE_TYPE_OTHER

Responses

response body

object

spaces Array

Array of Space

id String

organizationId String

name String

type String ENUM

TYPE ENUM VALUES

personalSpaceUserId String

otherTypeName String

organizationSharing String ENUM

ORGANIZATIONSHARING ENUM VALUES

linkSharing String ENUM

LINKSHARING ENUM VALUES

publicSharing String ENUM

PUBLICSHARING ENUM VALUES

linkSharingSecret String

tags Array of String

status String ENUM

STATUS ENUM VALUES

templateType String ENUM

TEMPLATETYPE ENUM VALUES

coverPhotoFileId String

coverPhotoXOffset Integer

coverPhotoYOffset Integer

iconName String

defaultSpaceRoleId String

descriptionBlockId String

enableProgressTracking Boolean

onlyAllowExistingOrganizationMembers Boolean

allowBlockSharingOrganizationMembers Boolean

allowBlockSharingPublic Boolean

allowBlockSharingUsers Boolean

coverPhotoFileUrl String

roles Array

Array of SpaceRole

id String

spaceId String

name String

type String ENUM

TYPE ENUM VALUES

classification String

permissions Array

Array of String

createdAt String

updatedAt String

memberCount Integer

membersView Array

Array of MemberView

startDate String

endDate String

createdAt String

updatedAt String

deletedAt String

lastActivityAt String

createdById String

pilotToken String

labels Array

Array of Label

nextOffset Integer

Pivot Mobile and Desktop App

The Infinite Canvas Block

Audio and Video Messages

Making the Most of Your Personal Space

Integrating with Pivot using Zapier

List spaces

path params

query params

Responses