{
  "openapi": "3.1.0",
  "info": {
    "title": "RichLead Workspace API",
    "version": "1.0.0",
    "description": "Workspace-scoped lead and suppression CRUD. API keys are issued in Settings > API & webhooks. Production URLs omit trailing slashes. See /richlead-api-guide.html for webhook signing and CRM workflows."
  },
  "servers": [
    {
      "url": "https://richlead.site/backend/api/v1"
    }
  ],
  "security": [
    {
      "WorkspaceKey": []
    }
  ],
  "paths": {
    "/leads": {
      "get": {
        "operationId": "get_leads",
        "summary": "GET leads",
        "description": "Requires leads:read.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "integer"
                    },
                    "next": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "previous": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Lead"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "in": "query",
            "name": "search",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "email",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "source_system",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "external_id",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "interest",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "interested",
                "hot",
                "warm",
                "low_interest",
                "not_interested",
                "unknown"
              ]
            },
            "description": "interested includes hot leads. Uses current conversation evidence, not ICP fit. Invalid values return 400."
          }
        ]
      },
      "post": {
        "operationId": "post_leads",
        "summary": "POST leads",
        "description": "Requires leads:write.",
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lead"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          },
          {
            "in": "query",
            "name": "search",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "email",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "source_system",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "external_id",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Lead"
              }
            }
          }
        }
      }
    },
    "/leads/{id}": {
      "get": {
        "operationId": "get_leads_by_id",
        "summary": "GET leads by ID",
        "description": "Requires leads:read.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lead"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ]
      },
      "put": {
        "operationId": "put_leads_by_id",
        "summary": "PUT leads by ID",
        "description": "Requires leads:write.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lead"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Lead"
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "patch_leads_by_id",
        "summary": "PATCH leads by ID",
        "description": "Requires leads:write.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lead"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Lead"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "delete_leads_by_id",
        "summary": "DELETE leads by ID",
        "description": "Requires leads:delete.",
        "responses": {
          "204": {
            "description": "Success"
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ]
      }
    },
    "/suppression": {
      "get": {
        "operationId": "get_suppression",
        "summary": "GET suppression",
        "description": "Requires suppression:read.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "integer"
                    },
                    "next": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "previous": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Suppression"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ]
      },
      "post": {
        "operationId": "post_suppression",
        "summary": "POST suppression",
        "description": "Requires suppression:write.",
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Suppression"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Suppression"
              }
            }
          }
        }
      }
    },
    "/suppression/{id}": {
      "get": {
        "operationId": "get_suppression_by_id",
        "summary": "GET suppression by ID",
        "description": "Requires suppression:read.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Suppression"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ]
      },
      "put": {
        "operationId": "put_suppression_by_id",
        "summary": "PUT suppression by ID",
        "description": "Requires suppression:write.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Suppression"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Suppression"
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "patch_suppression_by_id",
        "summary": "PATCH suppression by ID",
        "description": "Requires suppression:write.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Suppression"
                }
              }
            }
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Suppression"
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "delete_suppression_by_id",
        "summary": "DELETE suppression by ID",
        "description": "Requires suppression:delete.",
        "responses": {
          "204": {
            "description": "Success"
          },
          "400": {
            "description": "Validation error"
          },
          "401": {
            "description": "Invalid key"
          },
          "403": {
            "description": "Missing scope"
          },
          "404": {
            "description": "Record not found in workspace"
          },
          "409": {
            "description": "Conflict"
          },
          "429": {
            "description": "Rate limited; honor Retry-After"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ]
      }
    },
    "/leads/upsert": {
      "post": {
        "operationId": "upsert_lead",
        "summary": "Create or update by stable external CRM ID",
        "description": "Requires leads:write. Repeating the same source_system/external_id does not duplicate a lead. A deleted mapping returns 409.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "source_system",
                  "external_id",
                  "lead"
                ],
                "properties": {
                  "source_system": {
                    "type": "string",
                    "maxLength": 64,
                    "pattern": "^[-a-zA-Z0-9_]+$"
                  },
                  "external_id": {
                    "type": "string",
                    "maxLength": 160
                  },
                  "lead": {
                    "$ref": "#/components/schemas/Lead"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Existing lead updated"
          },
          "201": {
            "description": "Lead created"
          },
          "400": {
            "description": "Validation error"
          },
          "409": {
            "description": "Deleted external record or conflict"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "WorkspaceKey": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "RichLead workspace API key"
      }
    },
    "schemas": {
      "Lead": {
        "type": "object",
        "required": [
          "name",
          "email"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true
          },
          "name": {
            "type": "string"
          },
          "company": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "niche": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "phone": {
            "type": "string"
          },
          "email_status": {
            "type": "string",
            "readOnly": true
          },
          "website": {
            "type": "string"
          },
          "linkedin_url": {
            "type": "string"
          },
          "industry": {
            "type": "string"
          },
          "location": {
            "type": "string"
          },
          "employee_count": {
            "type": [
              "integer",
              "null"
            ]
          },
          "funding_amount": {
            "type": "string"
          },
          "funding_round": {
            "type": "string"
          },
          "funding_data": {
            "type": "object",
            "additionalProperties": true
          },
          "source": {
            "type": "string"
          },
          "source_id": {
            "type": "string"
          },
          "campaign": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "reached",
              "replied",
              "blacklisted"
            ]
          },
          "icp_score": {
            "type": "integer",
            "readOnly": true
          },
          "created_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "readOnly": true
          },
          "first_sent_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "readOnly": true
          },
          "replied_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time",
            "readOnly": true
          },
          "outreach_sender_email": {
            "type": "string",
            "readOnly": true
          },
          "custom_fields": {
            "type": "object",
            "maxProperties": 80,
            "additionalProperties": true,
            "description": "Workspace custom fields. Lowercase underscore keys; up to 32 KB of JSON."
          },
          "interest": {
            "type": "string",
            "enum": [
              "interested",
              "hot",
              "warm",
              "low_interest",
              "not_interested",
              "unknown"
            ],
            "readOnly": true
          },
          "interest_score": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 100,
            "readOnly": true
          },
          "reply_intent": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "Suppression": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true
          },
          "email": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "reason": {
            "type": "string",
            "enum": [
              "manual",
              "unsubscribed",
              "bounced",
              "complained"
            ]
          },
          "note": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "Error": {
        "type": "object",
        "additionalProperties": true
      }
    }
  }
}