Skip to content
Hayonix

API reference · Schema

Project

  • objectstringrequired

    Always `project`: the type of this object

    One ofproject

  • idstringrequired

    Unique ID (`prj_…`)

    ID with prefix prj_

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • namestringrequired

    Its name

  • slugstringrequired

    Short URL-safe name, unique within the organization

  • descriptionstring | nullrequired

    Free-text description

  • archived_atstring (date-time) | nullrequired

    When it was archived (null while it is active) (ISO 8601, UTC)

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • updated_atstring (date-time)required

    When it last changed (ISO 8601, UTC)

Example
{
  "object": "project",
  "id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "name": "string",
  "slug": "string",
  "description": "string",
  "archived_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Used by