fimidara — docs

`FimidaraEndpoints.collaborators.getWorkspaceCollaborators`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspaceCollaboratorsEndpointParams

}

GetWorkspaceCollaboratorsEndpointParams

—Optional

{

workspaceId?: string

page?: number

pageSize?: number

}

Result

—Optional

{

headers: Headers

body?: GetWorkspaceCollaboratorsEndpointResult

}

GetWorkspaceCollaboratorsEndpointResult

—Optional

{

collaborators: Array<Collaborator>

page: number

}

Collaborator

—Optional

{

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

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

name: string

message: string

field?: string

}

`FimidaraEndpoints.collaborators.getWorkspaceCollaborators`

Parameters

props—Optional

{

authToken: string

body?: GetWorkspaceCollaboratorsEndpointParams

}

GetWorkspaceCollaboratorsEndpointParams

—Optional

{

workspaceId?: string

page?: number

pageSize?: number

}

Result

—Optional

{

headers: Headers

body?: GetWorkspaceCollaboratorsEndpointResult

}

GetWorkspaceCollaboratorsEndpointResult

—Optional

{

collaborators: Array<Collaborator>

page: number

}

Collaborator

—Optional

{

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

—Optional

{

agentId: string

agentType: string

}

Throws

—Required

Error thrown, if error is an endpoint error.

{

errors: Array<FimidaraEndpointErrorItem>

statusCode: number

statusText?: string

headers: Headers

}

FimidaraEndpointErrorItem

—Optional

Server error item.

{

name: string

message: string

field?: string

}

FimidaraEndpoints.collaborators.getWorkspaceCollaborators

Parameters

GetWorkspaceCollaboratorsEndpointParams

Result

GetWorkspaceCollaboratorsEndpointResult

Collaborator

Agent

Throws

FimidaraEndpointErrorItem

Loading...

FimidaraEndpoints.collaborators.getWorkspaceCollaborators

Parameters

GetWorkspaceCollaboratorsEndpointParams

Result

GetWorkspaceCollaboratorsEndpointResult

Collaborator

Agent

Throws

FimidaraEndpointErrorItem

`FimidaraEndpoints.collaborators.getWorkspaceCollaborators`

`FimidaraEndpoints.collaborators.getWorkspaceCollaborators`