{
  "openapi": "3.1.0",
  "info": {
    "title": "NavaPrastha API",
    "version": "2026-11-10",
    "description": "Connect your own CRM or software to your NavaPrastha employees: add leads, place calls, run campaigns, read conversations and appointments, and receive signed webhooks. Read the guide at https://navaprastha.in/docs/api/.",
    "contact": {
      "email": "bodavulasiddardha@navaprastha.in"
    }
  },
  "servers": [
    {
      "url": "https://navaprastha.in/api/v1"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Account",
      "description": "Who the key belongs to, the wallet, the numbers and the employees on the account. Every key, including a read-only one, can use these."
    },
    {
      "name": "Leads",
      "description": "A lead is a person in your CRM. If a lead with the same externalId or phone number exists, it is updated, not duplicated."
    },
    {
      "name": "Calls",
      "description": "A call is one request to call one person from your own number. It follows every rule that calls follow in the dashboard: calling hours, do-not-call, consent and credit."
    },
    {
      "name": "Campaigns",
      "description": "A campaign calls a whole list within the allowed hours and tries again with people who did not pick up. Everyone on it must have agreed to hear from you."
    },
    {
      "name": "Do not call",
      "description": "A number on your do-not-call list is never called by a call, a campaign or the API. People who say \"stop calling\" on a call are added automatically."
    },
    {
      "name": "Conversations and bookings",
      "description": "Every WhatsApp chat and every phone call is a conversation, and the appointments the employee booked are listed too. This is how your own software reads what the employee did."
    }
  ],
  "paths": {
    "/me": {
      "get": {
        "operationId": "get_me",
        "tags": [
          "Account"
        ],
        "summary": "Whose key this is and what it may do",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "workspace": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string"
                            },
                            "name": {
                              "type": "string"
                            },
                            "city": {
                              "type": "string"
                            }
                          }
                        },
                        "key": {
                          "type": "object",
                          "properties": {
                            "scope": {
                              "type": "string"
                            }
                          }
                        },
                        "apiVersion": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "workspace": {
                      "id": "w_8d21",
                      "name": "Dr Rao Clinic",
                      "city": "Eluru"
                    },
                    "key": {
                      "scope": "full"
                    },
                    "apiVersion": "v1"
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/balance": {
      "get": {
        "operationId": "get_balance",
        "tags": [
          "Account"
        ],
        "summary": "The wallet and the plans",
        "description": "balancePaise is the credit in paise (100 paise = ₹1). voiceTier is basic or premium.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "currency": {
                          "type": "string"
                        },
                        "balancePaise": {
                          "type": "integer"
                        },
                        "balance": {
                          "type": "integer"
                        },
                        "voiceTier": {
                          "type": "string"
                        },
                        "plans": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "product": {
                                "type": "string"
                              },
                              "status": {
                                "type": "string"
                              },
                              "renewsAt": {
                                "type": "integer"
                              },
                              "cancelsAtPeriodEnd": {
                                "type": "boolean"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "currency": "INR",
                    "balancePaise": 312000,
                    "balance": 3120,
                    "voiceTier": "basic",
                    "plans": [
                      {
                        "product": "clinic",
                        "status": "active",
                        "renewsAt": 1796730000,
                        "cancelsAtPeriodEnd": false
                      }
                    ]
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/numbers": {
      "get": {
        "operationId": "get_numbers",
        "tags": [
          "Account"
        ],
        "summary": "Your phone numbers and their lines",
        "description": "channels is how many calls can run at the same time on that number.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "number": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "channels": {
                            "type": "integer"
                          },
                          "createdAt": {
                            "type": "integer"
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "n_2b44c901",
                      "number": "+918012345678",
                      "status": "active",
                      "channels": 2,
                      "createdAt": 1793000000
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/employees": {
      "get": {
        "operationId": "get_employees",
        "tags": [
          "Account"
        ],
        "summary": "The products on your account and how they are set up",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "product": {
                            "type": "string"
                          },
                          "title": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "languages": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "greeting": {
                            "type": "string"
                          },
                          "businessHours": {
                            "type": "string"
                          },
                          "handoffContact": {
                            "type": "string"
                          },
                          "faqCount": {
                            "type": "integer"
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "product": "clinic",
                      "title": "Healthcare receptionist",
                      "status": "active",
                      "languages": [
                        "telugu",
                        "english"
                      ],
                      "greeting": "Namaskaram, Dr Rao Clinic.",
                      "businessHours": "Mon to Sat, 9 am to 6 pm",
                      "handoffContact": "+919848012345",
                      "faqCount": 12
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/leads": {
      "get": {
        "operationId": "get_leads",
        "tags": [
          "Leads"
        ],
        "summary": "List leads",
        "parameters": [
          {
            "name": "phone",
            "in": "query",
            "required": false,
            "description": "Only this number.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "externalId",
            "in": "query",
            "required": false,
            "description": "Only the lead with your own reference.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "new, contacted, qualified, booked or lost.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "How many items, 1 to 100. Default 50.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor from the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "phone": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "source": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "notes": {
                            "type": "string"
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "externalId": {
                            "type": "string"
                          },
                          "consent": {
                            "type": "boolean"
                          },
                          "dnc": {
                            "type": "boolean"
                          },
                          "lastCalledAt": {
                            "nullable": true
                          },
                          "lastOutcome": {
                            "type": "string"
                          },
                          "createdAt": {
                            "type": "integer"
                          },
                          "updatedAt": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "nextCursor": {
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "9f3c0a1b2c3d4e5f",
                      "name": "Ravi Kumar",
                      "phone": "+919848012345",
                      "email": "",
                      "source": "api",
                      "status": "new",
                      "notes": "",
                      "tags": [
                        "vip"
                      ],
                      "externalId": "crm-1042",
                      "consent": true,
                      "dnc": false,
                      "lastCalledAt": null,
                      "lastOutcome": "",
                      "createdAt": 1794135000,
                      "updatedAt": 1794135000
                    }
                  ],
                  "nextCursor": null
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "post_leads",
        "tags": [
          "Leads"
        ],
        "summary": "Add or update a lead",
        "description": "Returns 201 for a new lead and 200 when an existing one was updated. Only the fields you send are changed. Add a call object to place a call to the lead straight away (it needs consent: true).",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "Any unique text up to 80 characters. A repeat within 24 hours returns the first answer and does nothing twice.",
            "schema": {
              "type": "string",
              "maxLength": 80
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "phone": {
                    "type": "string"
                  },
                  "externalId": {
                    "type": "string"
                  },
                  "consent": {
                    "type": "boolean"
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "example": {
                "name": "Ravi Kumar",
                "phone": "98480 12345",
                "externalId": "crm-1042",
                "consent": true,
                "tags": [
                  "vip"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        },
                        "source": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "notes": {
                          "type": "string"
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "externalId": {
                          "type": "string"
                        },
                        "consent": {
                          "type": "boolean"
                        },
                        "dnc": {
                          "type": "boolean"
                        },
                        "lastCalledAt": {
                          "nullable": true
                        },
                        "lastOutcome": {
                          "type": "string"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "updatedAt": {
                          "type": "integer"
                        }
                      }
                    },
                    "call": {
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "9f3c0a1b2c3d4e5f",
                    "name": "Ravi Kumar",
                    "phone": "+919848012345",
                    "email": "",
                    "source": "api",
                    "status": "new",
                    "notes": "",
                    "tags": [
                      "vip"
                    ],
                    "externalId": "crm-1042",
                    "consent": true,
                    "dnc": false,
                    "lastCalledAt": null,
                    "lastOutcome": "",
                    "createdAt": 1794135000,
                    "updatedAt": 1794135000
                  },
                  "call": null
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/leads/{id}": {
      "get": {
        "operationId": "get_leads_By_id",
        "tags": [
          "Leads"
        ],
        "summary": "Read one lead",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        },
                        "source": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "notes": {
                          "type": "string"
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "externalId": {
                          "type": "string"
                        },
                        "consent": {
                          "type": "boolean"
                        },
                        "dnc": {
                          "type": "boolean"
                        },
                        "lastCalledAt": {
                          "nullable": true
                        },
                        "lastOutcome": {
                          "type": "string"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "updatedAt": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "9f3c0a1b2c3d4e5f",
                    "name": "Ravi Kumar",
                    "phone": "+919848012345",
                    "email": "",
                    "source": "api",
                    "status": "new",
                    "notes": "",
                    "tags": [
                      "vip"
                    ],
                    "externalId": "crm-1042",
                    "consent": true,
                    "dnc": false,
                    "lastCalledAt": null,
                    "lastOutcome": "",
                    "createdAt": 1794135000,
                    "updatedAt": 1794135000
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "patch_leads_By_id",
        "tags": [
          "Leads"
        ],
        "summary": "Change some fields of a lead",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "status": {
                    "type": "string"
                  }
                }
              },
              "example": {
                "status": "qualified"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        },
                        "email": {
                          "type": "string"
                        },
                        "source": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "notes": {
                          "type": "string"
                        },
                        "tags": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "externalId": {
                          "type": "string"
                        },
                        "consent": {
                          "type": "boolean"
                        },
                        "dnc": {
                          "type": "boolean"
                        },
                        "lastCalledAt": {
                          "nullable": true
                        },
                        "lastOutcome": {
                          "type": "string"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "updatedAt": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "9f3c0a1b2c3d4e5f",
                    "name": "Ravi Kumar",
                    "phone": "+919848012345",
                    "email": "",
                    "source": "api",
                    "status": "qualified",
                    "notes": "",
                    "tags": [
                      "vip"
                    ],
                    "externalId": "crm-1042",
                    "consent": true,
                    "dnc": false,
                    "lastCalledAt": null,
                    "lastOutcome": "",
                    "createdAt": 1794135000,
                    "updatedAt": 1794135000
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/calls": {
      "post": {
        "operationId": "post_calls",
        "tags": [
          "Calls"
        ],
        "summary": "Place one call",
        "description": "Send either leadId or phone (a lead is made if there is none). purpose is reminder, followup, feedback or information. script is what the employee should say or ask. Add dryRun: true to see what would happen without calling anyone, making a lead or using credit.",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "Any unique text up to 80 characters. A repeat within 24 hours returns the first answer and does nothing twice.",
            "schema": {
              "type": "string",
              "maxLength": 80
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "phone": {
                    "type": "string"
                  },
                  "purpose": {
                    "type": "string"
                  },
                  "script": {
                    "type": "string"
                  },
                  "consent": {
                    "type": "boolean"
                  }
                }
              },
              "example": {
                "phone": "98480 12345",
                "purpose": "reminder",
                "script": "Remind about tomorrow at 11 am.",
                "consent": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "leadId": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "51d8c2e07a9b4f63",
                    "status": "queued",
                    "leadId": "9f3c0a1b2c3d4e5f"
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "get_calls",
        "tags": [
          "Calls"
        ],
        "summary": "The latest calls",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "How many, 1 to 100. Default 50.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "direction": {
                            "type": "string"
                          },
                          "phone": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "answered": {
                            "type": "boolean"
                          },
                          "startedAt": {
                            "type": "integer"
                          },
                          "seconds": {
                            "type": "integer"
                          },
                          "outcome": {
                            "type": "string"
                          },
                          "campaignId": {
                            "nullable": true
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "51d8c2e07a9b4f63",
                      "direction": "out",
                      "phone": "+919848012345",
                      "status": "ended",
                      "answered": true,
                      "startedAt": 1794135600,
                      "seconds": 84,
                      "outcome": "completed",
                      "campaignId": null
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/calls/{id}": {
      "get": {
        "operationId": "get_calls_By_id",
        "tags": [
          "Calls"
        ],
        "summary": "One call, with its transcript and outcome",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "direction": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        },
                        "answered": {
                          "type": "boolean"
                        },
                        "startedAt": {
                          "type": "integer"
                        },
                        "endedAt": {
                          "type": "integer"
                        },
                        "seconds": {
                          "type": "integer"
                        },
                        "billedSeconds": {
                          "type": "integer"
                        },
                        "outcome": {
                          "type": "string"
                        },
                        "campaignId": {
                          "nullable": true
                        },
                        "leadId": {
                          "type": "string"
                        },
                        "transcript": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "speaker": {
                                "type": "string"
                              },
                              "text": {
                                "type": "string"
                              },
                              "at": {
                                "type": "integer"
                              }
                            }
                          }
                        },
                        "status": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "51d8c2e07a9b4f63",
                    "direction": "out",
                    "phone": "+919848012345",
                    "answered": true,
                    "startedAt": 1794135600,
                    "endedAt": 1794135684,
                    "seconds": 84,
                    "billedSeconds": 90,
                    "outcome": "completed",
                    "campaignId": null,
                    "leadId": "9f3c0a1b2c3d4e5f",
                    "transcript": [
                      {
                        "speaker": "agent",
                        "text": "Hello Ravi, this is a reminder for tomorrow at 11 am.",
                        "at": 1794135603
                      },
                      {
                        "speaker": "person",
                        "text": "Yes, I will come.",
                        "at": 1794135611
                      }
                    ],
                    "status": "ended"
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/campaigns": {
      "get": {
        "operationId": "get_campaigns",
        "tags": [
          "Campaigns"
        ],
        "summary": "Your campaigns",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "purpose": {
                            "type": "string"
                          },
                          "script": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "numberId": {
                            "type": "string"
                          },
                          "windowStart": {
                            "type": "integer"
                          },
                          "windowEnd": {
                            "type": "integer"
                          },
                          "maxAttempts": {
                            "type": "integer"
                          },
                          "retryMinutes": {
                            "type": "integer"
                          },
                          "maxConcurrent": {
                            "type": "integer"
                          },
                          "consentAttested": {
                            "type": "boolean"
                          },
                          "createdAt": {
                            "type": "integer"
                          },
                          "startedAt": {
                            "type": "integer"
                          },
                          "finishedAt": {
                            "nullable": true
                          },
                          "stats": {
                            "nullable": true
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "c7a1e4d9b2f84a10",
                      "name": "April fee reminder",
                      "purpose": "reminder",
                      "script": "The April fee is due on the 10th.",
                      "status": "running",
                      "numberId": "n_2b44c901",
                      "windowStart": 600,
                      "windowEnd": 1080,
                      "maxAttempts": 2,
                      "retryMinutes": 120,
                      "maxConcurrent": 2,
                      "consentAttested": true,
                      "createdAt": 1794135000,
                      "startedAt": 1794135100,
                      "finishedAt": null,
                      "stats": null
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "post_campaigns",
        "tags": [
          "Campaigns"
        ],
        "summary": "Create a campaign, optionally with the people, and start it",
        "description": "windowStart and windowEnd are minutes after midnight, India time, between 540 (9 am) and 1260 (9 pm). Extra fields on a contact (like amount) are told to the employee on that person's call. consent must be true.",
        "parameters": [
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "Any unique text up to 80 characters. A repeat within 24 hours returns the first answer and does nothing twice.",
            "schema": {
              "type": "string",
              "maxLength": 80
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "purpose": {
                    "type": "string"
                  },
                  "script": {
                    "type": "string"
                  },
                  "consent": {
                    "type": "boolean"
                  },
                  "windowStart": {
                    "type": "integer"
                  },
                  "windowEnd": {
                    "type": "integer"
                  },
                  "maxAttempts": {
                    "type": "integer"
                  },
                  "contacts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        },
                        "amount": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "start": {
                    "type": "boolean"
                  }
                }
              },
              "example": {
                "name": "April fee reminder",
                "purpose": "reminder",
                "script": "The April fee is due on the 10th.",
                "consent": true,
                "windowStart": 600,
                "windowEnd": 1080,
                "maxAttempts": 2,
                "contacts": [
                  {
                    "name": "Anitha",
                    "phone": "98480 42345",
                    "amount": "5000"
                  }
                ],
                "start": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "purpose": {
                          "type": "string"
                        },
                        "script": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "numberId": {
                          "type": "string"
                        },
                        "windowStart": {
                          "type": "integer"
                        },
                        "windowEnd": {
                          "type": "integer"
                        },
                        "maxAttempts": {
                          "type": "integer"
                        },
                        "retryMinutes": {
                          "type": "integer"
                        },
                        "maxConcurrent": {
                          "type": "integer"
                        },
                        "consentAttested": {
                          "type": "boolean"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "startedAt": {
                          "type": "integer"
                        },
                        "finishedAt": {
                          "nullable": true
                        },
                        "stats": {
                          "type": "object",
                          "properties": {
                            "total": {
                              "type": "integer"
                            },
                            "byStatus": {
                              "type": "object",
                              "properties": {
                                "queued": {
                                  "type": "integer"
                                },
                                "done": {
                                  "type": "integer"
                                }
                              }
                            },
                            "remaining": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    },
                    "contacts": {
                      "type": "object",
                      "properties": {
                        "added": {
                          "type": "integer"
                        },
                        "duplicates": {
                          "type": "integer"
                        },
                        "dnc": {
                          "type": "integer"
                        },
                        "invalid": {
                          "type": "array",
                          "items": {}
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "c7a1e4d9b2f84a10",
                    "name": "April fee reminder",
                    "purpose": "reminder",
                    "script": "The April fee is due on the 10th.",
                    "status": "running",
                    "numberId": "n_2b44c901",
                    "windowStart": 600,
                    "windowEnd": 1080,
                    "maxAttempts": 2,
                    "retryMinutes": 120,
                    "maxConcurrent": 2,
                    "consentAttested": true,
                    "createdAt": 1794135000,
                    "startedAt": 1794135100,
                    "finishedAt": null,
                    "stats": {
                      "total": 40,
                      "byStatus": {
                        "queued": 28,
                        "done": 12
                      },
                      "remaining": 28
                    }
                  },
                  "contacts": {
                    "added": 1,
                    "duplicates": 0,
                    "dnc": 0,
                    "invalid": []
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/campaigns/{id}": {
      "get": {
        "operationId": "get_campaigns_By_id",
        "tags": [
          "Campaigns"
        ],
        "summary": "Progress and counts",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "purpose": {
                          "type": "string"
                        },
                        "script": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "numberId": {
                          "type": "string"
                        },
                        "windowStart": {
                          "type": "integer"
                        },
                        "windowEnd": {
                          "type": "integer"
                        },
                        "maxAttempts": {
                          "type": "integer"
                        },
                        "retryMinutes": {
                          "type": "integer"
                        },
                        "maxConcurrent": {
                          "type": "integer"
                        },
                        "consentAttested": {
                          "type": "boolean"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "startedAt": {
                          "type": "integer"
                        },
                        "finishedAt": {
                          "nullable": true
                        },
                        "stats": {
                          "type": "object",
                          "properties": {
                            "total": {
                              "type": "integer"
                            },
                            "byStatus": {
                              "type": "object",
                              "properties": {
                                "queued": {
                                  "type": "integer"
                                },
                                "done": {
                                  "type": "integer"
                                }
                              }
                            },
                            "remaining": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "c7a1e4d9b2f84a10",
                    "name": "April fee reminder",
                    "purpose": "reminder",
                    "script": "The April fee is due on the 10th.",
                    "status": "running",
                    "numberId": "n_2b44c901",
                    "windowStart": 600,
                    "windowEnd": 1080,
                    "maxAttempts": 2,
                    "retryMinutes": 120,
                    "maxConcurrent": 2,
                    "consentAttested": true,
                    "createdAt": 1794135000,
                    "startedAt": 1794135100,
                    "finishedAt": null,
                    "stats": {
                      "total": 40,
                      "byStatus": {
                        "queued": 28,
                        "done": 12
                      },
                      "remaining": 28
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/campaigns/{id}/contacts": {
      "post": {
        "operationId": "post_campaigns_By_id_contacts",
        "tags": [
          "Campaigns"
        ],
        "summary": "Add people to a draft or paused campaign",
        "description": "Up to 1,000 people each time and 20,000 in a campaign. The answer counts added, duplicates, dnc and lists the invalid rows.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Idempotency-Key",
            "in": "header",
            "required": false,
            "description": "Any unique text up to 80 characters. A repeat within 24 hours returns the first answer and does nothing twice.",
            "schema": {
              "type": "string",
              "maxLength": 80
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "contacts": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "phone": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "example": {
                "contacts": [
                  {
                    "name": "Bhavya",
                    "phone": "98480 42346"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "added": {
                      "type": "integer"
                    },
                    "duplicates": {
                      "type": "integer"
                    },
                    "dnc": {
                      "type": "integer"
                    },
                    "invalid": {
                      "type": "array",
                      "items": {}
                    }
                  }
                },
                "example": {
                  "added": 1,
                  "duplicates": 0,
                  "dnc": 0,
                  "invalid": []
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/campaigns/{id}/start": {
      "post": {
        "operationId": "post_campaigns_By_id_start",
        "tags": [
          "Campaigns"
        ],
        "summary": "Start or resume a campaign",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "purpose": {
                          "type": "string"
                        },
                        "script": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "numberId": {
                          "type": "string"
                        },
                        "windowStart": {
                          "type": "integer"
                        },
                        "windowEnd": {
                          "type": "integer"
                        },
                        "maxAttempts": {
                          "type": "integer"
                        },
                        "retryMinutes": {
                          "type": "integer"
                        },
                        "maxConcurrent": {
                          "type": "integer"
                        },
                        "consentAttested": {
                          "type": "boolean"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "startedAt": {
                          "type": "integer"
                        },
                        "finishedAt": {
                          "nullable": true
                        },
                        "stats": {
                          "type": "object",
                          "properties": {
                            "total": {
                              "type": "integer"
                            },
                            "byStatus": {
                              "type": "object",
                              "properties": {
                                "queued": {
                                  "type": "integer"
                                },
                                "done": {
                                  "type": "integer"
                                }
                              }
                            },
                            "remaining": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "c7a1e4d9b2f84a10",
                    "name": "April fee reminder",
                    "purpose": "reminder",
                    "script": "The April fee is due on the 10th.",
                    "status": "running",
                    "numberId": "n_2b44c901",
                    "windowStart": 600,
                    "windowEnd": 1080,
                    "maxAttempts": 2,
                    "retryMinutes": 120,
                    "maxConcurrent": 2,
                    "consentAttested": true,
                    "createdAt": 1794135000,
                    "startedAt": 1794135100,
                    "finishedAt": null,
                    "stats": {
                      "total": 40,
                      "byStatus": {
                        "queued": 28,
                        "done": 12
                      },
                      "remaining": 28
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/campaigns/{id}/pause": {
      "post": {
        "operationId": "post_campaigns_By_id_pause",
        "tags": [
          "Campaigns"
        ],
        "summary": "Pause a running campaign",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "purpose": {
                          "type": "string"
                        },
                        "script": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        },
                        "numberId": {
                          "type": "string"
                        },
                        "windowStart": {
                          "type": "integer"
                        },
                        "windowEnd": {
                          "type": "integer"
                        },
                        "maxAttempts": {
                          "type": "integer"
                        },
                        "retryMinutes": {
                          "type": "integer"
                        },
                        "maxConcurrent": {
                          "type": "integer"
                        },
                        "consentAttested": {
                          "type": "boolean"
                        },
                        "createdAt": {
                          "type": "integer"
                        },
                        "startedAt": {
                          "type": "integer"
                        },
                        "finishedAt": {
                          "nullable": true
                        },
                        "stats": {
                          "type": "object",
                          "properties": {
                            "total": {
                              "type": "integer"
                            },
                            "byStatus": {
                              "type": "object",
                              "properties": {
                                "queued": {
                                  "type": "integer"
                                },
                                "done": {
                                  "type": "integer"
                                }
                              }
                            },
                            "remaining": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "id": "c7a1e4d9b2f84a10",
                    "name": "April fee reminder",
                    "purpose": "reminder",
                    "script": "The April fee is due on the 10th.",
                    "status": "paused",
                    "numberId": "n_2b44c901",
                    "windowStart": 600,
                    "windowEnd": 1080,
                    "maxAttempts": 2,
                    "retryMinutes": 120,
                    "maxConcurrent": 2,
                    "consentAttested": true,
                    "createdAt": 1794135000,
                    "startedAt": 1794135100,
                    "finishedAt": null,
                    "stats": {
                      "total": 40,
                      "byStatus": {
                        "queued": 28,
                        "done": 12
                      },
                      "remaining": 28
                    }
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/dnc": {
      "post": {
        "operationId": "post_dnc",
        "tags": [
          "Do not call"
        ],
        "summary": "Add a number",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "phone": {
                    "type": "string"
                  }
                }
              },
              "example": {
                "phone": "98480 12345"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "phone": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "phone": "+919848012345"
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/dnc/{phone}": {
      "delete": {
        "operationId": "delete_dnc_By_phone",
        "tags": [
          "Do not call"
        ],
        "summary": "Take a number off the list",
        "parameters": [
          {
            "name": "phone",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "ok": {
                          "type": "boolean"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "data": {
                    "ok": true
                  }
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/conversations": {
      "get": {
        "operationId": "get_conversations",
        "tags": [
          "Conversations and bookings"
        ],
        "summary": "List conversations",
        "description": "Most recent first.",
        "parameters": [
          {
            "name": "channel",
            "in": "query",
            "required": false,
            "description": "whatsapp or voice.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "open, handoff or closed.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "How many items, 1 to 100. Default 50.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor from the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "channel": {
                            "type": "string"
                          },
                          "contactPhone": {
                            "type": "string"
                          },
                          "contactName": {
                            "type": "string"
                          },
                          "leadId": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "lastMessageAt": {
                            "type": "integer"
                          },
                          "createdAt": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "nextCursor": {
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "cv_41a9",
                      "channel": "whatsapp",
                      "contactPhone": "+919848012345",
                      "contactName": "Ravi Kumar",
                      "leadId": "9f3c0a1b2c3d4e5f",
                      "status": "open",
                      "lastMessageAt": 1794139000,
                      "createdAt": 1794135000
                    }
                  ],
                  "nextCursor": null
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/conversations/{id}/messages": {
      "get": {
        "operationId": "get_conversations_By_id_messages",
        "tags": [
          "Conversations and bookings"
        ],
        "summary": "The messages of one conversation",
        "description": "Oldest first. direction is in or out. sender is customer, agent or human.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "How many items, 1 to 100. Default 50.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor from the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "direction": {
                            "type": "string"
                          },
                          "sender": {
                            "type": "string"
                          },
                          "body": {
                            "type": "string"
                          },
                          "createdAt": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "nextCursor": {
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "m_77",
                      "direction": "in",
                      "sender": "customer",
                      "body": "Doctor garu repu untara?",
                      "createdAt": 1794135000
                    },
                    {
                      "id": "m_78",
                      "direction": "out",
                      "sender": "agent",
                      "body": "Untaru. 11:00 AM ki slot undi.",
                      "createdAt": 1794135004
                    }
                  ],
                  "nextCursor": null
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/appointments": {
      "get": {
        "operationId": "get_appointments",
        "tags": [
          "Conversations and bookings"
        ],
        "summary": "Appointments the employee booked",
        "description": "when is exactly what the person asked for, for example \"tomorrow 11:00 AM\".",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "booked, cancelled or done.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "How many items, 1 to 100. Default 50.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "required": false,
            "description": "The nextCursor from the previous page.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "leadId": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "phone": {
                            "type": "string"
                          },
                          "service": {
                            "type": "string"
                          },
                          "when": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "source": {
                            "type": "string"
                          },
                          "createdAt": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "nextCursor": {
                      "nullable": true
                    }
                  }
                },
                "example": {
                  "data": [
                    {
                      "id": "ap_5",
                      "leadId": "9f3c0a1b2c3d4e5f",
                      "name": "Ravi Kumar",
                      "phone": "+919848012345",
                      "service": "General consultation",
                      "when": "tomorrow 11:00 AM",
                      "status": "booked",
                      "source": "whatsapp",
                      "createdAt": 1794135010
                    }
                  ],
                  "nextCursor": null
                }
              }
            }
          },
          "default": {
            "description": "An error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "An API key that starts with np_live_. Create one under Developers in your dashboard. A read-only key can use every GET endpoint."
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "requestId": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}
