find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/root-fka-slimai-invitations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: This is the API documentation for Root.io.
  title: Root.io Accounts Invitations API
  termsOfService: https://www.root.io/terms-of-service
  contact: {}
  version: '1.0'
servers:
- url: https://api.root.io
tags:
- name: Invitations
paths:
  /v3/invites:
    get:
      security:
      - BasicAuth: []
      description: Lists all invitations for the organization with pagination support
      tags:
      - Invitations
      summary: List organization invitations
      parameters:
      - description: Cursor for next page
        name: after
        in: query
        schema:
          type: string
      - description: Cursor for previous page
        name: before
        in: query
        schema:
          type: string
      - description: Page size (default 100, max 1000)
        name: limit
        in: query
        schema:
          type: integer
      - description: Ordering (e.g., 'created_at:desc')
        name: order
        in: query
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInvitesResponse'
    post:
      security:
      - BasicAuth: []
      description: Creates an organization invite in the database. Email is validated if provided.
      tags:
      - Invitations
      summary: Create organization invite
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInviteRequest'
        description: Invite request
        required: true
  /v3/invites/{inviteID}/accept:
    post:
      security:
      - BasicAuth: []
      description: Accepts an organization invite and adds the account to the organization with the specified role.
      tags:
      - Invitations
      summary: Accept organization invite
      parameters:
      - description: Invite ID
        name: inviteID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteAcceptAccountResponse'
  /v3/invites/{inviteID}/email:
    post:
      security:
      - BasicAuth: []
      description: Sends an invitation email for an existing invite
      tags:
      - Invitations
      summary: Send invite email
      parameters:
      - description: Invite ID
        name: inviteID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteEmailResponse'
components:
  schemas:
    Role:
      type: string
      enum:
      - admin
      - member
      - readonly
      x-enum-varnames:
      - RoleAdmin
      - RoleMember
      - RoleReadonly
    ListInvitesResponse:
      type: object
      properties:
        cursor:
          $ref: '#/components/schemas/Cursor'
        data:
          type: array
          items:
            $ref: '#/components/schemas/InviteResponse'
    CreateInviteRequest:
      type: object
      required:
      - role
      properties:
        email:
          type: string
        role:
          $ref: '#/components/schemas/Role'
    Cursor:
      type: object
      properties:
        after:
          type: string
        before:
          type: string
        limit:
          type: integer
        total_count:
          description: TotalCount is the number of rows matching the list filters for endpoints that populate it (e.g. security findings list). Response-only.
          type: integer
    InviteAcceptAccountResponse:
      type: object
      properties:
        email:
          type: string
        id:
          type: string
        name:
          type: string
        organization_id:
          type: string
        role:
          $ref: '#/components/schemas/Role'
    InviteResponse:
      type: object
      properties:
        email:
          type: string
        id:
          type: string
        issuer_id:
          type: string
        organization_id:
          type: string
        role:
          $ref: '#/components/schemas/Role'
    InviteEmailResponse:
      type: object
      properties:
        email_status:
          type: string
        invite:
          $ref: '#/components/schemas/InviteResponse'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic