Skip to content
Hayonix

API reference · Members

List members

GET/v1/orgs/{org_id}/members
Console sessionmember:readOrganizationPaginated

Returns the people in the organization with their roles, oldest first.

Console session only: no API key can be granted the member:read permission it needs. Requires the member:read permission (a key's scope, or a role that includes it).

Request

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

Response

200 a page of results — A page of members, oldest first

  • dataarray of Memberrequired

    The items of this page.

    Show 7 fields of data
    • objectstringrequired

      Always `member`: the type of this object

      One ofmember

    • idstringrequired

      Unique ID (`mem_…`)

      ID with prefix mem_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • user_idstringrequired

      ID of the user

      ID with prefix usr_

    • roleRolerequired

      One ofowneradmindeveloperbillingviewer

    • userobjectrequired

      The user who holds this membership

      Show 3 fields of user
      • namestringrequired

        Its name

      • emailstringrequired

        Email address of the user

      • imagestring | nullrequired

        Container image reference

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

  • next_cursorstring | nullrequired

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

Example response
Example response
{
  "data": [
    {
      "object": "member",
      "id": "mem_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "user_id": "usr_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "role": "owner",
      "user": {
        "name": "string",
        "email": "string",
        "image": "string"
      },
      "created_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.