List Projects

GET 
/projects

List Projects

Request

Query Parameters

filter string
sort string
projection string
offset int32
limit int32
api-version string
The requested API version
Default value: 1

Responses

200

OK

text/plain

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

ownerIdstringnullable

Id of the user owner

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

folderIdstring

Folder ID where the project is located

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "name": "string",
        "tags": [
          "string"
        ],
        "createdBy": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "ownerId": "string"
      },
      "properties": {
        "description": "string",
        "default": true,
        "resourcesNumber": 0,
        "folderId": "string"
      }
    }
  ]
}

application/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

ownerIdstringnullable

Id of the user owner

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

folderIdstring

Folder ID where the project is located

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "name": "string",
        "tags": [
          "string"
        ],
        "createdBy": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "ownerId": "string"
      },
      "properties": {
        "description": "string",
        "default": true,
        "resourcesNumber": 0,
        "folderId": "string"
      }
    }
  ]
}

text/json

Schema

Schema

totalint64
selfstringnullable
prevstringnullable
nextstringnullable
firststringnullable
laststringnullable

values

object[]

Array [

metadata

object

idstringnullable

Project id

namestringnullable

Project name

tagsstring[]nullable

Project tag list

createdBystringnullable

Id of the user who created the project

creationDatedate-timenullable

Creation date

ownerIdstringnullable

Id of the user owner

properties

object

descriptionstringnullable

Optional description of the project

defaultboolean

Indicates if it's the default project

resourcesNumberint64

Number of resources created within the project

folderIdstring

Folder ID where the project is located

]

Example (from schema)

{
  "total": 0,
  "self": "string",
  "prev": "string",
  "next": "string",
  "first": "string",
  "last": "string",
  "values": [
    {
      "metadata": {
        "id": "string",
        "name": "string",
        "tags": [
          "string"
        ],
        "createdBy": "string",
        "creationDate": "2024-07-29T15:51:28.071Z",
        "ownerId": "string"
      },
      "properties": {
        "description": "string",
        "default": true,
        "resourcesNumber": 0,
        "folderId": "string"
      }
    }
  ]
}

204

No Content

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error