Projects API

Projects let customers organize jobs and assets into logical groupings. Every authenticated user has at least one default project that is automatically created when the account is provisioned.

List projects

GET /projects

Returns all projects owned by the authenticated user in ascending creation order.

[
  {
    "id": "proj_default",
    "name": "Default",
    "address": null,
    "created_at": "2024-03-12T09:15:00Z"
  }
]

Create a project

POST /projects

  • Name
    name
    Type
    string
    Description

    Required. Project name must be unique per user. Leading and trailing whitespace is trimmed server-side.

  • Name
    address
    Type
    string
    Description

    Optional property address or description for the project.

Successful requests return HTTP 201 Created with the new project record. Attempting to reuse an existing name yields a 409 Conflict response with an explanatory error message.

Was this page helpful?