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

# Get oauthapps



## OpenAPI

````yaml /openapi.json get /oauth/apps/{clientId}
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /oauth/apps/{clientId}:
    get:
      operationId: oauth.appPreview
      parameters:
        - name: clientId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: redirectUri
          in: query
          required: false
          schema:
            type: string
            description: >-
              If set, the response says whether this exact URI is registered for
              the app, so the consent screen can refuse before redirecting
              anywhere
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  clientId:
                    type: string
                  name:
                    type: string
                  description:
                    anyOf:
                      - type: string
                      - type: 'null'
                  iconUrl:
                    anyOf:
                      - type: string
                        format: uri
                      - type: 'null'
                  homepageUrl:
                    anyOf:
                      - type: string
                        format: uri
                      - type: 'null'
                  privacyPolicyUrl:
                    anyOf:
                      - type: string
                        format: uri
                      - type: 'null'
                  termsOfServiceUrl:
                    anyOf:
                      - type: string
                        format: uri
                      - type: 'null'
                  ownerOrgName:
                    anyOf:
                      - type: string
                      - type: 'null'
                    description: Display name of the org that registered the app
                  approved:
                    type: boolean
                  status:
                    enum:
                      - PENDING_REVIEW
                      - APPROVED
                      - SUSPENDED
                    type: string
                    description: >-
                      APPROVED: vetted by Anima. PENDING_REVIEW: not vetted,
                      which every self-registered client starts as. SUSPENDED:
                      refused everywhere: no new codes, no refreshes, and its
                      live access tokens stop working.
                  redirectUriRegistered:
                    type: boolean
                    description: >-
                      Present when redirectUri was passed: whether it exactly
                      matches one of the app's registered redirect URIs
                required:
                  - clientId
                  - name
                  - description
                  - iconUrl
                  - homepageUrl
                  - privacyPolicyUrl
                  - termsOfServiceUrl
                  - ownerOrgName
                  - approved
                  - status
                description: Public-safe OAuth app metadata for the consent screen
        '404':
          description: '404'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: NOT_FOUND
                      status:
                        const: 404
                      message:
                        type: string
                        default: Not Found
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

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