This page details how to work with Projects through our APIs. Projects are used to organize your service accounts, orders, and associated resources within our platform. This section provides the essential information to retrieve and manage projects via our API.

​
List Projects

  • Endpoint: GET /v0/projects
  • Description:
    Retrieve a paginated list of projects accessible to the authenticated service account.
  • Query Parameters:
    • page_num (integer): The page number for pagination.
    • page_size (integer): The number of projects per page.
  • Sample Response:
{
  "projects": [
    {
      "id": "<PROJECT_ID>",
      "name": "Example Project",
      "created_at": "2025-01-01T12:00:00Z",
      "description": "A brief description of the project."
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

Note:
Service accounts need to be manually added to projects from the UI before they can access project-related API functionalities.

​
Get Project Details

  • Endpoint: GET /v0/projects/{id}
  • Description:
    Retrieve detailed information about a specific project using its unique project ID.
  • Path Parameter:
    • id (string): The unique identifier of the project.
  • Sample Response:
{
  "id": "<PROJECT_ID>",
  "name": "Example Project",
  "description": "Detailed information about the project.",
  "created_at": "2025-01-01T12:00:00Z",
  "updated_at": "2025-02-01T12:00:00Z"
}

​
How to Use These Endpoints

  1. Authentication:
    Ensure your API key is included in the Authorization header as described in the Authentication section. Without proper authentication, requests will fail with a 403 error.

  2. Pagination:
    Use the page_num and page_size parameters when listing projects to efficiently navigate through large sets of projects.

  3. Error Handling:
    A 400 error indicates an issue with your request parameters, while a 404 error suggests the specified project ID does not exist.

Previous
Tasking
Next