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

# Check that the API is up

> No authentication needed.



## OpenAPI

````yaml https://api.formcarry.com/docs-json get /v1/health
openapi: 3.0.0
info:
  title: formcarry API
  description: >-
    Welcome to the formcarry API.


    Authenticate every request with an API key from your team's API page in the
    dashboard, sent as `Authorization: Bearer fc_live_...`.

    Requests and responses are JSON.


    Lists are paginated with a cursor: pass a response's `next_cursor` as
    `cursor` to get the next page, until `next_cursor` is null.


    Errors return a `code` you can act on and a `message` you can show. Every
    response includes an `X-Request-Id` header; quote it when you contact
    support.
  version: '1'
  contact: {}
servers:
  - url: https://api.formcarry.com
security: []
tags:
  - name: forms
    description: Your forms
  - name: submissions
    description: Submissions received by a form
  - name: me
    description: The key you are using
  - name: health
    description: Service status
paths:
  /v1/health:
    get:
      tags:
        - health
      summary: Check that the API is up
      description: No authentication needed.
      operationId: HealthController_health
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                example:
                  status: ok

````

## Related topics

- [Add a webhook](/docs/api-reference/forms/add-a-webhook.md)
- [v0](/docs/ai/v0.md)
- [Set Up Email Notifications for Your Forms](/docs/features/email-notifications.md)
- [ChatGPT](/docs/ai/chatgpt.md)
- [What every form needs](/docs/what-every-form-needs.md)