Skip to content
Hayonix

API reference · Secrets

List secrets

GET/v1/secrets
API keysecret:readProjectPaginated
TypeScript
client.secrets.list()
Python
client.secrets.list()
CLI
hayonix secrets list

The project’s secrets, newest first: names and dates only, never values.

Project API key (Authorization: Bearer sk_…), or a console session. Requires the secret: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.

curl -sS "$API_BASE_URL/secrets" \
  -H "Authorization: Bearer $API_KEY"

Request

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

Response

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

  • dataarray of Secretrequired

    The items of this page.

    Show 8 fields of data
    • objectstringrequired

      Always `secret`: the type of this object

      One ofsecret

    • idstringrequired

      Unique ID (`sec_…`)

      ID with prefix sec_

    • project_idstringrequired

      Project it belongs to

      ID with prefix prj_

    • namestringrequired

      Its name

    • created_by_user_idstring | nullrequired

      ID of the user who created it

    • created_byobject | nullrequired

      Who created it (null: created by the platform)

      Show 3 fields of created_by
      • objectstringrequired

        Always `person`

        One ofperson

      • idstringrequired

        The person’s user ID (`usr_…`)

      • namestring | nullrequired

        Their name as they set it; null when they are no longer a member of the organization

    • 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": "secret",
      "id": "sec_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "name": "string",
      "created_by_user_id": "string",
      "created_by": {
        "object": "person",
        "id": "string",
        "name": "string"
      },
      "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.