Projects: Retrieve One

This documentation entry provides a clear and detailed guide on how to retrieve a specific project using the API, including the necessary parameters, headers, and expected response.

Endpoint

GET /api/projects/{project_id}

Retrieve detailed information about a specific project by its unique identifier.

Request

HTTP Request

GET https://uptimekeep.com/api/projects/{project_id}

Replace {project_id} with the ID of the project you wish to retrieve.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.

Example of a request:

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

Response

A successful response returns a JSON object containing detailed information about the specified project.

Response Example

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

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the project.
name	String	Name of the project.
color	String	Color associated with the project (hex code).
last_datetime	String	Timestamp of the last activity related to the project (in YYYY-MM-DD HH:MM:SS format).
datetime	String	Timestamp when the project was created (in YYYY-MM-DD HH:MM:SS format).

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 404 Not Found if the project ID does not exist.