Projects

Creates a project in the workspace linked to the current API Key

post

/projects

Body

nameany of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/projects' \
  --header 'Content-Type: application/json'

201

401

500

201

{
  "id": "text",
  "updated_at": "text",
  "created_at": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

created

Retrieves a list of all resources from the service.

get

/projects

Query parameters

$limitinteger

Number of results to return

$skipinteger

Number of results to skip

filterobject

Query parameters

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/projects'

200

401

500

200

{
  "total": 1,
  "limit": 1,
  "skip": 1,
  "data": [
    {
      "id": "text",
      "updated_at": "text",
      "created_at": "text",
      "name": "text",
      "status": {
        "name": "text",
        "stage": "text"
      },
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "owner": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      }
    }
  ]
}

success

Retrieves a single resource with the given id from the service.

get

/projects/{id}

Path parameters

idintegerrequired

ID of Project to return

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/projects/{id}'

200

401

404

500

200

{
  "id": "text",
  "updated_at": "text",
  "created_at": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

success

Updates the resource identified by id using data.

patch

/projects/{id}

Path parameters

idintegerrequired

ID of Project to update

Body

idstring

updated_atstring

created_atstring

nameany of

statusobject

authorany of

ownerany of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/projects/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"status":{"name":"text","stage":"text"},"author":{"uuid":"text","name":"text","email":"text"},"owner":{"uuid":"text","name":"text","email":"text"}}'

200

401

404

500

200

{
  "id": "text",
  "updated_at": "text",
  "created_at": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

success

Removes the resource with id.

delete

/projects/{id}

Path parameters

idintegerrequired

ID of Project to remove

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/projects/{id}'

200

401

404

500

200

{
  "id": "text",
  "updated_at": "text",
  "created_at": "text",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

success