openapi: 3.0.3
info:
  title: Everflow Network API - Roles
  description: >
    Endpoint for listing roles in the Everflow network.
    For configuration details, see the [Roles & Permissions guide](https://helpdesk.everflow.io/customer/how-to-manage-roles-permissions).
  version: 1.0.0
servers:
  - url: https://api.eflow.team/v1
tags:
  - name: Roles
paths:
  /networks/roles:
    get:
      summary: List Roles
      tags:
        - Roles
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    role_id:
                      type: integer
                      description: Unique role ID.
                    network_id:
                      type: integer
                      description: Network ID.
                    name:
                      type: string
                      description: Role name.
                    description:
                      type: string
                      description: Role description.
                    permissions:
                      type: array
                      items:
                        type: string
                      description: Array of permission identifiers assigned to this role.
                    time_created:
                      type: integer
                      example: 1734455015
                      description: Unix timestamp of creation.
                    time_saved:
                      type: integer
                      example: 1734455015
                      description: Unix timestamp of last update.
      security:
        - API Key: []
components:
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey