Projects - API Documentation

Retrieve all

Endpoint

GET https://sqr.co/api/projects/

Example

curl --request GET \
--url 'https://sqr.co/api/projects/' \
--header 'Authorization: Bearer {api_key}' \

Parameters	Details	Description
page	Optional Integer	The page number that you want results from. Defaults to `1`.
results_per_page	Optional Integer	How many results you want per page. Allowed values are: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Defaults to `25`.

Response example

{ "data": [ { "id": 1, "name": "Development", "color": "#0e23cc", "last_datetime": "2021-03-14 21:22:37", "datetime": "2021-02-04 17:51:07" }, ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://sqr.co/api/projects?&page=1", "last": "https://sqr.co/api/projects?&page=1", "next": null, "prev": null, "self": "https://sqr.co/api/projects?&page=1" } }

Retrieve one

Endpoint

GET https://sqr.co/api/projects/{project_id}

Example

curl --request GET \
--url 'https://sqr.co/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \

Response example

{ "data": { "id": 1, "name": "Development", "color": "#0e23cc", "last_datetime": "2021-03-14 21:22:37", "datetime": "2021-02-04 17:51:07" } }

Create

Endpoint

POST https://sqr.co/api/projects

Parameters	Details	Description
name	Required String	-
color	Optional String	-

Example

curl --request POST \
--url 'https://sqr.co/api/projects' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#ffffff' \

Response example

{ "data": { "id": 1 } }

Update

Endpoint

POST https://sqr.co/api/projects/{project_id}

Parameters	Details	Description
name	Optional String	-
color	Optional String	-

Example

curl --request POST \
--url 'https://sqr.co/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Production' \
--form 'color=#000000' \

Response example

{ "data": { "id": 1 } }

Delete

Endpoint

DELETE https://sqr.co/api/projects/{project_id}

Example

curl --request DELETE \
--url 'https://sqr.co/api/projects/{project_id}' \
--header 'Authorization: Bearer {api_key}' \