Projects
post
Creates a project in the workspace linked to the current API Key
Body
nameany ofOptional
stringOptional
nullOptional
Responses
201
created
application/json
401
not authenticated
500
general error
post
POST /projects HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"name": "text"
}
{
"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"
}
}
get
Retrieves a list of all resources from the service.
Query parameters
$limitintegerOptional
Number of results to return
$skipintegerOptional
Number of results to skip
Responses
200
success
application/json
401
not authenticated
500
general error
get
GET /projects HTTP/1.1
Host:
Accept: */*
{
"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"
}
}
]
}
get
Retrieves a single resource with the given id from the service.
Path parameters
idintegerRequired
ID of Project to return
Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
get
GET /projects/{id} HTTP/1.1
Host:
Accept: */*
{
"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"
}
}
patch
Updates the resource identified by id using data.
Path parameters
idintegerRequired
ID of Project to update
Body
idstringOptional
nameany ofOptional
stringOptional
nullOptional
updated_atstringOptional
created_atstringOptional
authorany ofOptional
or
nullOptional
ownerany ofOptional
or
nullOptional
Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
patch
PATCH /projects/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 214
{
"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"
}
}
{
"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"
}
}
delete
Removes the resource with id.
Path parameters
idintegerRequired
ID of Project to remove
Responses
200
success
application/json
401
not authenticated
404
not found
500
general error
delete
DELETE /projects/{id} HTTP/1.1
Host:
Accept: */*
{
"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"
}
}
Last updated