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/roark:roark-organization-project-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:
  title: Roark Analytics Organization Project API
  description: The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform.
  version: 1.0.0
servers:
- description: Production
  url: https://api.roark.ai
security:
- Bearer: []
tags:
- name: Organization Project
paths:
  /v1/org/project:
    get:
      responses:
        '200':
          description: A page of organization projects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrgProjectsResponse'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1OrgProject
      tags:
      - Organization Project
      summary: List projects
      description: 'List projects in the organization the API key belongs to. Paginated (max 101 per page): pass `page`/`limit` and keep paging until a page returns fewer than `limit` items.'
      parameters:
      - in: query
        name: page
        schema:
          type: integer
          minimum: 1
          description: Page number (1-based, default 1)
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
          maximum: 101
          description: Page size (max 101, default 20)
    post:
      responses:
        '200':
          description: The created project
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/OrgProject'
                required:
                - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: postV1OrgProject
      tags:
      - Organization Project
      summary: Create a project
      description: Create a new project in the organization. The project is provisioned with the default analysis packages, dashboard, and alerts, exactly as a UI-created project would be. The user who minted the API key becomes the initial project owner.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrgProjectInput'
  /v1/org/project/{projectId}:
    get:
      responses:
        '200':
          description: The project
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/OrgProject'
                required:
                - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1OrgProjectByProjectId
      tags:
      - Organization Project
      summary: Get a project
      description: Get a single project by id (must belong to the organization).
      parameters:
      - schema:
          type: string
        in: path
        name: projectId
        required: true
    put:
      responses:
        '200':
          description: The updated project
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/OrgProject'
                required:
                - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: putV1OrgProjectByProjectId
      tags:
      - Organization Project
      summary: Update a project
      description: Update a project name, description, or category.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrgProjectInput'
      parameters:
      - schema:
          type: string
        in: path
        name: projectId
        required: true
    delete:
      responses:
        '200':
          description: Deletion result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DeleteOrgResourceResponse'
                required:
                - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Conflict error
              example:
                type: conflict
                code: resource_in_use
                message: The resource is in use and cannot be deleted
          description: Conflict
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: deleteV1OrgProjectByProjectId
      tags:
      - Organization Project
      summary: Delete a project
      description: Soft-delete a project and pause its active schedules. Returns 409 when the project is the last one in the organization, has an active agent connection, or has a simulation running.
      parameters:
      - schema:
          type: string
        in: path
        name: projectId
        required: true
components:
  schemas:
    UpdateOrgProjectInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type:
          - string
          - 'null'
          maxLength: 2000
        category:
          type: string
          enum:
          - HEALTHCARE
          - FINANCIAL
          - RETAIL
          - HOSPITALITY
          - AUTOMOTIVE
          - GOVERNMENT
          - EDUCATION
          - REAL_ESTATE
          - OTHER
    ListOrgProjectsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrgProject'
        pagination:
          type: object
          properties:
            page:
              type: integer
            limit:
              type: integer
            count:
              type: integer
          required:
          - page
          - limit
          - count
      required:
      - data
      - pagination
    DeleteOrgResourceResponse:
      type: object
      properties:
        id:
          type: string
        deleted:
          type: boolean
          const: true
      required:
      - id
      - deleted
    CreateOrgProjectInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Human-readable project name
          example: Voice VA - prod
        description:
          type: string
          maxLength: 2000
        category:
          type: string
          enum:
          - HEALTHCARE
          - FINANCIAL
          - RETAIL
          - HOSPITALITY
          - AUTOMOTIVE
          - GOVERNMENT
          - EDUCATION
          - REAL_ESTATE
          - OTHER
          description: Defaults to OTHER
        dataStorageRegion:
          type: string
          enum:
          - US_EAST_1
          - EU_WEST_1
          description: Defaults to US_EAST_1
      required:
      - name
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
          - validation
          - authentication
          - forbidden
          - not_found
          - conflict
          - payment_required
          - rate_limit
          - internal
          description: The error type category
          examples:
          - validation
          - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
          - invalid_parameter
          - missing_required_field
          - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
          - The request was invalid
          - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
          - email
          - user_id
        details:
          description: Additional error context information
      required:
      - type
      - code
      - message
    OrgProject:
      type: object
      properties:
        id:
          type: string
          description: Project id
        organizationId:
          type: string
        name:
          type: string
        slug:
          type: string
          description: URL-safe slug, generated from the name at create time
        description:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
          enum:
          - HEALTHCARE
          - FINANCIAL
          - RETAIL
          - HOSPITALITY
          - AUTOMOTIVE
          - GOVERNMENT
          - EDUCATION
          - REAL_ESTATE
          - OTHER
        dataStorageRegion:
          type: string
          enum:
          - US_EAST_1
          - EU_WEST_1
        retentionDays:
          type:
          - integer
          - 'null'
        retentionMode:
          type: string
          enum:
          - SOFT_DELETE
          - HARD_DELETE
        configKey:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          description: ISO 8601 timestamp
        updatedAt:
          type: string
          description: ISO 8601 timestamp
      required:
      - id
      - organizationId
      - name
      - slug
      - description
      - category
      - dataStorageRegion
      - retentionDays
      - retentionMode
      - configKey
      - createdAt
      - updatedAt
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT