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

# Read a handover

> What a handover moves, its state, the workspaces the recipient can accept it into, and who keeps access.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json get /api/handovers/{id}/details
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/handovers/{id}/details:
    get:
      tags:
        - Apps
      summary: Read a handover
      description: >-
        What a handover moves, its state, the workspaces the recipient can
        accept it into, and who keeps access.
      operationId: get/api/handovers/:id/details
      parameters:
        - name: id
          in: path
          required: true
          description: The handover's id.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: A document id.
                  kind:
                    type: string
                    enum:
                      - app
                      - project
                  name:
                    type: string
                  sender:
                    type: string
                  fromWorkspace:
                    type: string
                  email:
                    type: string
                  expiresAt:
                    type: string
                    format: date-time
                  status:
                    type: string
                    enum:
                      - pending
                      - accepted
                      - cancelled
                      - expired
                  recipient:
                    type: boolean
                  workspaces:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: A document id.
                        name:
                          type: string
                      required:
                        - id
                        - name
                  toWorkspace:
                    anyOf:
                      - type: string
                      - type: 'null'
                  people:
                    type: array
                    items:
                      type: object
                      properties:
                        email:
                          type: string
                        level:
                          type: string
                          enum:
                            - use
                            - editor
                            - owner
                      required:
                        - email
                        - level
                  canRemove:
                    type: boolean
                required:
                  - id
                  - kind
                  - name
                  - sender
                  - fromWorkspace
                  - email
                  - expiresAt
                  - status
                  - recipient
                  - workspaces
                  - toWorkspace
                  - people
                  - canRemove
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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