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

# Get app (poll registration)

> Returns a single app including registrationStatus. COMPLETED, FAILED, and CANCELLED are terminal.



## OpenAPI

````yaml /api-reference/openapi.yaml get /apps/{appId}
openapi: 3.1.1
info:
  title: Perfai Security API
  version: 1.1.0
  description: >
    Partner-facing REST API for automating Perfai security testing: register
    apps, trigger security tests and vision (browser-automation) runs, poll run
    status, and retrieve vulnerability findings. All endpoints are
    JWT-authenticated and scoped to the caller's organization; cross-tenant
    access returns 404 (never 403) to prevent enumeration. Errors follow RFC
    9457 Problem Details.
servers:
  - url: https://api.perfai.ai/v1
    description: Perfai cloud
  - url: https://api.{customerDomain}/v1
    description: On-premise deployment
    variables:
      customerDomain:
        default: example.com
security:
  - bearerAuth: []
tags:
  - name: Apps
    description: App catalog — list, register, and poll registration.
  - name: Security Agent
    description: Trigger security tests and poll their lifecycle.
  - name: Vision Agent
    description: >-
      Trigger vision (browser-automation) runs and poll their lifecycle. Always
      browserless.
  - name: Vulnerabilities
    description: Retrieve security findings.
  - name: Reports
    description: List an app's security reports and download them as PDF.
  - name: Tasks
    description: Poll any asynchronous operation started by this API.
paths:
  /apps/{appId}:
    get:
      tags:
        - Apps
      summary: Get app (poll registration)
      description: >-
        Returns a single app including registrationStatus. COMPLETED, FAILED,
        and CANCELLED are terminal.
      operationId: getApp
      parameters:
        - $ref: '#/components/parameters/AppId'
      responses:
        '200':
          description: The app.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    AppId:
      name: appId
      in: path
      required: true
      schema:
        type: string
      description: MongoDB ObjectId of the app (from GET /apps or POST /apps).
  schemas:
    AppDetail:
      $ref: '#/components/schemas/AppSummary'
    AppSummary:
      type: object
      properties:
        appId:
          type: string
        label:
          type: string
        appUrl:
          type: string
        basePath:
          type: string
        registrationStatus:
          $ref: '#/components/schemas/RegistrationStatus'
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        scheduleType:
          type: string
          enum:
            - none
            - nightly
            - custom
            - weekly_saturday
            - biweekly_saturday
            - monthly_first
          description: >
            How often this app is re-tested automatically. Apps inherit your
            organization default at registration and fall back to `nightly`, so
            an app may be on a recurring cadence you did not request here — each
            run consumes credits. Change it in the console (Edit app); this API
            does not set it, matching the console prompt.
          example: nightly
    Problem:
      type: object
      description: RFC 9457 Problem Details.
      properties:
        type:
          type: string
          description: Error type URI, e.g. https://perfai.ai/errors/app-already-registered
        title:
          type: string
      additionalProperties: true
    RegistrationStatus:
      type: string
      enum:
        - PENDING
        - IN_PROGRESS
        - COMPLETED
        - FAILED
        - CANCELLED
      description: Onboarding state. COMPLETED, FAILED, and CANCELLED are terminal.
  responses:
    Unauthorized:
      description: Missing or expired JWT.
    NotFound:
      description: Resource not found or belongs to a different tenant.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT login token tied to your Perfai user (not a separate API key).
        Obtain it via POST /api/v1/auth/token with your username and password
        (use the returned id_token) — the same login the web console performs.
        Carries org, user, and role; short-lived.

````