Project Management

Read Project

Introduction

If a ReadProjectRequest is passed, get details about that single project. If no request body is passed, list details of all projects.

Request

The projectId for the project to read, or nothing to get a list of all projects. The /projects/read API accepts requests in the following format:

ReadProjectRequest Model - Request to get details about a specific project.
projectId integer
Id of the project.
Example
{
  "projectId": 0
}

Responses

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

200 Success

ProjectListResponse Model - Project list response.
projects Project Array
List of projects for the authenticated user.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example
{
  "projects": [
    {
      "projectId": 0,
      "name": "string",
      "created": 2021-11-26T15:18:27.693Z,
      "modified": 2021-11-26T15:18:27.693Z,
      "language": "C#"
    }
  ],
  "success": true,
  "errors": [
    "string"
  ]
}
Project Model - Response from reading a project by id.
projectId integer
Project id.
name string
Name of the project.
created string($date-time)
Date the project was created.
modified string($date-time)
Modified date for the project.
language string Enum
Programming language of the project. Options : ['C#', 'Py']
Example
{
  "projectId": 0,
  "name": "string",
  "created": 2021-11-26T15:18:27.693Z,
  "modified": 2021-11-26T15:18:27.693Z,
  "language": "C#"
}

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: