/v1/collaborators/getWorkspaceCollaborators
—
post

Retrieve a paginated list of all collaborators in a workspace. Results include basic collaborator information such as name, email, and workspace association. Use pagination parameters to navigate through large result sets.

Path Parameters
Not Applicable
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Not Applicable
Request Body
GetWorkspaceCollaboratorsEndpointParams

Parameters for getting a list of workspace collaborators.

{
workspaceId?: string
page?: number
pageSize?: number
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
GetWorkspaceCollaboratorsEndpointResult

Result of getting a list of workspace collaborators.

{
collaborators: Array<Collaborator>
page: number
}
Collaborator

Publicly visible information about a collaborator.

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
firstName: string
lastName: string
email: string
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}