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

# What the web onboarding starts a signature from



## OpenAPI

````yaml /api-reference/openapi.json get /v1/onboarding
openapi: 3.0.1
info:
  title: Scribe Public API
  version: v1
  description: >-
    REST API to manage email signatures, teammates, smart fields, and marketing
    campaigns in your Scribe workspace. Every request uses JSON and is
    authenticated with a workspace API key. Endpoints are versioned under `/v1`,
    for example `https://api.scribe-mail.com/v1/signatures`.
  contact:
    name: Scribe Support
    url: https://help.scribe-mail.com/en
servers:
  - url: https://api.scribe-mail.com
    description: Production
security: []
tags:
  - name: Signatures
    description: >-
      Create, update, publish, and install email signature templates, and
      control which teammates each signature is assigned to.
  - name: Teammates
    description: >-
      Manage the people whose signatures Scribe deploys, and set their smart
      field values.
  - name: Emails
    description: >-
      Manage teammate email addresses, including the aliases that receive a
      signature.
  - name: Smart fields
    description: >-
      Define the dynamic fields, such as job title, phone number, or calendar
      link, that populate signatures.
  - name: Folders
    description: Organize signature templates into folders.
  - name: Assets
    description: >-
      Upload and manage the images and files used across signatures and
      campaigns.
  - name: Marketing campaigns
    description: >-
      Schedule, pause, and resume the promotional banners shown in your team's
      signatures.
  - name: Integrations
    description: >-
      List the directory, HRIS, and email integrations connected to your
      workspace.
  - name: Integration entities
    description: >-
      List the org units and groups from your connected integrations, used to
      target signatures.
  - name: Financial documents
    description: List the invoices and financial documents for your workspace.
paths:
  /v1/onboarding:
    get:
      tags:
        - Onboarding
      summary: What the web onboarding starts a signature from
      responses:
        '200':
          description: A free-mail account has no company to look up
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/onboarding_response'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      security:
        - ApiKey: []
components:
  schemas:
    onboarding_response:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/onboarding'
      required:
        - data
      additionalProperties: false
    error_response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
        remediation:
          type: object
          description: >-
            Optional dashboard hand-off: where to send the user to unblock the
            request (e.g. connect an integration). Present on some 403/409
            responses.
          properties:
            action:
              type: string
              enum:
                - connect_integration
                - manage_in_dashboard
                - upgrade_plan
                - sign_up
            dashboard_url:
              type: string
              format: uri
            message:
              type: string
          required:
            - action
            - dashboard_url
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    onboarding:
      type: object
      properties:
        email:
          type: string
        has_signature:
          type: boolean
        person:
          type: object
          nullable: true
          properties:
            first_name:
              type: string
              nullable: true
            last_name:
              type: string
              nullable: true
            full_name:
              type: string
              nullable: true
            job_position:
              type: string
              nullable: true
          additionalProperties: false
        company:
          type: object
          nullable: true
          properties:
            name:
              type: string
              nullable: true
            website:
              type: string
              nullable: true
            phone_number:
              type: string
              nullable: true
            address:
              type: object
              nullable: true
            socials:
              type: object
              nullable: true
              additionalProperties:
                type: string
                nullable: true
            logos:
              type: array
              items:
                $ref: '#/components/schemas/onboarding_asset'
            banner:
              allOf:
                - $ref: '#/components/schemas/onboarding_asset'
              nullable: true
          additionalProperties: false
      required:
        - email
        - has_signature
        - person
        - company
      additionalProperties: false
    onboarding_asset:
      type: object
      properties:
        uuid:
          type: string
        url:
          type: string
          nullable: true
        width:
          type: integer
          nullable: true
        height:
          type: integer
          nullable: true
        accent_colors:
          type: array
          items:
            type: string
      required:
        - uuid
        - url
        - width
        - height
        - accent_colors
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer

````

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