Projects

post

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

Body

nameany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/projects' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text"
  }'

201

401

500

201

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

created

get

Retrieves a list of all resources from the service.

Query parameters

$limitintegeroptional

Number of results to return

$skipintegeroptional

Number of results to skip

filterobjectoptional

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",
      "name": "text",
      "status": {
        "name": "text",
        "stage": "text"
      },
      "updated_at": "text",
      "created_at": "text",
      "author": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      },
      "owner": {
        "uuid": "text",
        "name": "text",
        "email": "text"
      }
    }
  ]
}

success

get

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

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",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

success

patch

Updates the resource identified by id using data.

Path parameters

idintegerrequired

ID of Project to update

Body

idstringoptional

nameany ofoptional

statusobjectoptional

updated_atstringoptional

created_atstringoptional

authorany ofoptional

ownerany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

404

500

200

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

success

delete

Removes the resource with 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",
  "name": "text",
  "status": {
    "name": "text",
    "stage": "text"
  },
  "updated_at": "text",
  "created_at": "text",
  "author": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  },
  "owner": {
    "uuid": "text",
    "name": "text",
    "email": "text"
  }
}

success