Collaboration

Read Project Collaborators

Introduction

List all collaborators in a project.

Request

The /projects/collaboration/read API accepts requests in the following format:

ReadCollaboratorsRequest Model - Request to list the collaborators in a project.
projectId integer
Id of the project from which to read one or multiple collaborators.
Example 
{
  "projectId": 0
}

Responses

The /projects/collaboration/read API provides a response in the following format:

200 Success

ReadCollaboratorsResponse Model - Response received when reading the collaborators of a project.
collaborators Collaborator Array
List of collaborators.
userLiveControl boolean
Indicate if the user has the right to deploy and stop live algorithms.
userPermissions string
List the user permissions - write/read.
success boolean
Indicate if the API request was successful.
Example 
{
  "collaborators": [
    {
      "uid": 0,
      "liveControl": true,
      "permission": "read",
      "publicId": "string",
      "profileImage": "https://cdn.quantconnect.com/web/i/users/profile/abc123.jpeg",
      "email": "abc@123.com",
      "name": "string",
      "bio": "string",
      "owner": true
    }
  ],
  "userLiveControl": true,
  "userPermissions": "string",
  "success": true
}
Collaborator Model
uid integer
User ID.
liveControl boolean
Indicate if the user have live control.
permission string Enum
The permission this user is given. Options : ['read', 'write']
publicId string
The user public ID.
profileImage string
example: https://cdn.quantconnect.com/web/i/users/profile/abc123.jpeg
The url of the user profile image.
email string
example: abc@123.com
The registered email of the user.
name string
The display name of the user.
bio string
The biography of the user.
owner boolean
Indicate if the user is the owner of the project.
Example 
{
  "uid": 0,
  "liveControl": true,
  "permission": "read",
  "publicId": "string",
  "profileImage": "https://cdn.quantconnect.com/web/i/users/profile/abc123.jpeg",
  "email": "abc@123.com",
  "name": "string",
  "bio": "string",
  "owner": true
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: