Projects

List projects

Lists the projects your service account can access, newest first, cursor-paginated. custom_id optionally filters to your own identifier for a project; an unknown custom id yields an empty list. Custom ids are not guaranteed unique, so more than one project may match.

get/projects

Request

Base URL: https://api.rabbet.com/v1
URL: https://api.rabbet.com/v1/projects
Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Query parameters

custom_idstring

Your identifier for the project, as configured in Rabbet. Must not be empty when provided.

Matched exactly — a filter, not a search. There is no prefix, substring, or case-insensitive matching, and the value is compared literally, so send it URL-encoded and unquoted:

GET /v1/projects?custom_id=SANY-4471
GET /v1/projects?custom_id=Sunset%20Ridge-4471

limitinteger

Page size, between 1 and 100.

cursorstring

Opaque cursor from the previous page's pagination.next_cursor.

Response

A page of projects (empty when none match).

Example response

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "Theodore Hotel Austin",
      "custom_id": "SANY-4471",
      "street_address": "123 Foobar St",
      "city": "Austin",
      "state": "TX",
      "zip": "78757",
      "start_date": "2026-04-15",
      "status": "active",
      "project_type_id": "e5a0e6db-0367-4d21-b0a4-6a3b3f4c9f2a",
      "team_id": "a3f1c9de-2b47-4f80-9c11-5d2e7a6b8c04"
    }
  ],
  "pagination": {
    "next_cursor": "g3QAAAACdwJpZG0AAAAkZDI5MGYxZWU"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.