fimidara — docs

fimidara
fimidara REST API
overview
agentTokens
collaborationRequests
collaborators
getCollaborator—post
getWorkspaceCollaborators—post
countWorkspaceCollaborators—post
removeCollaborator—post
files
folders
jobs
permissionGroups
permissionItems
resources
usageRecords
workspaces
fileBackends
presignedPaths
fimidara JS SDK
/v1/collaborators/getCollaborator
—
post
Path Parameters
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType
—Optional

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Request Body
GetCollaboratorEndpointParams
—Optional

{
workspaceId?: string
collaboratorId: string
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength
—Optional

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

200 — Response Body
GetCollaboratorEndpointResult
—Optional

{
collaborator: Collaborator
}
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
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength
—Optional

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
—Optional

Endpoint error result

{
errors?: Array<OperationError>
}
OperationError
—Optional

{
name: string
message: string
action?: string
field?: string
notes?: Array<EndpointResultNote>
}
EndpointResultNote
—Optional

{
code: string
message: string
}