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

# Get the environment's setup checklist

> What's left to go from a new environment to the first email sent: connect an email provider, create a workflow, then trigger it.



## OpenAPI

````yaml /openapi.json get /setup
openapi: 3.1.0
info:
  title: subscriber.dev API
  description: >-
    Trigger workflows, manage subscribers and send broadcasts. Authenticate with
    an API key in the X-API-Key header: the key decides the environment. Docs:
    https://docs.subscriber.dev
  version: '1.0'
  contact: {}
servers:
  - url: https://api.subscriber.dev
    description: Cloud
security: []
tags: []
paths:
  /setup:
    get:
      tags:
        - Environments
      summary: Get the environment's setup checklist
      description: >-
        What's left to go from a new environment to the first email sent:
        connect an email provider, create a workflow, then trigger it.
      operationId: getSetup
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limited. Wait a second and retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer: []
        - api-key:
            - analytics:read
components:
  schemas:
    SetupResponse:
      type: object
      properties:
        complete:
          type: boolean
          description: Every step is done.
        next:
          anyOf:
            - type: string
              enum:
                - email_provider
                - first_workflow
                - first_email_sent
            - type: 'null'
          description: The first step that isn't done yet, or null when complete.
        steps:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                enum:
                  - email_provider
                  - first_workflow
                  - first_email_sent
              title:
                type: string
              done:
                type: boolean
            required:
              - key
              - title
              - done
        suggestions:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
                enum:
                  - postal_address
                  - stripe
              title:
                type: string
              done:
                type: boolean
            required:
              - key
              - title
              - done
          description: Optional extras, worth offering once the steps are done.
      required:
        - complete
        - next
        - steps
        - suggestions
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        message:
          type: string
          example: Workflow not found
        error:
          type: string
          example: Not Found
        errors:
          description: Which fields failed validation, on a 400.
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
              code:
                type: string
            required:
              - path
              - message
      required:
        - statusCode
        - message
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
      description: >-
        A session token from `subscriber login`, used by subscriber.dev's own
        apps. Requests about an environment also need its ID in the
        `x-environment-id` header. From your own code, use an API key.
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: An environment API key. Keep it on your server.

````

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