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

# List the provider app registrations

> Each provider's app, setup steps, and the redirect URL to register. No secrets.



## OpenAPI

````yaml get /api/documents/sources/apps
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/documents/sources/apps:
    get:
      tags:
        - Document imports
      summary: List the provider app registrations
      description: >-
        Each provider's app, setup steps, and the redirect URL to register. No
        secrets.
      operationId: list_apps_api_documents_sources_apps_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AppStatus'
                type: array
                title: Response List Apps Api Documents Sources Apps Get
        '403':
          description: Needs a personal sign-in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Unknown source, or not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The source isn't set up, or you need to connect (again).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    AppStatus:
      properties:
        provider:
          type: string
          enum:
            - google
            - microsoft
            - atlassian
            - notion
          title: Provider
        label:
          type: string
          title: Label
        sources:
          items:
            type: string
          type: array
          title: Sources
          description: The sources this app opens.
        configured:
          type: boolean
          title: Configured
        enabled:
          type: boolean
          title: Enabled
          default: false
        client_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Client Id
        secret_set:
          type: boolean
          title: Secret Set
          description: Whether a secret is stored.
          default: false
        settings:
          additionalProperties:
            type: string
          type: object
          title: Settings
        connected_people:
          type: integer
          title: Connected People
          description: People signed in with it.
          default: 0
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated By
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
        redirect_uri:
          anyOf:
            - type: string
            - type: 'null'
          title: Redirect Uri
          description: Register this as the app's redirect URL.
        redirect_error:
          anyOf:
            - type: string
            - type: 'null'
          title: Redirect Error
          description: Why the redirect URL isn't known.
        console_url:
          type: string
          title: Console Url
        setup_steps:
          items:
            type: string
          type: array
          title: Setup Steps
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        setting_names:
          items:
            type: string
          type: array
          title: Setting Names
          description: Settings besides the client id.
      type: object
      required:
        - provider
        - label
        - sources
        - configured
        - console_url
        - setup_steps
        - scopes
        - setting_names
      title: AppStatus
      description: A provider's app registration, for document admins. No secret.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: A brief description of the error that occurred.
        code:
          type: integer
          title: Code
          description: The HTTP status code associated with the error.
          default: 500
      type: object
      required:
        - error
      title: ErrorResponse
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.