{
  "openapi": "3.0.3",
  "info": {
    "title": "ReviewAsk API",
    "version": "1.0.0",
    "description": "Create, list, edit, and cancel Google review asks. Auth with Bearer ra_\u2026 (same key as Zapier).",
    "contact": {
      "email": "support@getreviewask.com"
    }
  },
  "servers": [
    {
      "url": "https://getreviewask.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "ra_"
      },
      "apiTokenHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Api-Token"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "ReviewRequest": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "object": {
            "type": "string",
            "enum": [
              "review_request"
            ]
          },
          "customer_name": {
            "type": "string"
          },
          "customer_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "customer_phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "channel": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "send_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "follow_up_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "followed_up_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "follow_up_cancelled_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    },
    {
      "apiTokenHeader": []
    }
  ],
  "paths": {
    "/account": {
      "get": {
        "summary": "Account summary",
        "responses": {
          "200": {
            "description": "Account"
          },
          "401": {
            "description": "Unauthorized"
          },
          "402": {
            "description": "No active plan"
          }
        }
      }
    },
    "/requests": {
      "get": {
        "summary": "List requests",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 50
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "status",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list"
          }
        }
      },
      "post": {
        "summary": "Create a request",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "phone": {
                    "type": "string"
                  },
                  "delay_hours": {
                    "type": "number",
                    "description": "0 = send now"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created"
          },
          "400": {
            "description": "Validation"
          },
          "402": {
            "description": "No plan"
          },
          "429": {
            "description": "Quota"
          }
        }
      }
    },
    "/requests/{id}": {
      "parameters": [
        {
          "name": "id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "integer"
          }
        }
      ],
      "get": {
        "summary": "Get one request",
        "responses": {
          "200": {
            "description": "OK"
          },
          "404": {
            "description": "Not found"
          }
        }
      },
      "patch": {
        "summary": "Edit a scheduled request",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "phone": {
                    "type": "string"
                  },
                  "delay_hours": {
                    "type": "number"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Updated"
          },
          "409": {
            "description": "Not scheduled"
          }
        }
      },
      "delete": {
        "summary": "Cancel ask or follow-up",
        "responses": {
          "200": {
            "description": "Cancelled"
          },
          "409": {
            "description": "Nothing to cancel"
          }
        }
      }
    },
    "/endpoints": {
      "get": {
        "summary": "Callback URL status (secret never returned)",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "put": {
        "summary": "Save callback URL (returns signing secret when new/rotated)",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Saved"
          }
        }
      },
      "delete": {
        "summary": "Clear callback URL",
        "responses": {
          "200": {
            "description": "Cleared"
          }
        }
      }
    },
    "/keys": {
      "post": {
        "summary": "Create or rotate API key (does not enable Zapier auto-asks)",
        "responses": {
          "200": {
            "description": "token"
          }
        }
      },
      "delete": {
        "summary": "Clear API key",
        "responses": {
          "200": {
            "description": "cleared"
          }
        }
      }
    }
  }
}