{ "info": { "name": "LeadX API", "description": "Every endpoint of the LeadX API key surface, generated from the router itself.\n\n**Setup.** Set the `apikey` collection variable to a key from `POST /api` (or the LeadX web app). `baseUrl` defaults to production.\n\n**Envelope.** Successful responses are `{ ok, success, message, data }`. List endpoints add `totalCount`, `p`, `n` and the sort actually applied at the top level, beside `data`.\n\n**Bulk writes return 200 with failures inside** — check `data.failed` and `data.errors` rather than trusting the status alone.\n\nRequest bodies are prefilled with each field's own default where the controller declares one, and left empty otherwise. Query parameters are added disabled: enable the ones you need.\n\nFull reference: https://docs.leadx.in", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.leadx.in", "type": "string" }, { "key": "apikey", "value": "", "type": "string" }, { "key": "jwt", "value": "", "type": "string" } ], "item": [ { "name": "CRM", "description": "Leads, contacts and everything that organises them.", "item": [ { "name": "Leads", "description": "13 endpoints.", "item": [ { "name": "GET /lead", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Lead objects in `data` (93 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /lead`" }, "response": [] }, { "name": "POST /lead", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contactId\": \"\",\n \"formData\": {},\n \"email\": \"\",\n \"contactNumber\": {},\n \"name\": \"\",\n \"work_phone_number\": \"\",\n \"whatsapp_contact_number\": \"\",\n \"source\": \"\",\n \"contactData\": {},\n \"skipInvalid\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Lead object in `data` (93 fields).\n\nErrors: `ContactNotFound_400`, `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`, `UniqueKeyInvalid_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /lead`" }, "response": [] }, { "name": "PUT /lead", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false,\n \"formData\": {},\n \"updateType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /lead`" }, "response": [] }, { "name": "DELETE /lead", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /lead`" }, "response": [] }, { "name": "GET /lead/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", ":id" ], "query": [ { "key": "populate", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Lead object in `data` (93 fields).\n\nErrors: `LeadNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /lead/:id`" }, "response": [] }, { "name": "PUT /lead/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": {},\n \"tags\": \"\",\n \"category\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", ":id" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Lead object in `data` (93 fields).\n\nErrors: `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`, `LeadNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /lead/:id`" }, "response": [] }, { "name": "POST /lead/bulk", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": \"\",\n \"contactId\": \"\",\n \"contactNumber\": \"\",\n \"work_phone_number\": \"\",\n \"whatsapp_contact_number\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"skipInvalid\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "bulk" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `ContactNotFound_400`, `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`, `UniqueKeyInvalid_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /lead/bulk`" }, "response": [] }, { "name": "GET /lead/import", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "import" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /lead/import`" }, "response": [] }, { "name": "POST /lead/import", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"headers\": \"\",\n \"totalCount\": \"\",\n \"columnMapping\": {},\n \"options\": {},\n \"tags\": [],\n \"category\": \"\",\n \"pauseImport\": true,\n \"userEnquiry\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "import" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `importType`, `fileId`.\n\nReturns one File object in `data` (20 fields).\n\nErrors: `EmptyFile_400`, `FileNotFound_400`, `NoRowsInFile_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /lead/import`" }, "response": [] }, { "name": "DELETE /lead/import", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "import" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /lead/import`" }, "response": [] }, { "name": "GET /lead/import/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead/import/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "import", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `id`.\n\nErrors: `ImportNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /lead/import/:id`" }, "response": [] }, { "name": "PUT /lead/import/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"columnMapping\": \"\",\n \"options\": \"\",\n \"tags\": \"\",\n \"category\": \"\",\n \"userEnquiry\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/import/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "import", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `id`.\n\nErrors: `ImportAlreadyPaused_400`, `ImportAlreadyRunning_400`, `ImportNotFound_400`, `InvalidImportStatus_400`, `NoRowsInFile_400`, `RowFromGreaterThanRowTo_400`, `RowFromOutOfRange_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /lead/import/:id`" }, "response": [] }, { "name": "POST /lead/lead-gen-ai", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"requestedCount\": 25,\n \"industry\": \"\",\n \"additionalFilters\": {},\n \"type\": \"contact\",\n \"aiType\": \"gemini\",\n \"enrich\": false,\n \"userEnquiryEnabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead/lead-gen-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead", "lead-gen-ai" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /lead/lead-gen-ai`" }, "response": [] } ] }, { "name": "Contacts", "description": "12 endpoints.", "item": [ { "name": "GET /contact", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Contact objects in `data` (106 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /contact`" }, "response": [] }, { "name": "POST /contact", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": {},\n \"tags\": \"\",\n \"category\": \"\",\n \"contactcategories\": \"\",\n \"existingError\": true,\n \"skipInvalid\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `countryCode`, `number`, `email`.\n\nReturns one Contact object in `data` (106 fields).\n\nErrors: `ContactAlreadyExists_400`, `ContactDataRequired_400`, `ContactNotFound_404`, `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /contact`" }, "response": [] }, { "name": "PUT /contact", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false,\n \"formData\": {},\n \"updateType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /contact`" }, "response": [] }, { "name": "DELETE /contact", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /contact`" }, "response": [] }, { "name": "GET /contact/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", ":id" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `ContactNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /contact/:id`" }, "response": [] }, { "name": "PUT /contact/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": {},\n \"tags\": \"\",\n \"contactCategory\": \"\",\n \"contactcategories\": \"\",\n \"category\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", ":id" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Contact object in `data` (106 fields).\n\nErrors: `CannotUpdateUniqueKey_400`, `ContactAlreadyExists_400`, `ContactNotFound_400`, `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /contact/:id`" }, "response": [] }, { "name": "POST /contact/bulk", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": \"\",\n \"tags\": \"\",\n \"category\": \"\",\n \"existingError\": true,\n \"skipInvalid\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "bulk" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `countryCode`, `number`, `email`.\n\nErrors: `ContactAlreadyExists_400`, `ContactDataRequired_400`, `ContactNotFound_404`, `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /contact/bulk`" }, "response": [] }, { "name": "GET /contact/import", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "import" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /contact/import`" }, "response": [] }, { "name": "POST /contact/import", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"headers\": \"\",\n \"totalCount\": \"\",\n \"columnMapping\": {},\n \"options\": {},\n \"tags\": [],\n \"category\": \"\",\n \"pauseImport\": true,\n \"userEnquiry\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "import" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `importType`, `fileId`.\n\nReturns one File object in `data` (20 fields).\n\nErrors: `EmptyFile_400`, `FileNotFound_400`, `NoRowsInFile_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /contact/import`" }, "response": [] }, { "name": "DELETE /contact/import", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "import" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /contact/import`" }, "response": [] }, { "name": "GET /contact/import/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact/import/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "import", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `id`.\n\nErrors: `ImportNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /contact/import/:id`" }, "response": [] }, { "name": "PUT /contact/import/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"columnMapping\": \"\",\n \"options\": \"\",\n \"tags\": \"\",\n \"category\": \"\",\n \"userEnquiry\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact/import/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact", "import", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `id`.\n\nErrors: `ImportAlreadyPaused_400`, `ImportAlreadyRunning_400`, `ImportNotFound_400`, `InvalidImportStatus_400`, `NoRowsInFile_400`, `RowFromGreaterThanRowTo_400`, `RowFromOutOfRange_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /contact/import/:id`" }, "response": [] } ] }, { "name": "Contact categories", "description": "4 endpoints.", "item": [ { "name": "GET /contact-category", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact-category", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact-category" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ContactCategory objects in `data` (8 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /contact-category`" }, "response": [] }, { "name": "POST /contact-category", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/contact-category", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact-category" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one ContactCategory object in `data` (8 fields).\n\nErrors: `ContactCategoryNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /contact-category`" }, "response": [] }, { "name": "GET /contact-category/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact-category/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact-category", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ContactCategory object in `data` (8 fields).\n\nErrors: `ContactCategoryNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /contact-category/:id`" }, "response": [] }, { "name": "PUT /contact-category/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/contact-category/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "contact-category", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ContactCategory object in `data` (8 fields).\n\nErrors: `ContactCategoryNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /contact-category/:id`" }, "response": [] } ] }, { "name": "Tags", "description": "4 endpoints.", "item": [ { "name": "GET /tag", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/tag", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "tag" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Tag objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /tag`" }, "response": [] }, { "name": "POST /tag", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/tag", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "tag" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Tag object in `data` (9 fields).\n\nErrors: `TagNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /tag`" }, "response": [] }, { "name": "GET /tag/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/tag/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "tag", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Tag object in `data` (9 fields).\n\nErrors: `TagNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /tag/:id`" }, "response": [] }, { "name": "PUT /tag/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/tag/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "tag", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Tag object in `data` (9 fields).\n\nErrors: `TagNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /tag/:id`" }, "response": [] } ] }, { "name": "Teams", "description": "4 endpoints.", "item": [ { "name": "GET /team", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/team", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "team" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /team`" }, "response": [] }, { "name": "POST /team", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"profileImage\": \"\",\n \"isDefault\": false,\n \"members\": \"\",\n \"assignType\": \"\",\n \"teamType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/team", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "team" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nErrors: `TeamNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /team`" }, "response": [] }, { "name": "GET /team/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/team/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "team", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `TeamNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /team/:id`" }, "response": [] }, { "name": "PUT /team/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/team/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "team", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `TeamNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /team/:id`" }, "response": [] } ] }, { "name": "Segments", "description": "6 endpoints.", "item": [ { "name": "GET /segment", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/segment", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Segment objects in `data` (29 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /segment`" }, "response": [] }, { "name": "POST /segment", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"filterType\": \"\",\n \"filters\": [],\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/segment", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Segment object in `data` (29 fields).\n\nErrors: `SegmentNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /segment`" }, "response": [] }, { "name": "DELETE /segment", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/segment", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /segment`" }, "response": [] }, { "name": "GET /segment/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/segment/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Segment object in `data` (29 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `SegmentNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /segment/:id`" }, "response": [] }, { "name": "PUT /segment/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/segment/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Segment object in `data` (29 fields).\n\nPopulated: `createdBy updatedBy`.\n\nDocs: https://docs.leadx.in/reference — `PUT /segment/:id`" }, "response": [] }, { "name": "GET /segment/execute", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/segment/execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "segment", "execute" ], "query": [ { "key": "ids", "value": "", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Segment object in `data` (29 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /segment/execute`" }, "response": [] } ] }, { "name": "Products & services", "description": "5 endpoints.", "item": [ { "name": "GET /product-service", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/product-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "product-service" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ProductService objects in `data` (28 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /product-service`" }, "response": [] }, { "name": "POST /product-service", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/product-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "product-service" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ProductService object in `data` (28 fields).\n\nErrors: `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`, `ProductServiceDataRequired_400`, `ProductServiceNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /product-service`" }, "response": [] }, { "name": "PUT /product-service", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false,\n \"formData\": {},\n \"updateType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/product-service", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "product-service" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /product-service`" }, "response": [] }, { "name": "GET /product-service/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/product-service/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "product-service", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ProductService object in `data` (28 fields).\n\nPopulated: `company createdBy updatedBy`.\n\nErrors: `ProductServiceNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /product-service/:id`" }, "response": [] }, { "name": "PUT /product-service/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formData\": {},\n \"tags\": \"\",\n \"category\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/product-service/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "product-service", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ProductService object in `data` (28 fields).\n\nErrors: `InvalidCustomFieldValue_400`, `InvalidCustomField_400`, `InvalidSystemField_400`, `ProductServiceNameAlreadyExists_400`, `ProductServiceNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /product-service/:id`" }, "response": [] } ] }, { "name": "Lead activity & follow-ups", "description": "6 endpoints.", "item": [ { "name": "GET /lead-activity", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of LeadActivity objects in `data` (35 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /lead-activity`" }, "response": [] }, { "name": "GET /lead-activity/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one LeadActivity object in `data` (35 fields).\n\nErrors: `LeadActivityNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /lead-activity/:id`" }, "response": [] }, { "name": "PATCH /lead-activity/:id/notes", "request": { "method": "PATCH", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity/:id/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity", ":id", "notes" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one LeadActivity object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `PATCH /lead-activity/:id/notes`" }, "response": [] }, { "name": "GET /lead-activity/follow-up", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity/follow-up", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity", "follow-up" ], "query": [ { "key": "lead", "value": "", "disabled": true }, { "key": "status", "value": "upcoming", "disabled": true }, { "key": "dateFrom", "value": "", "disabled": true }, { "key": "dateTo", "value": "", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FollowUp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /lead-activity/follow-up`" }, "response": [] }, { "name": "POST /lead-activity/follow-up", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lead\": \"\",\n \"type\": \"\",\n \"followUpAt\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"now\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity/follow-up", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity", "follow-up" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FollowUp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /lead-activity/follow-up`" }, "response": [] }, { "name": "PATCH /lead-activity/follow-up/:id", "request": { "method": "PATCH", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\",\n \"reason\": \"\",\n \"notes\": \"\",\n \"followUpAt\": \"\",\n \"type\": \"\",\n \"postponeTo\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/lead-activity/follow-up/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-activity", "follow-up", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FollowUp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `PATCH /lead-activity/follow-up/:id`" }, "response": [] } ] }, { "name": "Call logs", "description": "6 endpoints.", "item": [ { "name": "GET /calllog", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/calllog", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of CallLog objects in `data` (16 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /calllog`" }, "response": [] }, { "name": "POST /calllog", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/calllog", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CallLog object in `data` (16 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /calllog`" }, "response": [] }, { "name": "DELETE /calllog", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/calllog", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /calllog`" }, "response": [] }, { "name": "GET /calllog/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/calllog/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CallLog object in `data` (16 fields).\n\nPopulated: `lead`.\n\nErrors: `CallLogNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /calllog/:id`" }, "response": [] }, { "name": "PUT /calllog/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/calllog/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CallLog object in `data` (16 fields).\n\nErrors: `CallLogNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /calllog/:id`" }, "response": [] }, { "name": "POST /calllog/bulk", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/calllog/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "calllog", "bulk" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CallLog object in `data` (16 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /calllog/bulk`" }, "response": [] } ] }, { "name": "Meetings", "description": "3 endpoints.", "item": [ { "name": "GET /meeting", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/meeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "meeting" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ScheduleMeeting objects in `data` (42 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`, `contact`, `host`.\n\nDocs: https://docs.leadx.in/reference — `GET /meeting`" }, "response": [] }, { "name": "POST /meeting", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"provider\": \"offline\",\n \"app\": \"\",\n \"location\": \"\",\n \"mapLink\": \"\",\n \"meetingLink\": \"\",\n \"passcode\": \"\",\n \"timezone\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\",\n \"duration\": \"\",\n \"host\": \"\",\n \"contact\": \"\",\n \"lead\": \"\",\n \"attendees\": \"\",\n \"reminders\": \"\",\n \"recurrence\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/meeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "meeting" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `title`, `startTime`.\n\nReturns one ScheduleMeeting object in `data` (42 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /meeting`" }, "response": [] }, { "name": "GET /meeting/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/meeting/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "meeting", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ScheduleMeeting object in `data` (42 fields).\n\nPopulated: `lead`, `contact`, `host`, `app`.\n\nDocs: https://docs.leadx.in/reference — `GET /meeting/:id`" }, "response": [] } ] }, { "name": "Custom fields", "description": "8 endpoints.", "item": [ { "name": "GET /custom-field", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of CustomField objects in `data` (39 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nErrors: `InvalidPanel_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /custom-field`" }, "response": [] }, { "name": "POST /custom-field", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"section\": \"\",\n \"order\": \"\",\n \"description\": \"\",\n \"valueType\": \"\",\n \"fieldType\": \"\",\n \"required\": \"\",\n \"hide\": \"\",\n \"allowMultiple\": \"\",\n \"placeholder\": \"\",\n \"helpText\": \"\",\n \"defaultValue\": \"\",\n \"children\": \"\",\n \"options\": \"\",\n \"panel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `type`, `panel`.\n\nReturns one CustomField object in `data` (39 fields).\n\nErrors: `CustomFieldNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /custom-field`" }, "response": [] }, { "name": "DELETE /custom-field", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /custom-field`" }, "response": [] }, { "name": "GET /custom-field/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CustomField object in `data` (39 fields).\n\nErrors: `CustomFieldNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /custom-field/:id`" }, "response": [] }, { "name": "PUT /custom-field/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"section\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `id`, `panel`.\n\nReturns one CustomField object in `data` (39 fields).\n\nErrors: `CustomFieldNotFound_400`, `InvalidSectionId_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-field/:id`" }, "response": [] }, { "name": "PUT /custom-field/modify", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\",\n \"formData\": \"\",\n \"type\": \"all\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field/modify", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field", "modify" ], "query": [ { "key": "segmentFields", "value": "false", "disabled": true }, { "key": "onlyShowTable", "value": "false", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `panel`.\n\nReturns one CustomField object in `data` (39 fields).\n\nErrors: `CountryNotFound_400`, `StateNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-field/modify`" }, "response": [] }, { "name": "PUT /custom-field/reorder", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fields\": [],\n \"panel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field", "reorder" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-field/reorder`" }, "response": [] }, { "name": "PUT /custom-field/reset-system", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-field/reset-system", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-field", "reset-system" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `panel`.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `InvalidPanel_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-field/reset-system`" }, "response": [] } ] }, { "name": "Custom sections", "description": "6 endpoints.", "item": [ { "name": "GET /custom-section", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `panel`.\n\nReturns an array of CustomSection objects in `data` (11 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /custom-section`" }, "response": [] }, { "name": "POST /custom-section", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"panel\": \"\",\n \"description\": \"\",\n \"order\": \"\",\n \"hide\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `panel`.\n\nReturns one CustomSection object in `data` (11 fields).\n\nErrors: `CustomSectionNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /custom-section`" }, "response": [] }, { "name": "DELETE /custom-section", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false,\n \"filters\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoCustomSectionSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /custom-section`" }, "response": [] }, { "name": "GET /custom-section/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CustomSection object in `data` (11 fields).\n\nErrors: `CustomSectionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /custom-section/:id`" }, "response": [] }, { "name": "PUT /custom-section/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"panel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one CustomSection object in `data` (11 fields).\n\nErrors: `CustomSectionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-section/:id`" }, "response": [] }, { "name": "PUT /custom-section/reorder", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sections\": [],\n \"panel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/custom-section/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "custom-section", "reorder" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `PUT /custom-section/reorder`" }, "response": [] } ] } ] }, { "name": "Engagement", "description": "Campaigns, templates, AI Genie outreach, chat, widgets and forms.", "item": [ { "name": "Campaigns", "description": "17 endpoints.", "item": [ { "name": "GET /campaign", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Campaign objects in `data` (53 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `segments`, `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign`" }, "response": [] }, { "name": "POST /campaign", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"template\": \"\",\n \"segments\": [],\n \"smtp\": \"\",\n \"intervalMs\": \"\",\n \"daysOfWeek\": \"\",\n \"timeWindow\": \"\",\n \"scheduleType\": \"\",\n \"startAt\": \"\",\n \"endAt\": \"\",\n \"triggerWorkflow\": true,\n \"startCampaign\": false,\n \"customAudience\": \"\",\n \"customSegmentsBool\": false,\n \"segmentsBool\": false,\n \"tagsBool\": false,\n \"categoriesBool\": false,\n \"contactsBool\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `type`.\n\nErrors: `CampaignAudienceEmpty_400`, `CampaignNameAlreadyExists_400`, `CampaignSMTPNotBelongToCompany_400`, `CampaignSMTPNotFound_400`, `CampaignSMTPRequired_400`, `CampaignSegmentNotFound_400`, `CampaignSegmentsRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign`" }, "response": [] }, { "name": "DELETE /campaign", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /campaign`" }, "response": [] }, { "name": "GET /campaign/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignNotFound_404`, `UnsupportedCampaignType_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign/:id`" }, "response": [] }, { "name": "PUT /campaign/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"startCampaign\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignCannotBeUpdated_400`, `CampaignNotFound_404`, `CampaignSegmentsRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /campaign/:id`" }, "response": [] }, { "name": "POST /campaign/:id/assignTag", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/assignTag", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "assignTag" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignNotFound_404`, `NoCampaignSelected_400`, `TagNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/:id/assignTag`" }, "response": [] }, { "name": "PUT /campaign/:id/continue", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/continue", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "continue" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignCannotBeUpdated_400`, `CampaignFailedManyTime_400`, `CampaignNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /campaign/:id/continue`" }, "response": [] }, { "name": "GET /campaign/:id/logs", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "logs" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of UnifiedMessage objects in `data` (22 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `contact`, `template`, `app`, `updatedBy`, `createdBy`.\n\nErrors: `CampaignNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign/:id/logs`" }, "response": [] }, { "name": "PUT /campaign/:id/play-pause", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/play-pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "play-pause" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignCannotBeUpdated_400`, `CampaignNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /campaign/:id/play-pause`" }, "response": [] }, { "name": "GET /campaign/:id/recipients", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/recipients", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "recipients" ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "page", "value": "1", "disabled": true }, { "key": "limit", "value": "50", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign/:id/recipients`" }, "response": [] }, { "name": "POST /campaign/:id/retry-failed", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/retry-failed", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "retry-failed" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nErrors: `CampaignNotFound_404`, `NoCampaignSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/:id/retry-failed`" }, "response": [] }, { "name": "POST /campaign/:id/sync-failed", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/:id/sync-failed", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", ":id", "sync-failed" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Campaign object in `data` (53 fields).\n\nErrors: `CampaignNotFound_404`, `NoMessagesSent_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/:id/sync-failed`" }, "response": [] }, { "name": "POST /campaign/audience-preview", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"segments\": [],\n \"customAudience\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/audience-preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", "audience-preview" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/audience-preview`" }, "response": [] }, { "name": "GET /campaign/manual", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/manual", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", "manual" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of TempManualCampaign objects in `data` (28 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign/manual`" }, "response": [] }, { "name": "POST /campaign/manual", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"columnMapping\": \"\",\n \"templateName\": \"\",\n \"templateSubject\": \"\",\n \"campaignType\": \"\",\n \"campaignName\": \"\",\n \"file\": \"\",\n \"delaySeconds\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/manual", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", "manual" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one EmailTemplate object in `data` (15 fields).\n\nErrors: `InvalidCampaignType_400`, `InvalidMapping_400`, `InvalidPayload_400`, `NoFile_400`, `TemplateNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/manual`" }, "response": [] }, { "name": "GET /campaign/manual/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/manual/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", "manual", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one TempManualCampaign object in `data` (28 fields).\n\nErrors: `ManualCampaignNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /campaign/manual/:id`" }, "response": [] }, { "name": "POST /campaign/test/:type", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"smtp\": \"\",\n \"template\": \"\",\n \"testEmail\": \"\",\n \"testContactNumber\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/campaign/test/:type", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "campaign", "test", ":type" ], "variable": [ { "key": "type", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `EmailSendingFailed_500`, `EmailTemplateNotFound_404`, `InvalidCampaignType_400`, `MetaTemplateNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /campaign/test/:type`" }, "response": [] } ] }, { "name": "Templates", "description": "13 endpoints.", "item": [ { "name": "GET /template/category/:panel", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/template/category/:panel", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "category", ":panel" ], "variable": [ { "key": "panel", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `panel`.\n\nReturns one Category object in `data` (17 fields).\n\nErrors: `InvalidPanel_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /template/category/:panel`" }, "response": [] }, { "name": "GET /template/email", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/template/email", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of EmailTemplate objects in `data` (15 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /template/email`" }, "response": [] }, { "name": "POST /template/email", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"subject\": \"\",\n \"body\": \"\",\n \"category\": \"\",\n \"attachments\": [],\n \"variables\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/email", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `templateName`, `subject`, `body`.\n\nReturns one EmailTemplate object in `data` (15 fields).\n\nErrors: `TemplateNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /template/email`" }, "response": [] }, { "name": "DELETE /template/email", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/email", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /template/email`" }, "response": [] }, { "name": "GET /template/email/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/template/email/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one EmailTemplate object in `data` (15 fields).\n\nErrors: `EmailTemplateNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /template/email/:id`" }, "response": [] }, { "name": "PUT /template/email/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"subject\": \"\",\n \"body\": \"\",\n \"category\": \"\",\n \"attachments\": \"\",\n \"variables\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/email/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one EmailTemplate object in `data` (15 fields).\n\nErrors: `EmailTemplateNotFound_404`, `TemplateNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /template/email/:id`" }, "response": [] }, { "name": "POST /template/email/generate-ai", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"name\": \"\",\n \"category\": \"\",\n \"contactIds\": \"\",\n \"leadIds\": \"\",\n \"tone\": \"\",\n \"language\": \"\",\n \"aiType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/email/generate-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "email", "generate-ai" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /template/email/generate-ai`" }, "response": [] }, { "name": "GET /template/whatsapp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of MetaTemplate objects in `data` (41 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `app`.\n\nDocs: https://docs.leadx.in/reference — `GET /template/whatsapp`" }, "response": [] }, { "name": "POST /template/whatsapp", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"appID\": \"\",\n \"name\": \"\",\n \"appCategory\": \"\",\n \"language\": \"\",\n \"category\": \"\",\n \"bodyText\": \"\",\n \"expiry\": \"\",\n \"variables\": \"\",\n \"buttons\": [],\n \"headerType\": \"\",\n \"headerText\": \"\",\n \"headerFile\": \"\",\n \"footerText\": \"\",\n \"ttl\": \"\",\n \"addSecurity\": \"\",\n \"copyCodeText\": \"\",\n \"refIds\": [],\n \"defaults\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Category object in `data` (17 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /template/whatsapp`" }, "response": [] }, { "name": "DELETE /template/whatsapp", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /template/whatsapp`" }, "response": [] }, { "name": "GET /template/whatsapp/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MetaTemplate object in `data` (41 fields).\n\nPopulated: `app`.\n\nErrors: `WhatsAppTemplateNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /template/whatsapp/:id`" }, "response": [] }, { "name": "POST /template/whatsapp/generate-ai", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"name\": \"\",\n \"appID\": \"\",\n \"appCategory\": \"\",\n \"metaCategory\": \"\",\n \"language\": \"\",\n \"tone\": \"\",\n \"contactIds\": \"\",\n \"leadIds\": \"\",\n \"aiType\": \"\",\n \"components\": \"\",\n \"headerFile\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp/generate-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp", "generate-ai" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MetaTemplate object in `data` (41 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /template/whatsapp/generate-ai`" }, "response": [] }, { "name": "POST /template/whatsapp/status-reconcile", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tids\": \"\",\n \"syncAll\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/template/whatsapp/status-reconcile", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "template", "whatsapp", "status-reconcile" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `WhatsAppTemplateNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /template/whatsapp/status-reconcile`" }, "response": [] } ] }, { "name": "AI Genie", "description": "21 endpoints.", "item": [ { "name": "GET /genie", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of GenieScheduler objects in `data` (91 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /genie`" }, "response": [] }, { "name": "POST /genie", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"outreachPrompt\": \"\",\n \"tone\": \"\",\n \"aiType\": \"gemini\",\n \"type\": \"lead\",\n \"enrichmentEnabled\": false,\n \"count\": 25,\n \"industry\": \"\",\n \"additionalFilters\": {},\n \"userEnquiryEnabled\": true,\n \"campaign\": false,\n \"recurring\": false,\n \"intervalMs\": \"\",\n \"whitelistedCustom\": false,\n \"customWhitelistedDomains\": [],\n \"customChannelSelection\": false,\n \"customChannels\": {},\n \"outreachCadence\": {},\n \"draft\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/genie", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one GenieScheduler object in `data` (91 fields).\n\nErrors: `GeminiNotAvailableInPlan_400`, `MaximumLeadsExceeded_400`, `PromptRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /genie`" }, "response": [] }, { "name": "GET /genie/:schedulerId", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one GenieScheduler object in `data` (91 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /genie/:schedulerId`" }, "response": [] }, { "name": "DELETE /genie/:schedulerId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one GenieScheduler object in `data` (91 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /genie/:schedulerId`" }, "response": [] }, { "name": "POST /genie/:schedulerId/approve-all", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/approve-all", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "approve-all" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/approve-all`" }, "response": [] }, { "name": "POST /genie/:schedulerId/cancel", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "cancel" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/cancel`" }, "response": [] }, { "name": "POST /genie/:schedulerId/draft-all", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/draft-all", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "draft-all" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/draft-all`" }, "response": [] }, { "name": "POST /genie/:schedulerId/resume-recurring", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/resume-recurring", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "resume-recurring" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/resume-recurring`" }, "response": [] }, { "name": "POST /genie/:schedulerId/retry-failed", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/retry-failed", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "retry-failed" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/retry-failed`" }, "response": [] }, { "name": "POST /genie/:schedulerId/stop-recurring", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/:schedulerId/stop-recurring", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", ":schedulerId", "stop-recurring" ], "variable": [ { "key": "schedulerId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/:schedulerId/stop-recurring`" }, "response": [] }, { "name": "POST /genie/audience-preview", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contactIds\": [],\n \"leadIds\": [],\n \"segments\": \"\",\n \"tags\": \"\",\n \"categories\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/genie/audience-preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "audience-preview" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/audience-preview`" }, "response": [] }, { "name": "POST /genie/from-contacts", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contactIds\": [],\n \"leadIds\": [],\n \"segments\": \"\",\n \"tags\": \"\",\n \"categories\": \"\",\n \"prompt\": \"\",\n \"tone\": \"\",\n \"aiType\": \"gemini\",\n \"enrichmentEnabled\": false,\n \"draft\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/genie/from-contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "from-contacts" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /genie/from-contacts`" }, "response": [] }, { "name": "POST /genie/leads/:leadId/approve-all", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/leads/:leadId/approve-all", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "leads", ":leadId", "approve-all" ], "variable": [ { "key": "leadId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/leads/:leadId/approve-all`" }, "response": [] }, { "name": "POST /genie/leads/:leadId/draft-all", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/leads/:leadId/draft-all", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "leads", ":leadId", "draft-all" ], "variable": [ { "key": "leadId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/leads/:leadId/draft-all`" }, "response": [] }, { "name": "GET /genie/leads/:leadId/pending-approvals", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/leads/:leadId/pending-approvals", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "leads", ":leadId", "pending-approvals" ], "variable": [ { "key": "leadId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /genie/leads/:leadId/pending-approvals`" }, "response": [] }, { "name": "GET /genie/leads/:leadId/send-counts", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/leads/:leadId/send-counts", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "leads", ":leadId", "send-counts" ], "variable": [ { "key": "leadId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /genie/leads/:leadId/send-counts`" }, "response": [] }, { "name": "POST /genie/send-jobs/:sendJobId/approve", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/send-jobs/:sendJobId/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "send-jobs", ":sendJobId", "approve" ], "variable": [ { "key": "sendJobId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/send-jobs/:sendJobId/approve`" }, "response": [] }, { "name": "POST /genie/send-jobs/:sendJobId/draft", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/send-jobs/:sendJobId/draft", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "send-jobs", ":sendJobId", "draft" ], "variable": [ { "key": "sendJobId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one SendJob object in `data` (37 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /genie/send-jobs/:sendJobId/draft`" }, "response": [] }, { "name": "GET /genie/settings", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "settings" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /genie/settings`" }, "response": [] }, { "name": "PUT /genie/settings", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "settings" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /genie/settings`" }, "response": [] }, { "name": "GET /genie/templates/:templateId", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/genie/templates/:templateId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "genie", "templates", ":templateId" ], "variable": [ { "key": "templateId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /genie/templates/:templateId`" }, "response": [] } ] }, { "name": "Unified chat", "description": "3 endpoints.", "item": [ { "name": "GET /unified-chat", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/unified-chat", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "unified-chat" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one UnifiedMessage object in `data` (22 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /unified-chat`" }, "response": [] }, { "name": "GET /unified-chat/messages", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/unified-chat/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "unified-chat", "messages" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /unified-chat/messages`" }, "response": [] }, { "name": "POST /unified-chat/messages", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"contact\": \"\",\n \"messageType\": \"message\",\n \"content\": \"\",\n \"recipient_type\": \"individual\",\n \"mode\": \"whatsapp\",\n \"app\": \"\",\n \"appType\": \"\",\n \"recipientId\": \"\",\n \"senderId\": \"\",\n \"leadId\": \"\",\n \"scheduled\": \"\",\n \"scheduledAt\": \"\",\n \"contactSpecificMessage\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/unified-chat/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "unified-chat", "messages" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one UnifiedMessage object in `data` (22 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /unified-chat/messages`" }, "response": [] } ] }, { "name": "Conversations & handover", "description": "2 endpoints.", "item": [ { "name": "GET /conversation/handover", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/conversation/handover", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "conversation", "handover" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one botSession object in `data` (60 fields).\n\nErrors: `BadRequest_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /conversation/handover`" }, "response": [] }, { "name": "PUT /conversation/intercept", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/conversation/intercept", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "conversation", "intercept" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one botSession object in `data` (60 fields).\n\nErrors: `BadRequest_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /conversation/intercept`" }, "response": [] } ] }, { "name": "Chat widgets", "description": "9 endpoints.", "item": [ { "name": "GET /chat-widget", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ChatWidget objects in `data` (57 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /chat-widget`" }, "response": [] }, { "name": "POST /chat-widget", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"preChat\": \"\",\n \"appearance\": \"\",\n \"behaviour\": \"\",\n \"verification\": \"\",\n \"allowedDomains\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one ChatWidget object in `data` (57 fields).\n\nErrors: `ChatWidgetNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /chat-widget`" }, "response": [] }, { "name": "DELETE /chat-widget", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoChatWidgetSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /chat-widget`" }, "response": [] }, { "name": "GET /chat-widget/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ChatWidget object in `data` (57 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /chat-widget/:id`" }, "response": [] }, { "name": "PUT /chat-widget/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one ChatWidget object in `data` (57 fields).\n\nErrors: `ChatWidgetNameAlreadyExists_400`, `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /chat-widget/:id`" }, "response": [] }, { "name": "PUT /chat-widget/:id/rotate-token", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/:id/rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", ":id", "rotate-token" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ChatWidget object in `data` (57 fields).\n\nErrors: `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /chat-widget/:id/rotate-token`" }, "response": [] }, { "name": "GET /chat-widget/:id/sessions", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/:id/sessions", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", ":id", "sessions" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ChatWidgetSession objects in `data` (28 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `contact`.\n\nErrors: `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /chat-widget/:id/sessions`" }, "response": [] }, { "name": "PUT /chat-widget/:id/status", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", ":id", "status" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ChatWidget object in `data` (57 fields).\n\nErrors: `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /chat-widget/:id/status`" }, "response": [] }, { "name": "PUT /chat-widget/session/:sessionId/intercept", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/chat-widget/session/:sessionId/intercept", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "chat-widget", "session", ":sessionId", "intercept" ], "variable": [ { "key": "sessionId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one ChatWidgetSession object in `data` (28 fields).\n\nErrors: `ChatWidgetNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /chat-widget/session/:sessionId/intercept`" }, "response": [] } ] }, { "name": "Chatbots & routing", "description": "19 endpoints.", "item": [ { "name": "GET /manual-chatbot", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of manualChatbot objects in `data` (35 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot`" }, "response": [] }, { "name": "POST /manual-chatbot", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"\",\n \"nodes\": [],\n \"edges\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot`" }, "response": [] }, { "name": "DELETE /manual-chatbot", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /manual-chatbot`" }, "response": [] }, { "name": "GET /manual-chatbot/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot/:id`" }, "response": [] }, { "name": "PUT /manual-chatbot/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /manual-chatbot/:id`" }, "response": [] }, { "name": "DELETE /manual-chatbot/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /manual-chatbot/:id`" }, "response": [] }, { "name": "POST /manual-chatbot/ai-generate", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/ai-generate", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "ai-generate" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nErrors: `AIUsageLimitReached_429`.\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot/ai-generate`" }, "response": [] }, { "name": "GET /manual-chatbot/chatbot-router", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot/chatbot-router`" }, "response": [] }, { "name": "PUT /manual-chatbot/chatbot-router", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /manual-chatbot/chatbot-router`" }, "response": [] }, { "name": "GET /manual-chatbot/chatbot-router/apps", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "apps" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot/chatbot-router/apps`" }, "response": [] }, { "name": "GET /manual-chatbot/chatbot-router/bots", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/bots", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "bots" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot/chatbot-router/bots`" }, "response": [] }, { "name": "POST /manual-chatbot/chatbot-router/entry-points", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/entry-points", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "entry-points" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `channel`.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot/chatbot-router/entry-points`" }, "response": [] }, { "name": "PUT /manual-chatbot/chatbot-router/entry-points/:entryPointId", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/entry-points/:entryPointId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "entry-points", ":entryPointId" ], "variable": [ { "key": "entryPointId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /manual-chatbot/chatbot-router/entry-points/:entryPointId`" }, "response": [] }, { "name": "DELETE /manual-chatbot/chatbot-router/entry-points/:entryPointId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/entry-points/:entryPointId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "entry-points", ":entryPointId" ], "variable": [ { "key": "entryPointId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /manual-chatbot/chatbot-router/entry-points/:entryPointId`" }, "response": [] }, { "name": "POST /manual-chatbot/chatbot-router/entry-points/:entryPointId/test", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"text\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/entry-points/:entryPointId/test", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "entry-points", ":entryPointId", "test" ], "variable": [ { "key": "entryPointId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `text`.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot/chatbot-router/entry-points/:entryPointId/test`" }, "response": [] }, { "name": "POST /manual-chatbot/chatbot-router/rebuild", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/rebuild", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "rebuild" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one manualChatbot object in `data` (35 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot/chatbot-router/rebuild`" }, "response": [] }, { "name": "GET /manual-chatbot/chatbot-router/session/stop", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/session/stop", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "session", "stop" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `channel`, `app`.\n\nReturns one botSession object in `data` (60 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /manual-chatbot/chatbot-router/session/stop`" }, "response": [] }, { "name": "PUT /manual-chatbot/chatbot-router/session/stop", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel\": \"\",\n \"app\": \"\",\n \"account\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/chatbot-router/session/stop", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "chatbot-router", "session", "stop" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `channel`, `app`.\n\nReturns one botSession object in `data` (60 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /manual-chatbot/chatbot-router/session/stop`" }, "response": [] }, { "name": "POST /manual-chatbot/keywords", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/manual-chatbot/keywords", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-chatbot", "keywords" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /manual-chatbot/keywords`" }, "response": [] } ] }, { "name": "Forms", "description": "7 endpoints.", "item": [ { "name": "GET /form", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/form", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of LeadCaptureForm objects in `data` (45 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /form`" }, "response": [] }, { "name": "POST /form", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"fields\": \"\",\n \"formFields\": \"\",\n \"settings\": \"\",\n \"template\": \"\",\n \"status\": \"\",\n \"assignment\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/form", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one LeadCaptureForm object in `data` (45 fields).\n\nErrors: `FormNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /form`" }, "response": [] }, { "name": "DELETE /form", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/form", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoFormSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /form`" }, "response": [] }, { "name": "GET /form/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/form/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one LeadCaptureForm object in `data` (45 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `FormNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /form/:id`" }, "response": [] }, { "name": "PUT /form/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/form/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /form/:id`" }, "response": [] }, { "name": "PUT /form/:id/status", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/form/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form", ":id", "status" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one LeadCaptureForm object in `data` (45 fields).\n\nErrors: `FormFieldsRequired_400`, `FormNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /form/:id/status`" }, "response": [] }, { "name": "GET /form/:id/submissions", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/form/:id/submissions", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "form", ":id", "submissions" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of LeadCaptureFormSubmission objects in `data` (21 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `contact`, `lead`.\n\nErrors: `FormNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /form/:id/submissions`" }, "response": [] } ] }, { "name": "Domain tracking", "description": "5 endpoints.", "item": [ { "name": "GET /domain-tracking", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/domain-tracking", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "domain-tracking" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of domainTrackingSchema objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /domain-tracking`" }, "response": [] }, { "name": "POST /domain-tracking", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"domain\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/domain-tracking", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "domain-tracking" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `domain`.\n\nReturns one domainTrackingSchema object in `data` (9 fields).\n\nErrors: `DomainTrackingNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /domain-tracking`" }, "response": [] }, { "name": "DELETE /domain-tracking", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/domain-tracking", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "domain-tracking" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /domain-tracking`" }, "response": [] }, { "name": "GET /domain-tracking/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/domain-tracking/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "domain-tracking", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one domainTrackingSchema object in `data` (9 fields).\n\nErrors: `DomainTrackingNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /domain-tracking/:id`" }, "response": [] }, { "name": "GET /domain-tracking/:id/activities", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/domain-tracking/:id/activities", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "domain-tracking", ":id", "activities" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Activity objects in `data` (29 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nErrors: `DomainTrackingNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /domain-tracking/:id/activities`" }, "response": [] } ] } ] }, { "name": "AI", "description": "AI CRM chat, onboarding, lead generation and enrichment.", "item": [ { "name": "AI CRM chat", "description": "8 endpoints.", "item": [ { "name": "GET /ai-crm-chat", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat" ], "query": [ { "key": "p", "value": "1", "disabled": true }, { "key": "n", "value": "30", "disabled": true }, { "key": "searchValue", "value": "", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of AiCrmChat objects in `data` (15 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /ai-crm-chat`" }, "response": [] }, { "name": "POST /ai-crm-chat", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AiCrmChat object in `data` (15 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /ai-crm-chat`" }, "response": [] }, { "name": "GET /ai-crm-chat/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AiCrmChat object in `data` (15 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /ai-crm-chat/:id`" }, "response": [] }, { "name": "PUT /ai-crm-chat/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /ai-crm-chat/:id`" }, "response": [] }, { "name": "DELETE /ai-crm-chat/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /ai-crm-chat/:id`" }, "response": [] }, { "name": "POST /ai-crm-chat/:id/message", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/:id/message", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", ":id", "message" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AiCrmChat object in `data` (15 fields).\n\nErrors: `InvalidRequest_400`, `PlanLimitExceeded_403`.\n\nDocs: https://docs.leadx.in/reference — `POST /ai-crm-chat/:id/message`" }, "response": [] }, { "name": "POST /ai-crm-chat/:id/tool/:messageId/:callId", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/:id/tool/:messageId/:callId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", ":id", "tool", ":messageId", ":callId" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "messageId", "value": "", "description": "Required." }, { "key": "callId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AiCrmMessage object in `data` (30 fields).\n\nErrors: `InvalidRequest_400`, `NotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /ai-crm-chat/:id/tool/:messageId/:callId`" }, "response": [] }, { "name": "GET /ai-crm-chat/usage", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-crm-chat/usage", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-crm-chat", "usage" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /ai-crm-chat/usage`" }, "response": [] } ] }, { "name": "AI onboarding", "description": "7 endpoints.", "item": [ { "name": "GET /ai-onboarding", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /ai-onboarding`" }, "response": [] }, { "name": "POST /ai-onboarding/:id/apply", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/:id/apply", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", ":id", "apply" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /ai-onboarding/:id/apply`" }, "response": [] }, { "name": "POST /ai-onboarding/:id/resume", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", ":id", "resume" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /ai-onboarding/:id/resume`" }, "response": [] }, { "name": "POST /ai-onboarding/:id/suggest", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/:id/suggest", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", ":id", "suggest" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /ai-onboarding/:id/suggest`" }, "response": [] }, { "name": "GET /ai-onboarding/latest", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/latest", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", "latest" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /ai-onboarding/latest`" }, "response": [] }, { "name": "PUT /ai-onboarding/latest", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"about\": \"\",\n \"socials\": \"\",\n \"products\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/latest", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", "latest" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /ai-onboarding/latest`" }, "response": [] }, { "name": "POST /ai-onboarding/start", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/ai-onboarding/start", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "ai-onboarding", "start" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one AIOnboarding object in `data` (52 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /ai-onboarding/start`" }, "response": [] } ] }, { "name": "AI lead generation", "description": "3 endpoints.", "item": [ { "name": "GET /lead-gen-ai", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-gen-ai", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-gen-ai" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of LeadGeneratorConfig objects in `data` (27 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /lead-gen-ai`" }, "response": [] }, { "name": "GET /lead-gen-ai/:configId", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-gen-ai/:configId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-gen-ai", ":configId" ], "variable": [ { "key": "configId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /lead-gen-ai/:configId`" }, "response": [] }, { "name": "DELETE /lead-gen-ai/:configId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/lead-gen-ai/:configId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "lead-gen-ai", ":configId" ], "variable": [ { "key": "configId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one LeadGeneratorConfig object in `data` (27 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /lead-gen-ai/:configId`" }, "response": [] } ] }, { "name": "Enrichment", "description": "2 endpoints.", "item": [ { "name": "POST /enrich/contact", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/enrich/contact", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "enrich", "contact" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Contact object in `data` (106 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /enrich/contact`" }, "response": [] }, { "name": "POST /enrich/lead", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/enrich/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "enrich", "lead" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /enrich/lead`" }, "response": [] } ] } ] }, { "name": "Automation", "description": "Workflow definitions and runs.", "item": [ { "name": "Workflows", "description": "16 endpoints.", "item": [ { "name": "GET /workflow", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Workflow objects in `data` (21 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /workflow`" }, "response": [] }, { "name": "POST /workflow", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"triggerEventType\": \"\",\n \"config\": {},\n \"nodes\": [],\n \"edges\": [],\n \"schedule\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/workflow", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /workflow`" }, "response": [] }, { "name": "DELETE /workflow", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/workflow", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /workflow`" }, "response": [] }, { "name": "GET /workflow/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /workflow/:id`" }, "response": [] }, { "name": "PUT /workflow/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"triggerEventType\": \"\",\n \"config\": \"\",\n \"nodes\": \"\",\n \"edges\": \"\",\n \"status\": \"\",\n \"schedule\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /workflow/:id`" }, "response": [] }, { "name": "DELETE /workflow/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /workflow/:id`" }, "response": [] }, { "name": "POST /workflow/:id/publish", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id/publish", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id", "publish" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/:id/publish`" }, "response": [] }, { "name": "POST /workflow/:id/runs/pause", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id/runs/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id", "runs", "pause" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/:id/runs/pause`" }, "response": [] }, { "name": "POST /workflow/:id/unpublish", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/:id/unpublish", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", ":id", "unpublish" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Workflow object in `data` (21 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/:id/unpublish`" }, "response": [] }, { "name": "GET /workflow/runs", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of RunWorkflow objects in `data` (50 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /workflow/runs`" }, "response": [] }, { "name": "DELETE /workflow/runs", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one RunWorkflow object in `data` (50 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /workflow/runs`" }, "response": [] }, { "name": "DELETE /workflow/runs/:runId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs", ":runId" ], "variable": [ { "key": "runId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one RunWorkflow object in `data` (50 fields).\n\nDocs: https://docs.leadx.in/reference — `DELETE /workflow/runs/:runId`" }, "response": [] }, { "name": "POST /workflow/runs/:runId/cancel", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs/:runId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs", ":runId", "cancel" ], "variable": [ { "key": "runId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/runs/:runId/cancel`" }, "response": [] }, { "name": "POST /workflow/runs/:runId/pause", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs/:runId/pause", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs", ":runId", "pause" ], "variable": [ { "key": "runId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/runs/:runId/pause`" }, "response": [] }, { "name": "POST /workflow/runs/:runId/restart", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs/:runId/restart", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs", ":runId", "restart" ], "variable": [ { "key": "runId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one RunWorkflow object in `data` (50 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/runs/:runId/restart`" }, "response": [] }, { "name": "POST /workflow/runs/:runId/resume", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/workflow/runs/:runId/resume", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "workflow", "runs", ":runId", "resume" ], "variable": [ { "key": "runId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /workflow/runs/:runId/resume`" }, "response": [] } ] } ] }, { "name": "Integrations", "description": "Connected apps: email senders, messaging channels, AI providers, storage and calendars.", "item": [ { "name": "Connected apps", "description": "145 endpoints.", "item": [ { "name": "GET /apps", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `AppNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps`" }, "response": [] }, { "name": "PUT /apps", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"defaultSMTPServer\": \"\",\n \"defaultS3Bucket\": \"\",\n \"uniqueKey\": \"\",\n \"companyType\": \"\",\n \"defaultCompanyType\": \"\",\n \"defaultOcr\": \"\",\n \"defaultGemini\": \"\",\n \"defaultClaude\": \"\",\n \"defaultOffline\": \"\",\n \"defaultZoom\": \"\",\n \"defaultGoogleCalendar\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /apps`" }, "response": [] }, { "name": "GET /apps/brevo", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/brevo", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "brevo" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Brevo objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/brevo`" }, "response": [] }, { "name": "POST /apps/brevo", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/brevo", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "brevo" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Brevo object in `data` (9 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/brevo`" }, "response": [] }, { "name": "DELETE /apps/brevo", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/brevo", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "brevo" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoBrevoSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/brevo`" }, "response": [] }, { "name": "GET /apps/brevo/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/brevo/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "brevo", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Brevo object in `data` (9 fields).\n\nErrors: `BrevoNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/brevo/:id`" }, "response": [] }, { "name": "PUT /apps/brevo/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/brevo/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "brevo", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Brevo object in `data` (9 fields).\n\nErrors: `BrevoNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/brevo/:id`" }, "response": [] }, { "name": "GET /apps/claude", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Claude objects in `data` (14 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/claude`" }, "response": [] }, { "name": "POST /apps/claude", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"selectedModel\": \"\",\n \"modelSettings\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `apiKey`, `selectedModel`.\n\nReturns one Claude object in `data` (14 fields).\n\nErrors: `ClaudeNotAvailableInPlan_400`, `InvalidClaudeConfiguration_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/claude`" }, "response": [] }, { "name": "DELETE /apps/claude", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/claude`" }, "response": [] }, { "name": "GET /apps/claude/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Claude object in `data` (14 fields).\n\nErrors: `ClaudeConfigurationNotFound_400`, `ClaudeNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/claude/:id`" }, "response": [] }, { "name": "PUT /apps/claude/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"selectedModel\": \"\",\n \"modelSettings\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Claude object in `data` (14 fields).\n\nErrors: `ClaudeConfigurationNotFound_400`, `ClaudeNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/claude/:id`" }, "response": [] }, { "name": "GET /apps/claude/models", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/claude/models", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "claude", "models" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `ClaudeNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/claude/models`" }, "response": [] }, { "name": "GET /apps/elasticemail", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/elasticemail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "elasticemail" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Elasticemail objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/elasticemail`" }, "response": [] }, { "name": "POST /apps/elasticemail", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/elasticemail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "elasticemail" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Elasticemail object in `data` (9 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/elasticemail`" }, "response": [] }, { "name": "DELETE /apps/elasticemail", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/elasticemail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "elasticemail" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoElasticemailSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/elasticemail`" }, "response": [] }, { "name": "GET /apps/elasticemail/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/elasticemail/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "elasticemail", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Elasticemail object in `data` (9 fields).\n\nErrors: `ElasticemailNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/elasticemail/:id`" }, "response": [] }, { "name": "PUT /apps/elasticemail/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/elasticemail/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "elasticemail", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Elasticemail object in `data` (9 fields).\n\nErrors: `ElasticemailNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/elasticemail/:id`" }, "response": [] }, { "name": "POST /apps/facebook/apps", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"appID\": \"\",\n \"secret\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "apps" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FacebookApp object in `data` (8 fields).\n\nErrors: `FacebookAppIDRequired_400`, `FacebookSecretRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/facebook/apps`" }, "response": [] }, { "name": "GET /apps/facebook/apps/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/apps/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "apps", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FacebookApp object in `data` (8 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/apps/:id`" }, "response": [] }, { "name": "PUT /apps/facebook/apps/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"appID\": \"\",\n \"secret\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/apps/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "apps", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one FacebookApp object in `data` (8 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/facebook/apps/:id`" }, "response": [] }, { "name": "GET /apps/facebook/form/details", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formId\": \"\",\n \"accessToken\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/form/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "form", "details" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `FormIdOrTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/form/details`" }, "response": [] }, { "name": "GET /apps/facebook/form/leads", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formId\": \"\",\n \"accessToken\": \"\",\n \"limit\": \"\",\n \"after\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/form/leads", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "form", "leads" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `FormIdOrTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/form/leads`" }, "response": [] }, { "name": "PUT /apps/facebook/forms/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/forms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "forms", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/facebook/forms/:id`" }, "response": [] }, { "name": "GET /apps/facebook/lead", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"accessToken\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/lead", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "lead" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `LeadIdOrTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/lead`" }, "response": [] }, { "name": "PUT /apps/facebook/lead/status", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"leadId\": \"\",\n \"accessToken\": \"\",\n \"status\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/lead/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "lead", "status" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `LeadIdTokenStatusRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/facebook/lead/status`" }, "response": [] }, { "name": "GET /apps/facebook/page/forms", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"pageId\": \"\",\n \"pageAccessToken\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/page/forms", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "page", "forms" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `PageIdOrTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/page/forms`" }, "response": [] }, { "name": "GET /apps/facebook/pages", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/pages", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "pages" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Page object in `data` (8 fields).\n\nPopulated: `forms`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/pages`" }, "response": [] }, { "name": "GET /apps/facebook/sync/form-leads/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/form-leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "form-leads", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `FacebookTokenRequired_400`, `FormIdRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/form-leads/:id`" }, "response": [] }, { "name": "GET /apps/facebook/sync/job-status/:jobId", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/job-status/:jobId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "job-status", ":jobId" ], "variable": [ { "key": "jobId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `JobIdRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/job-status/:jobId`" }, "response": [] }, { "name": "GET /apps/facebook/sync/manual-job", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formId\": \"\",\n \"priority\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/manual-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "manual-job" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/manual-job`" }, "response": [] }, { "name": "GET /apps/facebook/sync/page-forms-leads/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/page-forms-leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "page-forms-leads", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `FacebookTokenRequired_400`, `PageIdRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/page-forms-leads/:id`" }, "response": [] }, { "name": "GET /apps/facebook/sync/page-forms/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/page-forms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "page-forms", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/page-forms/:id`" }, "response": [] }, { "name": "GET /apps/facebook/sync/pages-forms", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/pages-forms", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "pages-forms" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/pages-forms`" }, "response": [] }, { "name": "GET /apps/facebook/sync/pages-forms-leads", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/pages-forms-leads", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "pages-forms-leads" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `FacebookTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/pages-forms-leads`" }, "response": [] }, { "name": "GET /apps/facebook/sync/process-job", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"jobId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/process-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "process-job" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `JobIdRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/process-job`" }, "response": [] }, { "name": "GET /apps/facebook/sync/schedule", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"intervalHours\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/schedule", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "schedule" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/schedule`" }, "response": [] }, { "name": "GET /apps/facebook/sync/webhook-failures", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/webhook-failures", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "webhook-failures" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/webhook-failures`" }, "response": [] }, { "name": "GET /apps/facebook/sync/webhook-fallback-job", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"formId\": \"\",\n \"leadId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/sync/webhook-fallback-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "sync", "webhook-fallback-job" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `FormIdRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/facebook/sync/webhook-fallback-job`" }, "response": [] }, { "name": "POST /apps/facebook/validate-token", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/facebook/validate-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "facebook", "validate-token" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `FacebookTokenRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/facebook/validate-token`" }, "response": [] }, { "name": "GET /apps/gemini", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Gemini objects in `data` (12 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gemini`" }, "response": [] }, { "name": "POST /apps/gemini", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"selectedModel\": \"\",\n \"modelSettings\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `apiKey`, `selectedModel`.\n\nReturns one Gemini object in `data` (12 fields).\n\nErrors: `GeminiNotAvailableInPlan_400`, `InvalidGeminiConfiguration_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/gemini`" }, "response": [] }, { "name": "DELETE /apps/gemini", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/gemini`" }, "response": [] }, { "name": "GET /apps/gemini/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gemini object in `data` (12 fields).\n\nErrors: `GeminiConfigurationNotFound_400`, `GeminiNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gemini/:id`" }, "response": [] }, { "name": "PUT /apps/gemini/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"selectedModel\": \"\",\n \"modelSettings\": \"\",\n \"isActive\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gemini object in `data` (12 fields).\n\nErrors: `GeminiConfigurationNotFound_400`, `GeminiNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/gemini/:id`" }, "response": [] }, { "name": "GET /apps/gemini/models", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gemini/models", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gemini", "models" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `GeminiNotAvailableInPlan_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gemini/models`" }, "response": [] }, { "name": "GET /apps/gmail", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Gmail objects in `data` (7 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gmail`" }, "response": [] }, { "name": "POST /apps/gmail", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gmail object in `data` (7 fields).\n\nErrors: `GmailCodeRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/gmail`" }, "response": [] }, { "name": "DELETE /apps/gmail", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/gmail`" }, "response": [] }, { "name": "GET /apps/gmail/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gmail object in `data` (7 fields).\n\nErrors: `GmailNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gmail/:id`" }, "response": [] }, { "name": "PUT /apps/gmail/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gmail object in `data` (7 fields).\n\nErrors: `GmailNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/gmail/:id`" }, "response": [] }, { "name": "GET /apps/gmail/redirect", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail/redirect", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail", "redirect" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gmail/redirect`" }, "response": [] }, { "name": "GET /apps/gmail/refresh", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/gmail/refresh", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "gmail", "refresh" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Gmail object in `data` (7 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/gmail/refresh`" }, "response": [] }, { "name": "GET /apps/google-calendar", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of GoogleCalendarAccount objects in `data` (19 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/google-calendar`" }, "response": [] }, { "name": "POST /apps/google-calendar", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"authType\": \"manual\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"refreshToken\": \"\",\n \"calendarId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `clientId`, `clientSecret`, `refreshToken`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/google-calendar`" }, "response": [] }, { "name": "DELETE /apps/google-calendar", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/google-calendar`" }, "response": [] }, { "name": "GET /apps/google-calendar/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/google-calendar/:id`" }, "response": [] }, { "name": "PUT /apps/google-calendar/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/google-calendar/:id`" }, "response": [] }, { "name": "POST /apps/google-calendar/redirect", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/google-calendar/redirect", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "google-calendar", "redirect" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/google-calendar/redirect`" }, "response": [] }, { "name": "GET /apps/instagram", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of InstagramApp objects in `data` (40 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/instagram`" }, "response": [] }, { "name": "POST /apps/instagram", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appId\": \"\",\n \"appSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `appId`, `appSecret`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram`" }, "response": [] }, { "name": "GET /apps/instagram/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/instagram/:id`" }, "response": [] }, { "name": "PUT /apps/instagram/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"appId\": \"\",\n \"appSecret\": \"\",\n \"accessToken\": \"\",\n \"pageId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/instagram/:id`" }, "response": [] }, { "name": "GET /apps/instagram/:id/accounts", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/instagram/:id/accounts`" }, "response": [] }, { "name": "POST /apps/instagram/:id/accounts", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"instagramUserId\": \"\",\n \"instagramUsername\": \"\",\n \"name\": \"\",\n \"pageId\": \"\",\n \"pageName\": \"\",\n \"accountType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `instagramUserId`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/accounts`" }, "response": [] }, { "name": "GET /apps/instagram/:id/accounts/:accountId", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAccountNotFound_404`, `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/instagram/:id/accounts/:accountId`" }, "response": [] }, { "name": "PUT /apps/instagram/:id/accounts/:accountId", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/instagram/:id/accounts/:accountId`" }, "response": [] }, { "name": "DELETE /apps/instagram/:id/accounts/:accountId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/instagram/:id/accounts/:accountId`" }, "response": [] }, { "name": "POST /apps/instagram/:id/accounts/:accountId/comment/like", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId/comment/like", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId", "comment", "like" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `commentId`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/accounts/:accountId/comment/like`" }, "response": [] }, { "name": "POST /apps/instagram/:id/accounts/:accountId/comment/reply", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commentId\": \"\",\n \"text\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId/comment/reply", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId", "comment", "reply" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `commentId`, `text`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/accounts/:accountId/comment/reply`" }, "response": [] }, { "name": "POST /apps/instagram/:id/accounts/:accountId/reply", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"\",\n \"text\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId/reply", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId", "reply" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `messageId`, `text`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/accounts/:accountId/reply`" }, "response": [] }, { "name": "POST /apps/instagram/:id/accounts/:accountId/send", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipientId\": \"\",\n \"senderId\": \"\",\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/accounts/:accountId/send", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "accounts", ":accountId", "send" ], "variable": [ { "key": "id", "value": "", "description": "Required." }, { "key": "accountId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `recipientId`, `senderId`, `message`.\n\nReturns one UnifiedMessage object in `data` (22 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/accounts/:accountId/send`" }, "response": [] }, { "name": "POST /apps/instagram/:id/oauth/refresh", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/oauth/refresh", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "oauth", "refresh" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`, `InvalidRequest_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/oauth/refresh`" }, "response": [] }, { "name": "GET /apps/instagram/:id/oauth/status", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/oauth/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "oauth", "status" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/instagram/:id/oauth/status`" }, "response": [] }, { "name": "POST /apps/instagram/:id/send-me", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/send-me", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "send-me" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/send-me`" }, "response": [] }, { "name": "POST /apps/instagram/:id/webhook/subscribe", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/:id/webhook/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", ":id", "webhook", "subscribe" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InstagramAppNotFound_404`, `InvalidRequest_400`, `WebhookSubscriptionFailed_500`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/:id/webhook/subscribe`" }, "response": [] }, { "name": "POST /apps/instagram/oauth/callback", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/oauth/callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", "oauth", "callback" ], "query": [ { "key": "code", "value": "", "disabled": true }, { "key": "state", "value": "", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `code`.\n\nErrors: `Unauthorized_401`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/oauth/callback`" }, "response": [] }, { "name": "POST /apps/instagram/oauth/init", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"scopes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/instagram/oauth/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "instagram", "oauth", "init" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/instagram/oauth/init`" }, "response": [] }, { "name": "GET /apps/mailchimp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/mailchimp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "mailchimp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Mailchimp objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/mailchimp`" }, "response": [] }, { "name": "POST /apps/mailchimp", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/mailchimp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "mailchimp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Mailchimp object in `data` (9 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/mailchimp`" }, "response": [] }, { "name": "DELETE /apps/mailchimp", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/mailchimp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "mailchimp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoMailchimpSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/mailchimp`" }, "response": [] }, { "name": "GET /apps/mailchimp/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/mailchimp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "mailchimp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Mailchimp object in `data` (9 fields).\n\nErrors: `MailchimpNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/mailchimp/:id`" }, "response": [] }, { "name": "PUT /apps/mailchimp/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/mailchimp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "mailchimp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Mailchimp object in `data` (9 fields).\n\nErrors: `MailchimpNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/mailchimp/:id`" }, "response": [] }, { "name": "POST /apps/oAuthWhatsApp/:id/complete-onboarding", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"sessionInfo\": \"\",\n \"name\": \"\",\n \"redirectUri\": \"\",\n \"pin\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/oAuthWhatsApp/:id/complete-onboarding", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "oAuthWhatsApp", ":id", "complete-onboarding" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `code`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/oAuthWhatsApp/:id/complete-onboarding`" }, "response": [] }, { "name": "GET /apps/ocr", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Ocr objects in `data` (7 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/ocr`" }, "response": [] }, { "name": "POST /apps/ocr", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ocr object in `data` (7 fields).\n\nErrors: `OcrNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/ocr`" }, "response": [] }, { "name": "DELETE /apps/ocr", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/ocr`" }, "response": [] }, { "name": "GET /apps/ocr/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ocr object in `data` (7 fields).\n\nErrors: `OcrNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/ocr/:id`" }, "response": [] }, { "name": "PUT /apps/ocr/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ocr object in `data` (7 fields).\n\nErrors: `OcrNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/ocr/:id`" }, "response": [] }, { "name": "POST /apps/ocr/image", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fileIDs\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ocr/image", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ocr", "image" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `OcrNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/ocr/image`" }, "response": [] }, { "name": "GET /apps/offline-meeting", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of OfflineLocation objects in `data` (10 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/offline-meeting`" }, "response": [] }, { "name": "POST /apps/offline-meeting", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"address\": \"\",\n \"mapLink\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one OfflineLocation object in `data` (10 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/offline-meeting`" }, "response": [] }, { "name": "DELETE /apps/offline-meeting", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/offline-meeting`" }, "response": [] }, { "name": "GET /apps/offline-meeting/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one OfflineLocation object in `data` (10 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/offline-meeting/:id`" }, "response": [] }, { "name": "PUT /apps/offline-meeting/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one OfflineLocation object in `data` (10 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/offline-meeting/:id`" }, "response": [] }, { "name": "DELETE /apps/offline-meeting/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/offline-meeting/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "offline-meeting", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/offline-meeting/:id`" }, "response": [] }, { "name": "GET /apps/postmark", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/postmark", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "postmark" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Postmark objects in `data` (10 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/postmark`" }, "response": [] }, { "name": "POST /apps/postmark", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"serverToken\": \"\",\n \"messageStream\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/postmark", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "postmark" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Postmark object in `data` (10 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/postmark`" }, "response": [] }, { "name": "DELETE /apps/postmark", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/postmark", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "postmark" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoPostmarkSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/postmark`" }, "response": [] }, { "name": "GET /apps/postmark/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/postmark/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "postmark", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Postmark object in `data` (10 fields).\n\nErrors: `PostmarkNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/postmark/:id`" }, "response": [] }, { "name": "PUT /apps/postmark/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/postmark/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "postmark", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Postmark object in `data` (10 fields).\n\nErrors: `PostmarkNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/postmark/:id`" }, "response": [] }, { "name": "GET /apps/s3bucket", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Bucket objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/s3bucket`" }, "response": [] }, { "name": "POST /apps/s3bucket", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accesskey\": \"\",\n \"secretkey\": \"\",\n \"region\": \"\",\n \"name\": \"\",\n \"subpath\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Bucket object in `data` (9 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/s3bucket`" }, "response": [] }, { "name": "PUT /apps/s3bucket", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"updateType\": \"\",\n \"formData\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/s3bucket`" }, "response": [] }, { "name": "DELETE /apps/s3bucket", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/s3bucket`" }, "response": [] }, { "name": "GET /apps/s3bucket/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Bucket object in `data` (9 fields).\n\nErrors: `S3BucketNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/s3bucket/:id`" }, "response": [] }, { "name": "PUT /apps/s3bucket/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/s3bucket/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "s3bucket", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Bucket object in `data` (9 fields).\n\nErrors: `S3BucketNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/s3bucket/:id`" }, "response": [] }, { "name": "GET /apps/sendgrid", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sendgrid", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sendgrid" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Sendgrid objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/sendgrid`" }, "response": [] }, { "name": "POST /apps/sendgrid", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sendgrid", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sendgrid" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sendgrid object in `data` (9 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/sendgrid`" }, "response": [] }, { "name": "DELETE /apps/sendgrid", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sendgrid", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sendgrid" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoSendgridSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/sendgrid`" }, "response": [] }, { "name": "GET /apps/sendgrid/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sendgrid/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sendgrid", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sendgrid object in `data` (9 fields).\n\nErrors: `SendgridNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/sendgrid/:id`" }, "response": [] }, { "name": "PUT /apps/sendgrid/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sendgrid/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sendgrid", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sendgrid object in `data` (9 fields).\n\nErrors: `SendgridNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/sendgrid/:id`" }, "response": [] }, { "name": "GET /apps/ses", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ses", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ses" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Ses objects in `data` (11 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/ses`" }, "response": [] }, { "name": "POST /apps/ses", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accessKeyId\": \"\",\n \"secretAccessKey\": \"\",\n \"region\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ses", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ses" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ses object in `data` (11 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/ses`" }, "response": [] }, { "name": "DELETE /apps/ses", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ses", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ses" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoSESSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/ses`" }, "response": [] }, { "name": "GET /apps/ses/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ses/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ses", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ses object in `data` (11 fields).\n\nErrors: `SESNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/ses/:id`" }, "response": [] }, { "name": "PUT /apps/ses/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/ses/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "ses", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Ses object in `data` (11 fields).\n\nErrors: `SESNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/ses/:id`" }, "response": [] }, { "name": "GET /apps/smtp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/smtp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "smtp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Smtp objects in `data` (13 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/smtp`" }, "response": [] }, { "name": "POST /apps/smtp", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"host\": \"\",\n \"port\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"secure\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/smtp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "smtp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Smtp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/smtp`" }, "response": [] }, { "name": "DELETE /apps/smtp", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/smtp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "smtp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoSMTPSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/smtp`" }, "response": [] }, { "name": "GET /apps/smtp/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/smtp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "smtp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Smtp object in `data` (13 fields).\n\nErrors: `SMTPNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/smtp/:id`" }, "response": [] }, { "name": "PUT /apps/smtp/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/smtp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "smtp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Smtp object in `data` (13 fields).\n\nErrors: `SMTPNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/smtp/:id`" }, "response": [] }, { "name": "GET /apps/sparkpost", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sparkpost", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sparkpost" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Sparkpost objects in `data` (10 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/sparkpost`" }, "response": [] }, { "name": "POST /apps/sparkpost", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"endpoint\": \"\",\n \"fromEmail\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sparkpost", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sparkpost" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sparkpost object in `data` (10 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/sparkpost`" }, "response": [] }, { "name": "DELETE /apps/sparkpost", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sparkpost", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sparkpost" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `NoSparkpostSelected_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/sparkpost`" }, "response": [] }, { "name": "GET /apps/sparkpost/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sparkpost/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sparkpost", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sparkpost object in `data` (10 fields).\n\nErrors: `SparkpostNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/sparkpost/:id`" }, "response": [] }, { "name": "PUT /apps/sparkpost/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/sparkpost/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "sparkpost", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Sparkpost object in `data` (10 fields).\n\nErrors: `SparkpostNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/sparkpost/:id`" }, "response": [] }, { "name": "GET /apps/telegram", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/telegram", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "telegram" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of TelegramApp objects in `data` (8 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/telegram`" }, "response": [] }, { "name": "POST /apps/telegram", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/telegram", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "telegram" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `token`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/telegram`" }, "response": [] }, { "name": "DELETE /apps/telegram", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/telegram", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "telegram" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/telegram`" }, "response": [] }, { "name": "GET /apps/telegram/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/telegram/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "telegram", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `TelegramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/telegram/:id`" }, "response": [] }, { "name": "PUT /apps/telegram/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/telegram/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "telegram", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `TelegramAppNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/telegram/:id`" }, "response": [] }, { "name": "GET /apps/whatsapp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of MetaApp objects in `data` (24 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/whatsapp`" }, "response": [] }, { "name": "POST /apps/whatsapp", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"countryCode\": \"\",\n \"number\": \"\",\n \"appID\": \"\",\n \"numberID\": \"\",\n \"businessID\": \"\",\n \"PAT\": \"\",\n \"pin\": \"\",\n \"appSecret\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MetaApp object in `data` (24 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /apps/whatsapp`" }, "response": [] }, { "name": "GET /apps/whatsapp/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `WhatsappNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/whatsapp/:id`" }, "response": [] }, { "name": "PUT /apps/whatsapp/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `WhatsappNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/whatsapp/:id`" }, "response": [] }, { "name": "POST /apps/whatsapp/oauth/callback", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"state\": \"\",\n \"sessionInfo\": {},\n \"pin\": \"\",\n \"name\": \"\",\n \"redirectUri\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp/oauth/callback", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp", "oauth", "callback" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `code`, `state`.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `InvalidRequest_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/whatsapp/oauth/callback`" }, "response": [] }, { "name": "POST /apps/whatsapp/oauth/init", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"redirectPath\": \"/apps/whatsapp\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp/oauth/init", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp", "oauth", "init" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one App object in `data` (53 fields).\n\nErrors: `InvalidRequest_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/whatsapp/oauth/init`" }, "response": [] }, { "name": "GET /apps/whatsapp/verify/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/whatsapp/verify/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "whatsapp", "verify", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MetaApp object in `data` (24 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /apps/whatsapp/verify/:id`" }, "response": [] }, { "name": "GET /apps/zoom", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ZoomAccount objects in `data` (16 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/zoom`" }, "response": [] }, { "name": "POST /apps/zoom", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"authType\": \"manual\",\n \"accountId\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `accountId`, `clientId`, `clientSecret`.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/zoom`" }, "response": [] }, { "name": "DELETE /apps/zoom", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /apps/zoom`" }, "response": [] }, { "name": "GET /apps/zoom/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /apps/zoom/:id`" }, "response": [] }, { "name": "PUT /apps/zoom/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /apps/zoom/:id`" }, "response": [] }, { "name": "POST /apps/zoom/redirect", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/apps/zoom/redirect", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "apps", "zoom", "redirect" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /apps/zoom/redirect`" }, "response": [] } ] }, { "name": "My Zoom", "description": "6 endpoints.", "item": [ { "name": "GET /my-zoom", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ZoomAccount objects in `data` (16 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /my-zoom`" }, "response": [] }, { "name": "POST /my-zoom", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"authType\": \"manual\",\n \"accountId\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `accountId`, `clientId`, `clientSecret`.\n\nDocs: https://docs.leadx.in/reference — `POST /my-zoom`" }, "response": [] }, { "name": "GET /my-zoom/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /my-zoom/:id`" }, "response": [] }, { "name": "GET /my-zoom/default", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom/default", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom", "default" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MemberConnectingApp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /my-zoom/default`" }, "response": [] }, { "name": "PUT /my-zoom/default", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"defaultAccount\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom/default", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom", "default" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /my-zoom/default`" }, "response": [] }, { "name": "POST /my-zoom/redirect", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-zoom/redirect", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-zoom", "redirect" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /my-zoom/redirect`" }, "response": [] } ] }, { "name": "My Google Calendar", "description": "6 endpoints.", "item": [ { "name": "GET /my-google-calendar", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of GoogleCalendarAccount objects in `data` (19 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /my-google-calendar`" }, "response": [] }, { "name": "POST /my-google-calendar", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"authType\": \"manual\",\n \"clientId\": \"\",\n \"clientSecret\": \"\",\n \"refreshToken\": \"\",\n \"calendarId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`, `clientId`, `clientSecret`, `refreshToken`.\n\nDocs: https://docs.leadx.in/reference — `POST /my-google-calendar`" }, "response": [] }, { "name": "GET /my-google-calendar/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /my-google-calendar/:id`" }, "response": [] }, { "name": "GET /my-google-calendar/default", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar/default", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar", "default" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one MemberConnectingApp object in `data` (13 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /my-google-calendar/default`" }, "response": [] }, { "name": "PUT /my-google-calendar/default", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"defaultAccount\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar/default", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar", "default" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /my-google-calendar/default`" }, "response": [] }, { "name": "POST /my-google-calendar/redirect", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/my-google-calendar/redirect", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "my-google-calendar", "redirect" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /my-google-calendar/redirect`" }, "response": [] } ] } ] }, { "name": "Analytics & logs", "description": "Dashboards, statistics and per-provider delivery logs.", "item": [ { "name": "Analytics dashboards", "description": "20 endpoints.", "item": [ { "name": "GET /analytics-dashboard", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard`" }, "response": [] }, { "name": "POST /analytics-dashboard", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /analytics-dashboard`" }, "response": [] }, { "name": "GET /analytics-dashboard/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/:id`" }, "response": [] }, { "name": "PUT /analytics-dashboard/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /analytics-dashboard/:id`" }, "response": [] }, { "name": "DELETE /analytics-dashboard/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /analytics-dashboard/:id`" }, "response": [] }, { "name": "PUT /analytics-dashboard/reorder", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "reorder" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /analytics-dashboard/reorder`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/activity", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/activity", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "activity" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/activity`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/apps", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "apps" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/apps`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/campaigns", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "campaigns" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/campaigns`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/contacts", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "contacts" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/contacts`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/leads", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/leads", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "leads" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/leads`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/messages", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "messages" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/messages`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/overview", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/overview", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "overview" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/overview`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/revenue", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/revenue", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "revenue" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/revenue`" }, "response": [] }, { "name": "GET /analytics-dashboard/statistics/team", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/statistics/team", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "statistics", "team" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/statistics/team`" }, "response": [] }, { "name": "GET /analytics-dashboard/widget", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "widget" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/widget`" }, "response": [] }, { "name": "POST /analytics-dashboard/widget", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "widget" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /analytics-dashboard/widget`" }, "response": [] }, { "name": "GET /analytics-dashboard/widget/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /analytics-dashboard/widget/:id`" }, "response": [] }, { "name": "PUT /analytics-dashboard/widget/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /analytics-dashboard/widget/:id`" }, "response": [] }, { "name": "DELETE /analytics-dashboard/widget/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/analytics-dashboard/widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "analytics-dashboard", "widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /analytics-dashboard/widget/:id`" }, "response": [] } ] }, { "name": "Classic dashboards", "description": "10 endpoints.", "item": [ { "name": "GET /dashboard", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /dashboard`" }, "response": [] }, { "name": "POST /dashboard", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /dashboard`" }, "response": [] }, { "name": "DELETE /dashboard", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /dashboard`" }, "response": [] }, { "name": "GET /dashboard/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /dashboard/:id`" }, "response": [] }, { "name": "PUT /dashboard/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /dashboard/:id`" }, "response": [] }, { "name": "GET /dashboard/presets", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/presets", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", "presets" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /dashboard/presets`" }, "response": [] }, { "name": "PUT /dashboard/reorder", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", "reorder" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /dashboard/reorder`" }, "response": [] }, { "name": "GET /dashboard/widget", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", "widget" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /dashboard/widget`" }, "response": [] }, { "name": "DELETE /dashboard/widget", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/widget", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", "widget" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /dashboard/widget`" }, "response": [] }, { "name": "GET /dashboard/widget/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/dashboard/widget/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "dashboard", "widget", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /dashboard/widget/:id`" }, "response": [] } ] }, { "name": "Logs", "description": "14 endpoints.", "item": [ { "name": "GET /logs", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ServerLog objects in `data` (25 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs`" }, "response": [] }, { "name": "GET /logs/brevo", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/brevo", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "brevo" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of BrevoMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/brevo`" }, "response": [] }, { "name": "GET /logs/elasticemail", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/elasticemail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "elasticemail" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of ElasticemailMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/elasticemail`" }, "response": [] }, { "name": "GET /logs/gmail", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/gmail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "gmail" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of GmailMessage objects in `data` (16 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `gmails`, `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/gmail`" }, "response": [] }, { "name": "GET /logs/invite", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "invite" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of InviteLog objects in `data` (8 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `actionBy`, `role`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/invite`" }, "response": [] }, { "name": "GET /logs/login", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "login" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of LoginLog objects in `data` (9 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `user`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/login`" }, "response": [] }, { "name": "GET /logs/mailchimp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/mailchimp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "mailchimp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of MailchimpMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/mailchimp`" }, "response": [] }, { "name": "GET /logs/postmark", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/postmark", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "postmark" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of PostmarkMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/postmark`" }, "response": [] }, { "name": "GET /logs/report", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/report", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "report" ], "query": [ { "key": "reportType", "value": "", "disabled": true }, { "key": "by", "value": "", "disabled": true }, { "key": "startDate", "value": "", "disabled": true }, { "key": "endDate", "value": "", "disabled": true }, { "key": "download", "value": "", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `ReportNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/report`" }, "response": [] }, { "name": "GET /logs/sendgrid", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/sendgrid", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "sendgrid" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of SendgridMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/sendgrid`" }, "response": [] }, { "name": "GET /logs/ses", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/ses", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "ses" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of SesMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/ses`" }, "response": [] }, { "name": "GET /logs/smtp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/smtp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "smtp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of SmtpMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `smtp`, `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/smtp`" }, "response": [] }, { "name": "GET /logs/sparkpost", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/sparkpost", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "sparkpost" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of SparkpostMessage objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/sparkpost`" }, "response": [] }, { "name": "GET /logs/whatsapp", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/logs/whatsapp", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "logs", "whatsapp" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of WhatsAppMessage objects in `data` (19 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `app`, `template`, `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /logs/whatsapp`" }, "response": [] } ] } ] }, { "name": "Account", "description": "Profile, company, members, roles, API keys, files and reference data.", "item": [ { "name": "Profile", "description": "2 endpoints.", "item": [ { "name": "GET /profile", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "profile" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `role user`.\n\nDocs: https://docs.leadx.in/reference — `GET /profile`" }, "response": [] }, { "name": "PUT /profile", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aiOnboarded\": \"\",\n \"onboarded\": \"\",\n \"layout\": \"\",\n \"darkMode\": \"\",\n \"columns\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "profile" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `PUT /profile`" }, "response": [] } ] }, { "name": "Company", "description": "2 endpoints.", "item": [ { "name": "GET /company", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/company", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "company" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Company object in `data` (45 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /company`" }, "response": [] }, { "name": "PUT /company", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/company", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "company" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `field`.\n\nReturns one Feature object in `data` (19 fields).\n\nDocs: https://docs.leadx.in/reference — `PUT /company`" }, "response": [] } ] }, { "name": "Settings", "description": "2 endpoints.", "item": [ { "name": "GET /settings", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "settings" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `SettingsNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /settings`" }, "response": [] }, { "name": "PUT /settings", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currency\": \"\",\n \"dateFormat\": \"\",\n \"timeFormat\": \"\",\n \"timezone\": \"\",\n \"appName\": \"\",\n \"appDescription\": \"\",\n \"appVersion\": \"\",\n \"threads\": \"\",\n \"reddit\": \"\",\n \"quora\": \"\",\n \"discord\": \"\",\n \"medium\": \"\",\n \"pinterest\": \"\",\n \"facebook\": \"\",\n \"linkedin\": \"\",\n \"instagram\": \"\",\n \"youtube\": \"\",\n \"x\": \"\",\n \"notificationSettings\": \"\",\n \"mobileBackground\": \"\",\n \"teamSettings\": \"\",\n \"subscriptionPolicies\": \"\",\n \"manualChatbot\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "settings" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InvalidEmailTemplate_400`, `InvalidWhatsAppTemplate_400`, `SettingsNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /settings`" }, "response": [] } ] }, { "name": "White labelling", "description": "2 endpoints.", "item": [ { "name": "GET /white-labelling", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/white-labelling", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "white-labelling" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `SettingsNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /white-labelling`" }, "response": [] }, { "name": "PUT /white-labelling", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"appUrl\": \"\",\n \"appLogo\": \"\",\n \"appDarkLogo\": \"\",\n \"appFavLogo\": \"\",\n \"appSmallLogo\": \"\",\n \"appDarkSmallLogo\": \"\",\n \"appEmailLogo\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/white-labelling", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "white-labelling" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `SettingsNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /white-labelling`" }, "response": [] } ] }, { "name": "Members", "description": "10 endpoints.", "item": [ { "name": "GET /member", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Member objects in `data` (247 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `company`, `role`, `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /member`" }, "response": [] }, { "name": "POST /member", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"\",\n \"permission\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `email`.\n\nReturns one Member object in `data` (247 fields).\n\nErrors: `MemberAlredyExists_400`, `RoleOrPermissionRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /member`" }, "response": [] }, { "name": "DELETE /member", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /member`" }, "response": [] }, { "name": "GET /member/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/member/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nErrors: `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /member/:id`" }, "response": [] }, { "name": "PUT /member/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"\",\n \"permission\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/member/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nErrors: `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /member/:id`" }, "response": [] }, { "name": "PUT /member/block/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/member/block/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", "block", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `MemberNotAccepted_400`, `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /member/block/:id`" }, "response": [] }, { "name": "POST /member/bulk", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": []\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/member/bulk", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", "bulk" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `data`, `email`, `role`.\n\nReturns one Member object in `data` (247 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /member/bulk`" }, "response": [] }, { "name": "ALL /member/invite/:id", "request": { "method": "ALL", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/member/invite/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", "invite", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `MemberNotFound_404`, `MemberNotInvited_400`.\n\nDocs: https://docs.leadx.in/reference — `ALL /member/invite/:id`" }, "response": [] }, { "name": "PUT /member/transfer-ownership/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/member/transfer-ownership/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", "transfer-ownership", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `DefaultRoleNotFound_404`, `InvalidMemberStatus_400`, `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /member/transfer-ownership/:id`" }, "response": [] }, { "name": "PUT /member/unblock/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/member/unblock/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "member", "unblock", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `MemberNotBlocked_400`, `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /member/unblock/:id`" }, "response": [] } ] }, { "name": "Roles", "description": "5 endpoints.", "item": [ { "name": "GET /role", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "role" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Role objects in `data` (199 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /role`" }, "response": [] }, { "name": "POST /role", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"permission\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "role" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Role object in `data` (199 fields).\n\nErrors: `RoleNameAlreadyExists_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /role`" }, "response": [] }, { "name": "DELETE /role", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "role" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nErrors: `DefaultRoleNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /role`" }, "response": [] }, { "name": "GET /role/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/role/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "role", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Role object in `data` (199 fields).\n\nPopulated: `createdBy updatedBy`.\n\nErrors: `RoleNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /role/:id`" }, "response": [] }, { "name": "PUT /role/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"permission\": \"\",\n \"isDefault\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/role/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "role", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `name`.\n\nReturns one Role object in `data` (199 fields).\n\nErrors: `RoleNameAlreadyExists_400`, `RoleNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /role/:id`" }, "response": [] } ] }, { "name": "API keys", "description": "4 endpoints.", "item": [ { "name": "GET /api", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/api", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "api" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Api objects in `data` (11 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /api`" }, "response": [] }, { "name": "POST /api", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ipRestriction\": \"open\",\n \"type\": \"permanent\",\n \"durationMinutes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/api", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "api" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Api object in `data` (11 fields).\n\nErrors: `DurationRequired_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /api`" }, "response": [] }, { "name": "DELETE /api", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/api", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "api" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /api`" }, "response": [] }, { "name": "GET /api/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/api/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "api", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Api object in `data` (11 fields).\n\nErrors: `ApiNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /api/:id`" }, "response": [] } ] }, { "name": "Files", "description": "5 endpoints.", "item": [ { "name": "GET /file", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/file", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "file" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of File objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /file`" }, "response": [] }, { "name": "DELETE /file", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [],\n \"nids\": [],\n \"selectAll\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/file", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "file" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /file`" }, "response": [] }, { "name": "GET /file/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/file/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "file", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one File object in `data` (20 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /file/:id`" }, "response": [] }, { "name": "GET /file/recycle-bin", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/file/recycle-bin", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "file", "recycle-bin" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of File objects in `data` (20 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /file/recycle-bin`" }, "response": [] }, { "name": "DELETE /file/recycle-bin", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/file/recycle-bin", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "file", "recycle-bin" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns `data: null` — the outcome is the status code and message.\n\nDocs: https://docs.leadx.in/reference — `DELETE /file/recycle-bin`" }, "response": [] } ] }, { "name": "Upload", "description": "1 endpoint.", "item": [ { "name": "POST /upload", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"\",\n \"size\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "upload" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one File object in `data` (20 fields).\n\nDocs: https://docs.leadx.in/reference — `POST /upload`" }, "response": [] } ] }, { "name": "Timezones", "description": "8 endpoints.", "item": [ { "name": "GET /timezone", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "limit", "value": "50", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "offset", "value": "", "disabled": true }, { "key": "isdst", "value": "", "disabled": true }, { "key": "sort", "value": "offset,option", "disabled": true }, { "key": "global", "value": "true", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /timezone`" }, "response": [] }, { "name": "POST /timezone", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"abbr\": \"\",\n \"offset\": \"\",\n \"isdst\": \"\",\n \"option\": \"\",\n \"utc\": \"\",\n \"isActive\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/timezone", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nPopulated: `updatedBy`, `createdBy`.\n\nErrors: `DuplicateTimezone_409`, `ValidationError_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /timezone`" }, "response": [] }, { "name": "GET /timezone/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nPopulated: `updatedBy`, `createdBy`.\n\nErrors: `TimezoneNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `GET /timezone/:id`" }, "response": [] }, { "name": "PUT /timezone/:id", "request": { "method": "PUT", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nPopulated: `updatedBy`, `createdBy`.\n\nErrors: `DuplicateTimezone_409`, `TimezoneNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `PUT /timezone/:id`" }, "response": [] }, { "name": "DELETE /timezone/:id", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nErrors: `TimezoneNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /timezone/:id`" }, "response": [] }, { "name": "POST /timezone/initialize", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/initialize", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", "initialize" ], "query": [ { "key": "force", "value": "false", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nErrors: `FileNotFound_404`, `InvalidDataFormat_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /timezone/initialize`" }, "response": [] }, { "name": "GET /timezone/search", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", "search" ], "query": [ { "key": "q", "value": "", "disabled": true }, { "key": "limit", "value": "20", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /timezone/search`" }, "response": [] }, { "name": "GET /timezone/stats", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/timezone/stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "timezone", "stats" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Timezone object in `data` (11 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /timezone/stats`" }, "response": [] } ] }, { "name": "Geography", "description": "1 endpoint.", "item": [ { "name": "GET /geography/search", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/geography/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "geography", "search" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /geography/search`" }, "response": [] } ] }, { "name": "Test utilities", "description": "2 endpoints.", "item": [ { "name": "POST /test/sendEmail", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/test/sendEmail", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "test", "sendEmail" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /test/sendEmail`" }, "response": [] }, { "name": "POST /test/sendTemplate", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/test/sendTemplate", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "test", "sendTemplate" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /test/sendTemplate`" }, "response": [] } ] }, { "name": "Session-only endpoints", "description": "16 endpoints.", "item": [ { "name": "PUT /change-password", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/change-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "change-password" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nRequired: `password`, `newPassword`.\n\nReturns one User object in `data` (33 fields).\n\nErrors: `InvalidPassword_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /change-password`" }, "response": [] }, { "name": "POST /company", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"contactNumber\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/company", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "company" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nRequired: `name`, `email`, `countryCode`, `number`, `timezone`.\n\nErrors: `InvalidTimezone_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /company`" }, "response": [] }, { "name": "ALL /country-state-city", "request": { "method": "ALL", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/country-state-city", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "country-state-city" ], "query": [ { "key": "country", "value": "", "disabled": true }, { "key": "state", "value": "", "disabled": true } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nErrors: `CountryNotFound_400`, `StateNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `ALL /country-state-city`" }, "response": [] }, { "name": "ALL /currencies", "request": { "method": "ALL", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/currencies", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "currencies" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nDocs: https://docs.leadx.in/reference — `ALL /currencies`" }, "response": [] }, { "name": "POST /invite/:id", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/invite/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "invite", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nRequired: `id`, `status`.\n\nReturns one Member object in `data` (247 fields).\n\nErrors: `InvalidInviteStatus_400`, `InviteExpired_400`, `MemberNotFound_404`.\n\nDocs: https://docs.leadx.in/reference — `POST /invite/:id`" }, "response": [] }, { "name": "GET /invites", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/invites", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "invites" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns an array of Member objects in `data` (247 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `company`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /invites`" }, "response": [] }, { "name": "GET /memberships", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/memberships", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "memberships" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns an array of Member objects in `data` (247 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `company`.\n\nDocs: https://docs.leadx.in/reference — `GET /memberships`" }, "response": [] }, { "name": "GET /memberships/:id", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/memberships/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "memberships", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `company role`.\n\nDocs: https://docs.leadx.in/reference — `GET /memberships/:id`" }, "response": [] }, { "name": "GET /partner-program", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/partner-program", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "partner-program" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nDocs: https://docs.leadx.in/reference — `GET /partner-program`" }, "response": [] }, { "name": "GET /partner-program/referrals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/partner-program/referrals", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "partner-program", "referrals" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns one PartnerProgram object in `data` (17 fields).\n\nDocs: https://docs.leadx.in/reference — `GET /partner-program/referrals`" }, "response": [] }, { "name": "POST /partner-program/request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"requestNote\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/partner-program/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "partner-program", "request" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nErrors: `PartnerProgramAlreadyApproved_400`, `PartnerProgramAlreadyRequested_400`, `PartnerProgramRevoked_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /partner-program/request`" }, "response": [] }, { "name": "GET /profile", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "profile" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns one Member object in `data` (247 fields).\n\nPopulated: `role user`.\n\nDocs: https://docs.leadx.in/reference — `GET /profile`" }, "response": [] }, { "name": "PUT /profile", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"aiOnboarded\": \"\",\n \"onboarded\": \"\",\n \"layout\": \"\",\n \"darkMode\": \"\",\n \"columns\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "profile" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nDocs: https://docs.leadx.in/reference — `PUT /profile`" }, "response": [] }, { "name": "GET /refer-program", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/refer-program", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "refer-program" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nDocs: https://docs.leadx.in/reference — `GET /refer-program`" }, "response": [] }, { "name": "PUT /refer-program", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/private/refer-program", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "refer-program" ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns one ReferProgram object in `data` (11 fields).\n\nErrors: `InvalidReferProgramStatus_400`.\n\nDocs: https://docs.leadx.in/reference — `PUT /refer-program`" }, "response": [] }, { "name": "GET /refer-program/referrals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{jwt}}" } ], "url": { "raw": "{{baseUrl}}/api/private/refer-program/referrals", "host": [ "{{baseUrl}}" ], "path": [ "api", "private", "refer-program", "referrals" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "**Session JWT only.** An API key cannot reach `/api/private`; send an `Authorization: Bearer ` header instead of `apikey`.\n\nReturns an array of User objects in `data` (33 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nDocs: https://docs.leadx.in/reference — `GET /refer-program/referrals`" }, "response": [] } ] } ] }, { "name": "Billing", "description": "Plans, subscriptions, payment providers and invoices.", "item": [ { "name": "Plans", "description": "2 endpoints.", "item": [ { "name": "GET /plans", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/plans", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "plans" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Plan objects in `data` (41 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`.\n\nDocs: https://docs.leadx.in/reference — `GET /plans`" }, "response": [] }, { "name": "GET /plans/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/plans/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "plans", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Plan object in `data` (41 fields).\n\nErrors: `PlanNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /plans/:id`" }, "response": [] } ] }, { "name": "Subscriptions", "description": "12 endpoints.", "item": [ { "name": "POST /subscription", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `POST /subscription`" }, "response": [] }, { "name": "DELETE /subscription/:subscriptionId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Subscription object in `data` (78 fields).\n\nPopulated: `planDetails.features.feature changeRequest`.\n\nErrors: `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /subscription/:subscriptionId`" }, "response": [] }, { "name": "POST /subscription/change", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/change", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "change" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `plan`, `users`, `billingCycle`.\n\nErrors: `PlanMaxUsers_400`, `PlanMinUsers_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /subscription/change`" }, "response": [] }, { "name": "DELETE /subscription/current", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/current", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "current" ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Subscription object in `data` (78 fields).\n\nPopulated: `planDetails.features.feature changeRequest`.\n\nErrors: `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `DELETE /subscription/current`" }, "response": [] }, { "name": "GET /subscription/history", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/history", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "history" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /subscription/history`" }, "response": [] }, { "name": "GET /subscription/list", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "list" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /subscription/list`" }, "response": [] }, { "name": "POST /subscription/preview", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "preview" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `plan`, `users`, `billingCycle`.\n\nErrors: `PlanMaxUsers_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /subscription/preview`" }, "response": [] }, { "name": "DELETE /subscription/queued", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/queued", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "queued" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /subscription/queued`" }, "response": [] }, { "name": "DELETE /subscription/queued/:subscriptionId", "request": { "method": "DELETE", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/queued/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "queued", ":subscriptionId" ], "variable": [ { "key": "subscriptionId", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `DELETE /subscription/queued/:subscriptionId`" }, "response": [] }, { "name": "POST /subscription/seats/change", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/seats/change", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "seats", "change" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `seats`.\n\nErrors: `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /subscription/seats/change`" }, "response": [] }, { "name": "POST /subscription/seats/preview", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/seats/preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "seats", "preview" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `seats`.\n\nDocs: https://docs.leadx.in/reference — `POST /subscription/seats/preview`" }, "response": [] }, { "name": "GET /subscription/upcoming", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/subscription/upcoming", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "subscription", "upcoming" ] }, "description": "Authenticated with the `apikey` header.\n\nDocs: https://docs.leadx.in/reference — `GET /subscription/upcoming`" }, "response": [] } ] }, { "name": "Transactions", "description": "3 endpoints.", "item": [ { "name": "GET /transaction-history", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/transaction-history", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "transaction-history" ], "query": [ { "key": "p", "value": "1", "description": "Page number.", "disabled": true }, { "key": "n", "value": "25", "description": "Page size.", "disabled": true }, { "key": "sortBy", "value": "createdAt", "description": "Field to sort on.", "disabled": true }, { "key": "sortOrder", "value": "desc", "description": "`asc` or `desc`.", "disabled": true }, { "key": "searchBy", "value": "", "description": "Comma-separated fields to search.", "disabled": true }, { "key": "searchValue", "value": "", "description": "What to search for.", "disabled": true }, { "key": "filters", "value": "", "description": "JSON filter object.", "disabled": true }, { "key": "advancedFilters", "value": "", "description": "JSON advanced filter tree.", "disabled": true }, { "key": "ids", "value": "", "description": "Restrict to these ids.", "disabled": true }, { "key": "nids", "value": "", "description": "Exclude these ids.", "disabled": true } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns an array of Payment objects in `data` (19 fields each), plus `totalCount`, `p` and `n` at the top level.\n\nPopulated: `updatedBy`, `createdBy`, `subscription`.\n\nDocs: https://docs.leadx.in/reference — `GET /transaction-history`" }, "response": [] }, { "name": "GET /transaction-history/:id", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/transaction-history/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "transaction-history", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nReturns one Payment object in `data` (19 fields).\n\nErrors: `transactionHistoryNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /transaction-history/:id`" }, "response": [] }, { "name": "GET /transaction-history/:id/invoice", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/transaction-history/:id/invoice", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "transaction-history", ":id", "invoice" ], "variable": [ { "key": "id", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `InvoiceNotGenerated_400`, `transactionHistoryNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /transaction-history/:id/invoice`" }, "response": [] } ] }, { "name": "Coupons", "description": "1 endpoint.", "item": [ { "name": "GET /coupons/:code", "request": { "method": "GET", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/coupons/:code", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "coupons", ":code" ], "variable": [ { "key": "code", "value": "", "description": "Required." } ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `code`.\n\nReturns one Coupon object in `data` (12 fields).\n\nErrors: `CouponInvalid_400`.\n\nDocs: https://docs.leadx.in/reference — `GET /coupons/:code`" }, "response": [] } ] }, { "name": "Razorpay", "description": "2 endpoints.", "item": [ { "name": "POST /razorpay", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/razorpay", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "razorpay" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /razorpay`" }, "response": [] }, { "name": "POST /razorpay/capture", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" } ], "url": { "raw": "{{baseUrl}}/api/key/protected/razorpay/capture", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "razorpay", "capture" ] }, "description": "Authenticated with the `apikey` header.\n\nErrors: `PaymentNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /razorpay/capture`" }, "response": [] } ] }, { "name": "Stripe", "description": "1 endpoint.", "item": [ { "name": "POST /stripe", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/stripe", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "stripe" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /stripe`" }, "response": [] } ] }, { "name": "PayPal", "description": "1 endpoint.", "item": [ { "name": "POST /paypal", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/paypal", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "paypal" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /paypal`" }, "response": [] } ] }, { "name": "PayU", "description": "1 endpoint.", "item": [ { "name": "POST /payu", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/payu", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "payu" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /payu`" }, "response": [] } ] }, { "name": "PhonePe", "description": "1 endpoint.", "item": [ { "name": "POST /phonepe", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/phonepe", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "phonepe" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /phonepe`" }, "response": [] } ] }, { "name": "Manual payment", "description": "1 endpoint.", "item": [ { "name": "POST /manual-payment", "request": { "method": "POST", "header": [ { "key": "apikey", "value": "{{apikey}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"manualPaymentID\": \"\",\n \"subscriptionID\": \"\",\n \"seatsPaymentHistoryID\": \"\",\n \"proof\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/key/protected/manual-payment", "host": [ "{{baseUrl}}" ], "path": [ "api", "key", "protected", "manual-payment" ] }, "description": "Authenticated with the `apikey` header.\n\nRequired: `manualPaymentID`, `proof`, `subscriptionID`.\n\nReturns one ManualPayment object in `data` (8 fields).\n\nErrors: `ManualPaymentDetailsNotFound_400`, `SubscriptionNotFound_400`.\n\nDocs: https://docs.leadx.in/reference — `POST /manual-payment`" }, "response": [] } ] } ] } ] }