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

# Get the assigned order form

> Returns the issued order form document, its signing status and prefilled organisation details. Responds with `assigned: false` (not 404) when no form has been issued.



## OpenAPI

````yaml GET /v1/api/order-form
openapi: 3.1.0
info:
  title: PN Player API
  description: >-
    Manage videos, captions, playlists, tags, analytics, team members and
    account settings for your PN Player account.


    All `/v1/api` endpoints accept either an API key in the `X-Auth-Token`
    header or a JWT in the `Authorization: Bearer` header. Most endpoints also
    require the calling user to hold a specific role (scope): `READ_MEDIA`,
    `UPDATE_MEDIA`, `READ_ANALYTICS`, `READ_BILLING`, `READ_SETTINGS`,
    `UPDATE_SETTINGS` or `UPDATE_USERS`. The required scope is noted on each
    endpoint.
  version: 2.0.0
servers:
  - url: https://api.pnplayer.com
security:
  - apiKeyAuth: []
  - bearerAuth: []
tags:
  - name: Authentication
    description: >-
      Obtain a session token or reset a password. These endpoints do not require
      authentication.
  - name: Videos
    description: Create, list, update and delete videos.
  - name: Captions
    description: Upload, download, transcribe and manage caption tracks for a video.
  - name: Playlists
    description: Manual and rule-based (dynamic) playlists.
  - name: Tags
    description: Account-level tags that can be attached to videos.
  - name: Analytics
    description: Playback, engagement and usage metrics.
  - name: Reports
    description: Saved analytics report links.
  - name: Account
    description: Team members and account-wide streaming and security settings.
  - name: Profile
    description: The authenticated user's own profile.
  - name: API keys
    description: Long-lived keys for programmatic access.
  - name: Webhooks
    description: Configure the HTTPS endpoint that receives signed event notifications.
  - name: Billing
    description: Plan, usage, invoices, expansion packs and billing address.
  - name: Transcription settings
    description: Per-account key/value settings for automatic transcription.
  - name: Feature requests
    description: Submit, upvote and discuss feature requests.
  - name: Agreements
    description: Data processing agreement (DPA) and enterprise order form signing.
paths:
  /v1/api/order-form:
    get:
      tags:
        - Agreements
      summary: Get the assigned order form
      description: >-
        Returns the issued order form document, its signing status and prefilled
        organisation details. Responds with `assigned: false` (not 404) when no
        form has been issued.
      responses:
        '200':
          description: Order form
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/OrderForm'
components:
  schemas:
    OrderForm:
      type: object
      properties:
        assigned:
          type: boolean
          description: >-
            `false` when no form has been issued; the remaining fields are then
            omitted
        assignmentId:
          type: integer
        formKey:
          type: string
        version:
          type: string
        status:
          type: string
          enum:
            - pending
            - signed
        document:
          type: object
          nullable: true
          description: >-
            The order form document (title, plan, provider, sections). `null` if
            the version is no longer in the catalog.
          additionalProperties: true
        signed:
          type: boolean
        acceptance:
          oneOf:
            - $ref: '#/components/schemas/OrderFormAcceptance'
            - type: 'null'
        previousAcceptances:
          type: array
          items:
            $ref: '#/components/schemas/OrderFormAcceptance'
        isOwner:
          type: boolean
        owner:
          type: object
          nullable: true
          properties:
            name:
              type: string
            email:
              type: string
              format: email
        prefill:
          type: object
          description: >-
            Organisation details prefilled from the DPA acceptance or billing
            address
          properties:
            orgName:
              type: string
            orgAddress:
              type: string
    OrderFormAcceptance:
      type: object
      properties:
        signerName:
          type: string
        signerEmail:
          type: string
          format: email
        orgName:
          type: string
        orgAddress:
          type: string
        formKey:
          type: string
        formVersion:
          type: string
        signedAt:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        API key created in the dashboard or via `POST /v1/api/api-keys`. Keys
        are prefixed `pn_` and do not expire until revoked.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Session token from `POST /auth/token`, valid for 24 hours.

````