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

# Get Study External Panel

> Get the external-panel entry link and outcome redirects for an owned BYOP study.



## OpenAPI

````yaml /api-reference/openapi.json get /api/public/v1/studies/{study_id}/external-panel
openapi: 3.1.0
info:
  title: User Intuition Public API
  description: >-
    ## Public Integration API


    Programmatic access to User Intuition for external integrators: manage
    studies, participants, interviews, reports, and panels.


    ### Authentication


    All endpoints require a Bearer token — either an API key (prefixed `ui_sk_`,
    created in the dashboard) or a dashboard JWT:


    ```

    Authorization: Bearer <ui_sk_… or JWT>

    ```


    ### Base URLs


    - **Production:** `https://api.userintuition.ai`

    - **Staging:** `https://staging.userintuition.ai`


    ### Support


    For API support, contact support@userintuition.ai
  version: 1.0.0
  contact:
    name: User Intuition Support
    email: support@userintuition.ai
servers:
  - url: https://api.userintuition.ai
    description: Production
  - url: https://staging.userintuition.ai
    description: Staging
security:
  - BearerAuth: []
paths:
  /api/public/v1/studies/{study_id}/external-panel:
    get:
      tags:
        - public-external-panels
      summary: Get Study External Panel
      description: >-
        Get the external-panel entry link and outcome redirects for an owned
        BYOP study.
      operationId: getStudyExternalPanel
      parameters:
        - name: study_id
          in: path
          required: true
          schema:
            type: string
            title: Study Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExternalPanelConfig'
        '422':
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
        default:
          description: Public API error. X-Request-ID matches error.request_id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiErrorResponse'
components:
  schemas:
    PublicExternalPanelConfig:
      properties:
        provider:
          type: string
          enum:
            - prolific
            - cint
            - cloudresearch
            - terac
            - custom
          title: Provider
          default: custom
        respondent_id_param:
          type: string
          title: Respondent Id Param
          default: respondent_id
        respondent_id_placeholder:
          type: string
          title: Respondent Id Placeholder
          default: '{{RESPONDENT_ID}}'
        session_id_param:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id Param
        session_id_placeholder:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id Placeholder
        external_study_id_param:
          anyOf:
            - type: string
            - type: 'null'
          title: External Study Id Param
        external_study_id_placeholder:
          anyOf:
            - type: string
            - type: 'null'
          title: External Study Id Placeholder
        complete_redirect_url:
          type: string
          title: Complete Redirect Url
        screenout_redirect_url:
          type: string
          title: Screenout Redirect Url
        quota_full_redirect_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Quota Full Redirect Url
        technical_redirect_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Technical Redirect Url
        id:
          type: string
          title: Id
        study_id:
          type: string
          title: Study Id
        entry_url:
          type: string
          title: Entry Url
      type: object
      required:
        - complete_redirect_url
        - screenout_redirect_url
        - id
        - study_id
        - entry_url
      title: PublicExternalPanelConfig
    PublicApiErrorResponse:
      type: object
      required:
        - detail
        - error
      properties:
        detail:
          description: Legacy error detail; may be a string, list, or object.
        error:
          $ref: '#/components/schemas/PublicApiError'
    PublicApiError:
      type: object
      required:
        - code
        - message
        - field
        - request_id
        - outcome
        - recovery_action
        - docs_url
      properties:
        code:
          type: string
        message:
          type: string
        field:
          anyOf:
            - type: string
            - type: 'null'
        request_id:
          type: string
          format: uuid
        outcome:
          type: string
          enum:
            - not_started
            - failed
            - unknown
        recovery_action:
          type: string
        docs_url:
          type: string
          format: uri
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with an API key (prefixed `ui_sk_`) or a JWT token from the
        dashboard.

````