Get Projects List

GEThttps://api.peekshot.com/api/v1/projects

Retrieve a full list of screenshot projects and their associated metadata with the PeekShot Get Projects List API. Ideal for organizing multiple projects, automating workflows, or powering admin dashboards that display project structures.

Query Parameters

Name	Type	Description
page	string	Page number for pagination
limit	string	Number of results per page
name	string	Filter projects by name

Notes

All requests must include the x-api-key header with a valid API key.

curl --location 'https://api.peekshot.com/api/v1/projects' \
  --header 'x-api-key: your-api-key'

Responses

200Success Response

{
  "status": "success",
  "message": "Projects fetched successfully",
  "data": {
    "projects": [
      {
        "id": 11,
        "name": "Delta",
        "createdAt": "2025-02-25T04:58:28.205Z",
        "updatedAt": "2025-02-25T04:58:28.205Z",
        "createdByUser": {
          "id": 21,
          "email": "[email protected]",
          "firstName": "John",
          "lastName": "Doe"
        }
      }
    ],
    "meta": {
      "currentPage": 1,
      "totalProjects": 1,
      "limit": 10
    }
  },
  "statusCode": 200
}