> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nerves-hub.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List all Iroh Endpoints for an Organization

> Newest first.

`search` matches the **start** of an endpoint id, and anywhere within a
device identifier or a member's name. Prefix rather than substring on the
key because that is the half a caller has: logs and tables show a key
truncated, so the beginning is what can be copied out of one.




## OpenAPI

````yaml https://manage.nervescloud.com/api/openapi get /api/orgs/{org_name}/iroh_endpoints
openapi: 3.0.0
info:
  description: >
    The NervesCloud API gives users full access to their

    Orgs, Products, and corresponding Device fleets.


    The API can be used to integrate with your own systems, providing full
    access to your Product and Device data.


    The API is documented using the OpenAPI 3.0 specification.
  title: NervesCloud API
  version: 2.0.0
servers:
  - url: https://manage.nervescloud.com
    variables: {}
security:
  - bearer_auth: []
tags:
  - description: User authentication and API token creation
    name: Auth
  - description: Organization Certificate Authority management
    name: CA Certificates
  - description: >-
      Device management, including action requests eg. upgrade, reboot,
      reconnect
    name: Devices
  - description: Log lines Devices have sent over the logging extension
    name: Device Logs
  - description: >-
      Device management, including action requests eg. upgrade, reboot,
      reconnect
    name: Devices (short URL)
  - description: Device Certificate management
    name: Device Certificates
  - description: Identities a Device holds on networks NervesHub does not run
    name: Network Identities
  - description: Deployment Group and release management
    name: Deployment Groups
  - description: Firmware uploading and management
    name: Firmwares
  - description: Organization iroh endpoint id registration
    name: Iroh Endpoints
  - description: Organization management
    name: Organizations
  - description: Organization User membership management
    name: Organization Members
  - description: Product management
    name: Products
  - description: Organization Signing Key management
    name: Signing Keys
  - description: Product Support Script management
    name: Support Scripts
  - description: Platform healthcheck
    name: Platform Status
paths:
  /api/orgs/{org_name}/iroh_endpoints:
    get:
      tags:
        - Iroh Endpoints
      summary: List all Iroh Endpoints for an Organization
      description: >
        Newest first.


        `search` matches the **start** of an endpoint id, and anywhere within a

        device identifier or a member's name. Prefix rather than substring on
        the

        key because that is the half a caller has: logs and tables show a key

        truncated, so the beginning is what can be copied out of one.
      operationId: NervesHubWeb.API.IrohEndpointController.index
      parameters:
        - description: Organization Name
          example: example_org
          in: path
          name: org_name
          required: true
          schema:
            type: string
        - description: >-
            Only endpoints held by this kind of owner, matching the `owner.type`
            in the response
          example: user
          in: query
          name: owner
          required: false
          schema:
            enum:
              - device
              - user
              - none
            type: string
        - description: >-
            Match the start of an endpoint id, or part of a device identifier or
            member name
          example: c8924b6c
          in: query
          name: search
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IrohEndpointListResponse'
          description: Iroh Endpoints
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unknown owner
      callbacks: {}
      security:
        - bearer_auth: []
components:
  schemas:
    IrohEndpointListResponse:
      description: Iroh Endpoint list response
      example:
        data:
          - details: {}
            identifier: c8924b6c9b7a8528b1365ebec4b2e43b6edebef684f8521f12b8caaf6e1b2302
            inserted_at: '2026-08-14T11:02:31Z'
            instance: default
            last_reported_at: '2026-08-16T09:14:00Z'
            owner:
              device_identifier: example_device
              type: device
              user_email: null
              user_name: null
            service: iroh
            source: device_reported
            updated_at: '2026-08-16T09:14:00Z'
          - details: {}
            identifier: 5f691e39f55415be337b2e4cc0dd7291586ab7c4356bf32bab60f46fc78f95d5
            inserted_at: '2026-08-15T08:41:12Z'
            instance: default
            last_reported_at: null
            owner:
              device_identifier: null
              type: user
              user_email: member@example.com
              user_name: Alex Doe
            service: iroh
            source: operator
            updated_at: '2026-08-15T08:41:12Z'
      properties:
        data:
          description: The organization's iroh endpoint ids
          items:
            $ref: '#/components/schemas/IrohEndpoint'
          type: array
      title: IrohEndpointListResponse
      type: object
    ErrorResponse:
      description: Error response
      example:
        errors:
          detail: Resource Not Found or Authorization Insufficient
      properties:
        errors:
          properties:
            detail:
              type: string
          type: object
      title: ErrorResponse
      type: object
    IrohEndpoint:
      description: An iroh endpoint id registered to an organization
      example:
        details: {}
        identifier: c8924b6c9b7a8528b1365ebec4b2e43b6edebef684f8521f12b8caaf6e1b2302
        inserted_at: '2026-08-14T11:02:31Z'
        instance: default
        last_reported_at: '2026-08-16T09:14:00Z'
        owner:
          device_identifier: example_device
          type: device
          user_email: null
          user_name: null
        service: iroh
        source: device_reported
        updated_at: '2026-08-16T09:14:00Z'
      properties:
        details:
          additionalProperties: true
          type: object
        identifier:
          description: The endpoint id — 64 hex characters
          type: string
        inserted_at:
          format: date-time
          type: string
        instance:
          description: >-
            Which endpoint of iroh this is. `default` for anything running a
            single one
          type: string
        last_reported_at:
          format: date-time
          nullable: true
          type: string
        owner:
          $ref: '#/components/schemas/IrohEndpointOwner'
        service:
          enum:
            - iroh
          type: string
        source:
          description: >-
            `device_reported` means a device proved this key; `operator` means
            it was registered by hand
          enum:
            - device_reported
            - operator
          type: string
        updated_at:
          format: date-time
          type: string
      title: IrohEndpoint
      type: object
    IrohEndpointOwner:
      description: What holds this endpoint id
      example:
        device_identifier: example_device
        type: device
        user_email: null
        user_name: null
      properties:
        device_identifier:
          description: Set when `type` is `device`
          nullable: true
          type: string
        type:
          description: >-
            `device` for one a device proved, `user` for a member's own machine,
            `none` for one the organization holds directly
          enum:
            - device
            - user
            - none
          type: string
        user_email:
          description: Set when `type` is `user`
          nullable: true
          type: string
        user_name:
          description: Set when `type` is `user`
          nullable: true
          type: string
      title: IrohEndpointOwner
      type: object
  securitySchemes:
    bearer_auth:
      scheme: bearer
      type: http

````