v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Projects

List Projects

Returns a list of projects.


Projects are returned sorted in descending order based on the created-at time. Without the page and per_page parameters, the first 100 projects will be returned. If per_page is specified, a maximum of 250 projects will be returned.

get/tenants/{tenant_id}/projects

Path parameters

tenant_idstring uuid required

The ID of the tenant to get projects for.

Query parameters

pageinteger

Page to return, 1-indexed (default 1)

per_pageinteger

Number of items to return per page (default 100, max 250)

Response

Projects successfully retrieved.

Example response

{
  "projects": [
    {
      "name": "My first test project",
      "created_at": "2023-07-11 18:43:18 UTC",
      "property_address": "434 Brannan St, San Francisco, CA, 94107",
      "tags": [
        "third_party_1",
        "region_a"
      ]
    }
  ]
}