{
  "aid": "ziflow.com:main-v1",
  "name": "Ziflow API",
  "type": "Index",
  "description": " ## Welcome to the Ziflow API \n The Ziflow API is built to allow you to easily and quickly embed Ziflow’s proofing features in your own application or create an integration between Ziflow and any other application. This API is the same one we use to power Ziflow! \n The API is a RESTful interface, essentially providing programmatic access to the features and data in the system. If you’ve interacted with a RESTful API before, many of the concepts will be familiar - it provides predictable URLs for accessing resources and uses built-in HTTP features. \n  The API accepts JSON or form-encoded content in requests, and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.\n  ### Base domain \n API calls to Ziflow should be made to the https://api.ziflow.io/v1 . \n  ### Security & Authentication \n The Ziflow API is an SSL-only API. You must be a verified user to make API requests. Ziflow currently supports basic authentication using an API token. The API token can be found on your “Contact Details” page. To access, click on your avatar in the top right and select \"View Profile\". From there, click on \"API Key.\" \n\n We recommend using Header API  key parameter authentication method. \n  \n  ### JSON validation \n \n If you get some errors on POST or PUT requests, please use this <a href=\"https://jsonformatter.curiousconcept.com/\" target=\"_blank\" rel=\"noopener noreferrer\">JSON Validator</a> to check if your request's body is properly formatted. \n \n Code generation from the documentation is possible; however, we don't support any modifications or required fixes for output code. \n \n ### Possible response status codes:\n  | Status code | Description |\n|---|---|\n| 200 | Success |\n| 201 | Success |\n| 400 | Bad Request - JSON parse error |\n| 401 | Unauthorized |\n| 403 | Forbidden |\n| 405 | Method not allowed |\n| 404 | Not found |\n| 422 | Unprocessable Entity - validation exception |\n| 429 | Too many requests - you’ve exceeded the <a href=\"https://help.ziflow.com/hc/en-us/articles/46361971776020-API-rate-limits\" target=\"_blank\" rel=\"noopener noreferrer\">API rate limits</a> |",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/ziflow.com/main/v1/apis.json",
  "tags": [
    "ziflow.com",
    "main"
  ],
  "created": "2026-04-02",
  "modified": "2026-04-02",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "ziflow.com:main-v1",
      "name": "Ziflow API",
      "description": " ## Welcome to the Ziflow API \n The Ziflow API is built to allow you to easily and quickly embed Ziflow’s proofing features in your own application or create an integration between Ziflow and any other application. This API is the same one we use to power Ziflow! \n The API is a RESTful interface, essentially providing programmatic access to the features and data in the system. If you’ve interacted with a RESTful API before, many of the concepts will be familiar - it provides predictable URLs for accessing resources and uses built-in HTTP features. \n  The API accepts JSON or form-encoded content in requests, and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.\n  ### Base domain \n API calls to Ziflow should be made to the https://api.ziflow.io/v1 . \n  ### Security & Authentication \n The Ziflow API is an SSL-only API. You must be a verified user to make API requests. Ziflow currently supports basic authentication using an API token. The API token can be found on your “Contact Details” page. To access, click on your avatar in the top right and select \"View Profile\". From there, click on \"API Key.\" \n\n We recommend using Header API  key parameter authentication method. \n  \n  ### JSON validation \n \n If you get some errors on POST or PUT requests, please use this <a href=\"https://jsonformatter.curiousconcept.com/\" target=\"_blank\" rel=\"noopener noreferrer\">JSON Validator</a> to check if your request's body is properly formatted. \n \n Code generation from the documentation is possible; however, we don't support any modifications or required fixes for output code. \n \n ### Possible response status codes:\n  | Status code | Description |\n|---|---|\n| 200 | Success |\n| 201 | Success |\n| 400 | Bad Request - JSON parse error |\n| 401 | Unauthorized |\n| 403 | Forbidden |\n| 405 | Method not allowed |\n| 404 | Not found |\n| 422 | Unprocessable Entity - validation exception |\n| 429 | Too many requests - you’ve exceeded the <a href=\"https://help.ziflow.com/hc/en-us/articles/46361971776020-API-rate-limits\" target=\"_blank\" rel=\"noopener noreferrer\">API rate limits</a> |",
      "image": "https://ziflow-automation-testing.s3.us-east-1.amazonaws.com/logo/Ziflow+Developers.svg",
      "baseURL": "https://api.ziflow.io/v1",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/ziflow.com/main/v1",
      "version": "v1",
      "tags": [
        "ziflow.com",
        "main"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/ziflow.com/main/v1/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/ziflow.com/main/v1"
        }
      ]
    }
  ]
}