Skip to content
Hayonix

API reference · Projects

List projects

GET/v1/orgs/{org_id}/projects
API keyproject:readOrganizationPaginated
TypeScript
client.projects.list()
Python
client.projects.list()
CLI
hayonix projects list

Returns the organization’s projects, newest first, including archived ones unless you filter with archived.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the project:read permission (a key's scope, or a role that includes it).

Examples

The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.

# The org of your key: GET /v1/caller
ORG_ID=$(curl -sS "$API_BASE_URL/caller" -H "Authorization: Bearer $API_KEY" | jq -r .org_id)

curl -sS "$API_BASE_URL/orgs/$ORG_ID/projects" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.

Path parameters

  • org_idstring

    Your organization. The SDKs and the CLI fill it in from the API key.

    ID with prefix org_

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

  • archivedboolean | string

    Filter by archived state

Response

200 a page of results — A page of projects, newest first

  • dataarray of Projectrequired

    The items of this page.

    Show 9 fields of data
    • 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)

  • next_cursorstring | nullrequired

    Pass as `cursor` for the next page; null on the last page.

Example response
Example response
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "string"
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.