Skip to main content
GET
List Groups

Path Parameters

workspaceId
string
required

Query Parameters

cursor
string
filter
enum<string>
default:all
Available options:
all,
last-viewed
isPrototype
boolean
Maximum string length: 255
status
enum<string>
Available options:
active,
archived
lifecycleStatus
string
sector
string
workType
string
region
enum<string>
Available options:
north_america,
east_coast,
west_coast,
europe,
middle_east,
latin_america,
apac
specDisciplines
enum<string>[]
Available options:
architectural,
finishes,
ffe,
ose
tagIds
string[]
Maximum array length: 100
projectLeadId
string
unassignedLead
boolean
plannedStartFrom
string
Pattern: ^\d{4}-\d{2}-\d{2}$
plannedStartTo
string
Pattern: ^\d{4}-\d{2}-\d{2}$
targetEndFrom
string
Pattern: ^\d{4}-\d{2}-\d{2}$
targetEndTo
string
Pattern: ^\d{4}-\d{2}-\d{2}$
groupBy
enum<string>
required
Available options:
lifecycleStatus,
sector,
workType,
projectLead
limit
number
default:20
required
Required range: 1 <= x <= 100

Response

200 - application/json
items
object[]
required
nextCursor
string | null
required
hasMore
boolean
required