Hello world
" }, "cc": { "type": "string", "description": "CC recipients (optional)" }, "bcc": { "type": "string", "description": "BCC recipients (optional)" }, "lead_id": { "type": "string", "description": "Associate email with a contact ID (optional)" }, "opportunity_id": { "type": "string", "description": "Associate email with an opportunity ID (optional)" }, "signature_id": { "type": "string", "description": "Append this signature to the email (optional, get from signatures/get)" }, "tracking": { "type": "string", "description": "Enable open tracking, set to \"y\" (optional)" } }, "required": [ "token", "to", "subject", "html" ] } } } } } }, "/api/1.0/emails/get.json": { "post": { "operationId": "email_get_inbox", "summary": "Get emails from inbox or sent folder", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "type": { "type": "string", "description": "Folder: \"inbox\" (default) or \"sent\"", "example": "inbox" }, "var_resultspage": { "type": "string", "description": "Maximum number of results", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" }, "search_value": { "type": "string", "description": "Search in subject (optional)" }, "unread_only": { "type": "string", "description": "Show only unread, set to \"y\" (optional)" } }, "required": [ "token", "type", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/emails/getone.json": { "post": { "operationId": "email_get_one", "summary": "Get a single email with full body", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "email_id": { "type": "string", "description": "ID of the email" } }, "required": [ "token", "email_id" ] } } } } } }, "/api/1.0/emails/signatures/get.json": { "post": { "operationId": "email_get_signatures", "summary": "Get all email signatures", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/emails/signatures/save.json": { "post": { "operationId": "email_save_signature", "summary": "Create or update an email signature", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "signature_id": { "type": "string", "description": "ID of signature to update (omit to create new)" }, "name": { "type": "string", "description": "Signature name", "example": "My Signature" }, "html": { "type": "string", "description": "Signature HTML content", "example": "Best regards
" }, "is_default": { "type": "string", "description": "Set as default signature, \"true\" or \"false\"", "example": "false" } }, "required": [ "token", "signature_id", "name", "html", "is_default" ] } } } } } }, "/api/1.0/emails/signatures/delete.json": { "post": { "operationId": "email_delete_signature", "summary": "Delete an email signature", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "signature_id": { "type": "string", "description": "ID of the signature to delete" } }, "required": [ "token", "signature_id" ] } } } } } }, "/api/1.0/emails/templates/get.json": { "post": { "operationId": "email_get_templates", "summary": "Get all email templates", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/emails/templates/create.json": { "post": { "operationId": "email_create_template", "summary": "Create a new email template", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "name": { "type": "string", "description": "Template name", "example": "My Template" }, "subject": { "type": "string", "description": "Default email subject (optional)" }, "html": { "type": "string", "description": "Template HTML content", "example": "Hello {{name}}
" } }, "required": [ "token", "name", "html" ] } } } } } }, "/api/1.0/emails/templates/edit.json": { "post": { "operationId": "email_edit_template", "summary": "Edit an email template", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "template_id": { "type": "string", "description": "ID of the template to edit" }, "name": { "type": "string", "description": "Template name (optional)" }, "subject": { "type": "string", "description": "Default email subject (optional)" }, "html": { "type": "string", "description": "Template HTML content (optional)" } }, "required": [ "token", "template_id" ] } } } } } }, "/api/1.0/emails/templates/delete.json": { "post": { "operationId": "email_delete_template", "summary": "Delete an email template", "tags": [ "emails" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "template_id": { "type": "string", "description": "ID of the template to delete" } }, "required": [ "token", "template_id" ] } } } } } }, "/api/1.0/phonenumbers/countries.json": { "get": { "operationId": "phonenumbers_get_countries", "summary": "Get all countries with phone numbers available for purchase: ISO code, name, phone prefix, available number types and how many area groups each one has. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } } ] } }, "/api/1.0/phonenumbers/did_groups.json": { "get": { "operationId": "phonenumbers_get_did_groups", "summary": "Get purchasable number groups (area codes) of a country with client prices in EUR. Each group lists its SKUs (capacity plans): setup and monthly price, included channels, per-minute incoming cost (coste_xmin/coste_xllam, 0 for flat-rate plans) and whether the plan is sellable. needs_registration=true means identity documents are required after purchase. Global/UIFN groups are returned for any country. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "country", "in": "query", "required": true, "description": "Country ISO2 code (e.g. ES, GB, US)", "schema": { "type": "string", "example": "ES" } }, { "name": "type", "in": "query", "required": false, "description": "Filter by group type: Local, National, Mobile, Toll-free, Shared Cost, Global (optional)", "schema": { "type": "string" } }, { "name": "q", "in": "query", "required": false, "description": "Search by area name or prefix (optional)", "schema": { "type": "string" } } ] } }, "/api/1.0/phonenumbers/available_dids.json": { "get": { "operationId": "phonenumbers_get_available_dids", "summary": "Get the specific numbers available to pick inside a DID group (live from the provider). If the list is empty a new random number can still be ordered (new_number_available is always true). Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "did_group", "in": "query", "required": true, "description": "DID group id (from did_groups.json)", "schema": { "type": "string" } } ] } }, "/api/1.0/phonenumbers/order.json": { "post": { "operationId": "phonenumbers_order", "summary": "Buy a phone number: creates the order at the provider, charges the voice credit balance and assigns the line to a PBX (creates a new PBX with a default IVR if none is given). If needs_registration is true the number requires identity verification (see requirements, identity and identity_submit endpoints). The line starts as activating (estado 0) and switches to active automatically when the provider confirms. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "did_group_id": { "type": "string", "description": "DID group id (from did_groups.json)" }, "sku_id": { "type": "string", "description": "Capacity plan SKU id of the group (from did_groups.json, only sellable SKUs)" }, "available_did_id": { "type": "string", "description": "Specific number picked from available_dids.json; omit to get a new random number (optional)" }, "idcampanadondecrear": { "type": "integer", "description": "PBX id where to attach the number; omit to create a new PBX with a default IVR (optional)" }, "lang": { "type": "string", "description": "2-letter language for the default IVR TTS voice when a new PBX is created (optional, default en)" } }, "required": [ "token", "did_group_id", "sku_id" ] } } } } } }, "/api/1.0/phonenumbers/requirements.json": { "get": { "operationId": "phonenumbers_get_requirements", "summary": "Get the regulatory registration requirements of a DID group: accepted identity/address proof types, mandatory identity fields and permanent document templates. Returns needs_registration=false with an empty list when no registration is needed. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "did_group_id", "in": "query", "required": true, "description": "DID group id (from did_groups.json)", "schema": { "type": "string" } } ] } }, "/api/1.0/phonenumbers/identity.json": { "post": { "operationId": "phonenumbers_create_identity", "summary": "Create a regulatory identity with its address at the provider (needed for numbers with needs_registration). Returns identity_id and address_id to use with identity_document.json and identity_submit.json. The identity is saved and reusable for future numbers (see identities_list.json). Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "identity.identity_type": { "type": "string", "description": "Identity type: personal or business", "example": "personal" }, "identity.first_name": { "type": "string", "description": "First name (or legal representative for business)" }, "identity.last_name": { "type": "string", "description": "Last name" }, "identity.phone_number": { "type": "string", "description": "Contact phone number with international prefix" }, "identity.company_name": { "type": "string", "description": "Company name (business identities)" }, "identity.company_reg_number": { "type": "string", "description": "Company registration number (if required by the country)" }, "identity.vat_id": { "type": "string", "description": "VAT id (if required by the country)" }, "identity.personal_tax_id": { "type": "string", "description": "Personal tax id (if required by the country)" }, "identity.id_number": { "type": "string", "description": "Personal id/passport number (if required by the country)" }, "identity.birth_date": { "type": "string", "description": "Birth date YYYY-MM-DD (if required by the country)" }, "identity.contact_email": { "type": "string", "description": "Contact email (optional)" }, "address.country_iso": { "type": "string", "description": "Address country ISO2 code", "example": "ES" }, "address.city_name": { "type": "string", "description": "City" }, "address.postal_code": { "type": "string", "description": "Postal code" }, "address.address": { "type": "string", "description": "Street address" }, "address.description": { "type": "string", "description": "Address description (optional)" } }, "required": [ "token", "identity.identity_type", "identity.first_name", "identity.last_name", "identity.phone_number", "identity.company_name", "identity.company_reg_number", "identity.vat_id", "identity.personal_tax_id", "identity.id_number", "identity.birth_date", "address.country_iso", "address.city_name", "address.postal_code", "address.address" ] } } } } } }, "/api/1.0/phonenumbers/identities_list.json": { "get": { "operationId": "phonenumbers_list_identities", "summary": "List the client's saved regulatory identities with their addresses and verification status, to reuse them when registering another number. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } } ] } }, "/api/1.0/phonenumbers/address.json": { "post": { "operationId": "phonenumbers_create_address", "summary": "Add an additional address to one of the client's existing regulatory identities (identity reuse for a number in another city/country). Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "identity_id": { "type": "string", "description": "Identity id owned by the client (from identities_list.json)" }, "address.country_iso": { "type": "string", "description": "Address country ISO2 code", "example": "ES" }, "address.city_name": { "type": "string", "description": "City" }, "address.postal_code": { "type": "string", "description": "Postal code" }, "address.address": { "type": "string", "description": "Street address" }, "address.description": { "type": "string", "description": "Address description (optional)" } }, "required": [ "token", "identity_id", "address.country_iso", "address.city_name", "address.postal_code", "address.address" ] } } } } } }, "/api/1.0/phonenumbers/identity_document.json": { "post": { "operationId": "phonenumbers_upload_identity_document", "summary": "Upload a verification document (multipart form-data, field name: file; pdf/jpg/png, max 20MB). The file is encrypted client-side before being sent to the provider. kind=proof_identity links it to an identity (needs proof_type_id), kind=proof_address to an address (needs proof_type_id and address_id), kind=permanent_document to a permanent template (needs template_id). Proof type and template ids come from requirements.json. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "file": { "type": "file", "description": "Document file (multipart form-data; pdf, jpg or png, max 20MB)" }, "kind": { "type": "string", "description": "Document kind: proof_identity, proof_address or permanent_document", "example": "proof_identity" }, "identity_id": { "type": "string", "description": "Identity id owned by the client (required for proof_identity and permanent_document)" }, "proof_type_id": { "type": "string", "description": "Proof type id from requirements.json (required for proof_identity and proof_address)" }, "address_id": { "type": "string", "description": "Address id the proof belongs to (required for proof_address)" }, "template_id": { "type": "string", "description": "Permanent document template id from requirements.json (required for permanent_document)" }, "description": { "type": "string", "description": "File description (optional)" } }, "required": [ "token", "file", "kind", "identity_id", "proof_type_id", "address_id", "template_id" ] } } } } } }, "/api/1.0/phonenumbers/identity_submit.json": { "post": { "operationId": "phonenumbers_submit_identity", "summary": "Submit the address verification of a purchased number for provider review. Optionally pre-validates against the address requirement so missing data is reported instantly (validation_failed) instead of days later as a rejection. On approval the line is activated automatically and the user gets a push notification. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "did_id": { "type": "string", "description": "DID id of the purchased number (returned by order.json)" }, "address_id": { "type": "string", "description": "Address id of one of the client's identities" }, "identity_id": { "type": "string", "description": "Identity id, when the address alone is ambiguous (optional)" }, "address_requirement_id": { "type": "string", "description": "Address requirement id from requirements.json to pre-validate before submitting (optional, recommended)" }, "service_description": { "type": "string", "description": "Short description of the service using the number (optional, default: CRM phone line)" } }, "required": [ "token", "did_id", "address_id" ] } } } } } }, "/api/1.0/phonenumbers/identity_status.json": { "get": { "operationId": "phonenumbers_get_identity_status", "summary": "Get the live verification status of a number registration (pending, approved or rejected with reject reasons). If the provider already approved it, the line is activated on the spot. Pass did_id or verification_id. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "did_id", "in": "query", "required": true, "description": "DID id of the number (alternative to verification_id)", "schema": { "type": "string" } }, { "name": "verification_id", "in": "query", "required": true, "description": "Verification id returned by identity_submit.json (alternative to did_id)", "schema": { "type": "string" } } ] } }, "/api/1.0/phonenumbers/pending_registrations.json": { "get": { "operationId": "phonenumbers_get_pending_registrations", "summary": "Get the client's numbers with identity registration pending (not sent, in review or rejected) plus the numbers still activating (bought without registration, waiting for provider confirmation, last 72h). Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } } ] } }, "/api/1.0/phonenumbers/capacity_info.json": { "get": { "operationId": "phonenumbers_get_capacity_info", "summary": "Get the current channel capacity of a phone line (included and dedicated channels) and the monthly price per extra dedicated channel in EUR. pool_disponible=false means extra channels are not available for that country. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "phoneline", "in": "query", "required": true, "description": "Phone line number (digits only, with country prefix)", "schema": { "type": "string", "example": "34930000000" } } ] } }, "/api/1.0/phonenumbers/contract_channels.json": { "post": { "operationId": "phonenumbers_contract_channels", "summary": "Buy extra dedicated channels for a phone line (1 to 50). Charges the voice credit balance, expands the DID capacity at the provider and adds the price to the line's monthly renewal. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "phoneline": { "type": "string", "description": "Phone line number (digits only, with country prefix)", "example": "34930000000" }, "channels": { "type": "integer", "description": "Number of dedicated channels to add (1-50)", "example": "1" } }, "required": [ "token", "phoneline", "channels" ] } } } } } }, "/api/1.0/phonenumbers/move.json": { "post": { "operationId": "phonenumbers_move", "summary": "Move a phone number to another PBX of the same client, or create a new PBX (with a default IVR) and move it there. Identify the line with phoneline or id_alias; set to_pbx_id for an existing PBX or new_pbx=true to create one. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "phoneline": { "type": "string", "description": "Phone line number to move (alternative to id_alias)", "example": "34930000000" }, "id_alias": { "type": "integer", "description": "Internal line id (alternative to phoneline)" }, "to_pbx_id": { "type": "integer", "description": "Destination PBX id (required unless new_pbx is true)" }, "new_pbx": { "type": "boolean", "description": "Set to true to create a new PBX and move the number there" }, "new_pbx_name": { "type": "string", "description": "Name for the new PBX (optional, only with new_pbx)" }, "lang": { "type": "string", "description": "2-letter language for the new PBX default IVR TTS voice (optional, default en)" } }, "required": [ "token", "phoneline", "id_alias", "to_pbx_id", "new_pbx" ] } } } } } }, "/api/1.0/phonenumbers/clone_pbx.json": { "post": { "operationId": "phonenumbers_clone_pbx", "summary": "Clone a PBX: campaign, configuration and all call-flow nodes (node links are remapped). Phone numbers are NOT cloned. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "pbx_id": { "type": "integer", "description": "PBX id to clone (must belong to the client)" }, "new_name": { "type": "string", "description": "Name for the cloned PBX (optional, default: original name + (copy))" } }, "required": [ "token", "pbx_id" ] } } } } } }, "/api/1.0/phonenumbers/delete.json": { "post": { "operationId": "phonenumber_delete", "summary": "Cancel a phone line: terminates the number at the provider and removes the line. The purchase is refunded in credits only if cancelled the same month it was bought. The cancellation is irreversible. Requires phone numbers management permission.", "tags": [ "phonenumbers" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "phoneline": { "type": "string", "description": "Phone line number to cancel (digits only, with country prefix)", "example": "34930000000" } }, "required": [ "token", "phoneline" ] } } } } } }, "/api/1.0/domains/check.json": { "get": { "operationId": "domain_check_availability", "summary": "Check domain availability and pricing. Returns availability status, price in credits, original price, current balance and whether the user can afford it.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "domain", "in": "query", "required": true, "description": "Domain name to check (e.g. example.com)", "schema": { "type": "string" } } ] } }, "/api/1.0/domains/register.json": { "post": { "operationId": "domain_register", "summary": "Register (buy) a new domain. Requires registrant contact info. Saves domain with status pending_verification, deducts credits from balance. Domain must be activated after email verification.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to register" }, "years": { "type": "integer", "description": "Number of years to register (default: 1)", "example": "1" }, "contact.firstName": { "type": "string", "description": "Registrant first name" }, "contact.lastName": { "type": "string", "description": "Registrant last name" }, "contact.address1": { "type": "string", "description": "Registrant address" }, "contact.city": { "type": "string", "description": "Registrant city" }, "contact.state": { "type": "string", "description": "Registrant state/province" }, "contact.postalCode": { "type": "string", "description": "Registrant postal code" }, "contact.country": { "type": "string", "description": "Registrant country code (e.g. ES, US)" }, "contact.phone": { "type": "string", "description": "Registrant phone (e.g. +34.612345678)" }, "contact.email": { "type": "string", "description": "Registrant email" }, "contact.org": { "type": "string", "description": "Registrant organization (optional)" }, "dnsRecords": { "type": "array", "description": "DNS records to configure (optional, uses defaults if not provided)" }, "nameservers": { "type": "array", "description": "Custom nameservers (optional)" }, "mail": { "type": "boolean", "description": "Enable mail configuration (optional)" }, "defaultDns": { "type": "boolean", "description": "Use default DNS records (optional)" } }, "required": [ "token", "domain", "years", "contact.firstName", "contact.lastName", "contact.address1", "contact.city", "contact.state", "contact.postalCode", "contact.country", "contact.phone", "contact.email" ] } } } } } }, "/api/1.0/domains/activate.json": { "post": { "operationId": "domain_activate", "summary": "Activate a pending domain after verification. Configures DNS records, registers domain in the mail server, creates reverse proxy routes for HTTPS (domain + www), sets default services (mail, web) and marks status as active.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to activate" } }, "required": [ "token", "domain" ] } } } } } }, "/api/1.0/domains/dns/add.json": { "post": { "operationId": "domain_dns_add_service", "summary": "Add or update a DNS record for a specific service (e.g. mail, web, web). Fetches existing records, adds/replaces the new one, and creates a reverse proxy route with automatic HTTPS if the service requires it.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name" }, "type": { "type": "string", "description": "DNS record type (default: A)", "example": "A" }, "name": { "type": "string", "description": "DNS record name (default: @)", "example": "@" }, "content": { "type": "string", "description": "DNS record content (IP address or hostname)" }, "ttl": { "type": "integer", "description": "TTL in seconds (default: 1800)", "example": "1800" }, "server": { "type": "string", "description": "Service key for tracking (e.g. mail, crm, web). Used to create reverse proxy route and save service status." }, "priority": { "type": "integer", "description": "Priority for MX records (optional)" } }, "required": [ "token", "domain", "type", "name", "content", "ttl", "server" ] } } } } } }, "/api/1.0/domains/servers.json": { "get": { "operationId": "domain_get_services", "summary": "Get the status of all configured services for a domain. Returns each service key, status, host and value.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "domain", "in": "query", "required": true, "description": "Domain name to query", "schema": { "type": "string" } } ] } }, "/api/1.0/domains/managed.json": { "get": { "operationId": "domain_get_managed", "summary": "Get all domains managed by the user's company. Returns domains filtered by company_id with status, verification state, SMTP/IMAP config and services. Does not include shared platform domains.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } } ] } }, "/api/1.0/domains/add.json": { "post": { "operationId": "domain_add_custom", "summary": "Add a custom (already owned) domain for verification. Saves it with status pending_verification and returns the required DNS records. The user must configure DNS and call dns/verify.json before activation.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to add" } }, "required": [ "token", "domain" ] } } } } } }, "/api/1.0/domains/dns/verify.json": { "get": { "operationId": "domain_dns_verify", "summary": "Verify DNS configuration for a domain. Performs real DNS lookups checking MX, SPF and DMARC records. If all pass, registers the domain in the mail server and marks it as active and verified.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "description": "API access token", "schema": { "type": "string", "example": "YOUR_APIKEY" } }, { "name": "domain", "in": "query", "required": true, "description": "Domain name to verify", "schema": { "type": "string" } } ] } }, "/api/1.0/domains/delete_domain.json": { "post": { "operationId": "domain_delete", "summary": "Delete a domain completely. Removes all email accounts associated with that domain from the mail server, disconnects all agents using emails on that domain, removes all reverse proxy routes (domain, www, service subdomains), and deletes the domain record from the database. System domains cannot be deleted.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to delete" } }, "required": [ "token", "domain" ] } } } } } }, "/api/1.0/domains/renewdomain.json": { "post": { "operationId": "domain_renew", "summary": "Renew a registered domain. Verifies the domain belongs to the company, gets renewal pricing, checks credit balance, renews via the registrar, deducts credits and updates the expiry date in the database. External domains cannot be renewed from this platform. System domains cannot be renewed.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to renew" }, "years": { "type": "number", "description": "Number of years to renew (default: 1)", "example": 1 } }, "required": [ "token", "domain", "years" ] } } } } } }, "/api/1.0/domains/markasdelete.json": { "post": { "operationId": "domain_mark_delete", "summary": "Mark a domain for deletion. Changes the domain status to 'pending_delete' so it will not be automatically renewed when it expires. The domain is not deleted immediately — it remains active until expiration. System domains cannot be marked.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name to mark for deletion" } }, "required": [ "token", "domain" ] } } } } } }, "/api/1.0/domains/activate_services.json": { "post": { "operationId": "domain_activate_services", "summary": "Activate multiple services for a domain in a single API call. Accepts an array of service keys. For registered domains, creates all DNS records in a single batch call to the registrar. For external domains, verifies DNS is correctly configured before activating. Creates reverse proxy routes for each service that needs HTTPS.", "tags": [ "domains" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "domain": { "type": "string", "description": "Domain name" }, "services": { "type": "array", "description": "Array of service keys to activate: mail, web, crm, meets, infinitycloud, cabinet, webtrade", "example": [ "crm", "meets", "mail" ] } }, "required": [ "token", "domain", "services" ] } } } } } }, "/api/1.0/sendwhatsapp/getsessionsandtemplates.json": { "post": { "operationId": "whatsapp_get_sessions_and_templates", "summary": "List every WhatsApp Business session connected to this company and, for each session, its approved Meta-hosted templates. Call this BEFORE using /api/1.0/sendwhatsapp/sendmsgtemplate.json, sendmsg.json or sendfile.json, because you need a valid 'idses' (session _id) to send anything, and for templates you also need to know the exact 'name', 'language' and the 'components' array (which defines what {{1}}, {{2}}... variables each template expects, and whether the HEADER is TEXT/IMAGE/VIDEO/DOCUMENT). Returns only the fields needed for dispatch: each session's _id and name, plus a whats_templates[] array with the template name, language, status, category, id and components. The caller must then pick the right session and template based on what the user wants to send.", "tags": [ "sendwhatsapp" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/sendwhatsapp/sendmsgtemplate.json": { "post": { "operationId": "sendwhatsapp_sendmsgtemplate", "summary": "Send a pre-approved WhatsApp Business template message directly through the Meta Cloud API and return Meta's response synchronously (including the delivered message wamid on success, or Meta's error on failure). Use this to start conversations outside the 24-hour customer service window, to send transactional notifications (OTP, order updates, shipping, reminders), or to re-engage a lead when the free-form chat window is closed. MANDATORY WORKFLOW: (1) first call /api/1.0/sendwhatsapp/getsessionsandtemplates.json to discover the sessions and their approved templates; (2) pick the session 'idses' the user wants to send from and the exact 'template_name' that matches the intent; (3) inspect that template's 'components' array — if any component contains {{1}}, {{2}}, {{3}}... body variables, pass the matching values inside the simplified 'variables' field (the server auto-inspects the template and places each value in the correct Meta slot — you do NOT need to build the Meta components array yourself). If the template has ZERO body variables and no TEXT header variable, simply omit 'variables' entirely. IMPORTANT — MEDIA HEADERS (IMAGE/VIDEO/DOCUMENT): do NOT ask the user for a media URL and do NOT send 'variables.header' for these. The server auto-loads the media from the file that was originally uploaded with the template (infinitycloud), falling back to Meta's stored example. Only pass 'variables.header' as a media URL if the user explicitly asks to override the template's attached file with a different one. Never invent variable values — if the user did not provide body/text values, ask first. Unlike the old queue-based behaviour, this endpoint now POSTs to Meta synchronously: a successful response returns 'wamid' from Meta, and a failure returns status:'error' with the Meta error embedded.", "tags": [ "sendwhatsapp" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" }, "idses": { "type": "string", "description": "WhatsApp session _id (24-char Mongo ObjectId) identifying which WhatsApp Business number sends the message. Obtain it from /api/1.0/sendwhatsapp/getsessionsandtemplates.json. Required." }, "to": { "type": "string", "description": "Recipient phone number in full international format, digits only, no '+' sign, no spaces, no dashes (e.g. 34600000000). Required.", "example": "34682288834" }, "template_name": { "type": "string", "description": "Exact 'name' field of the approved WhatsApp template to send (e.g. 'datalysewowia'). Must be one of the templates returned by getsessionsandtemplates for the chosen session. Required." }, "language": { "type": "string", "description": "Template language code (e.g. 'es', 'en_US', 'pt_BR'). Optional: defaults to the template's own language. Only override it if you know the same template has multiple approved translations." }, "variables": { "type": "object", "description": "Simplified template variables — the server auto-inspects the approved template's components and places each value in the correct Meta slot, so you do NOT build the Meta components array yourself. Shape: an object with any of these keys — 'body' is an array of strings matching the template BODY's {{1}},{{2}},... placeholders in order (e.g. body:['Marc','OFFER105']); 'header' is used ONLY when the template HEADER is TEXT with a {{1}} variable (value is the plain text) OR when the caller wants to explicitly override an IMAGE/VIDEO/DOCUMENT media template with a different public URL (normally you should NOT send 'header' for media templates — the server auto-loads the file that was uploaded with the template); 'button' is an array of URL-button values where each element is either a plain string or an object {index:N, payload:'...'} for button parameter {{1}}. Shortcuts: pass a bare array of strings (['123456','Marc']) to fill only body variables, or a bare string ('123456') for a single body variable. Count and order of 'body' entries MUST match the {{n}} placeholders in the template's BODY text — use /api/1.0/sendwhatsapp/getsessionsandtemplates.json to inspect the template first. Omit this field entirely when the template has no body variables.", "example": { "body": [ "123456" ] } }, "components": { "type": "array", "description": "ADVANCED / OPTIONAL escape hatch. Pre-built Meta Cloud API components array in the exact Meta shape (entries like {type:'body', parameters:[{type:'text', text:'...'}]}). Only use this if you are replicating an existing hand-crafted Meta payload — normally you should use the simpler 'variables' field instead and let the server build the components automatically. If both 'components' and 'variables' are provided, 'components' wins.", "example": [ { "type": "body", "parameters": [ { "type": "text", "text": "HOLA" } ] } ] } }, "required": [ "token", "idses", "to", "template_name", "variables" ] } } } } } }, "/api/1.0/sendwhatsapp/sendmsg.json": { "post": { "operationId": "whatsapp_send_message", "summary": "Send a free-form WhatsApp text message from one of the company's WhatsApp Business numbers to a single recipient. IMPORTANT: WhatsApp only allows free-form messages when the recipient has messaged the business within the last 24 hours (the 'customer service window'). If that window is closed, Meta will reject the message and you must instead use /api/1.0/sendwhatsapp/sendmsgtemplate.json with an approved template. Before calling this, pick a valid 'idses' (session _id) from /api/1.0/sendwhatsapp/getsessionsandtemplates.json — that tells you which WhatsApp number sends the message. Never invent text content; use exactly what the user asked to send.", "tags": [ "sendwhatsapp" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" }, "idses": { "type": "string", "description": "WhatsApp session _id (24-char Mongo ObjectId) identifying which WhatsApp Business number sends the message. Obtain from /api/1.0/sendwhatsapp/getsessionsandtemplates.json. Required." }, "to": { "type": "string", "description": "Recipient phone number in full international format, digits only, no '+' sign or spaces (e.g. 34600000000). Required.", "example": "34682288834" }, "text": { "type": "string", "description": "UTF-8 body of the WhatsApp message. Supports WhatsApp's basic markdown (*bold*, _italic_, ~strike~, ```mono```). Required.", "example": "hello world" } }, "required": [ "token", "idses", "to", "text" ] } } } } } }, "/api/1.0/sendwhatsapp/sendfile.json": { "post": { "operationId": "whatsapp_send_file", "summary": "Send a media or document file (image, video, audio, PDF, spreadsheet, etc.) via WhatsApp to a single recipient, from one of the company's WhatsApp Business numbers. The file MUST already be hosted on a public HTTPS URL that Meta can download (no auth, no signed-url with short TTL). Same 24-hour free-form window rule as sendmsg.json: if the recipient has not written to the business in the last 24h, use sendmsgtemplate.json instead. Meta auto-detects the media type from the URL's Content-Type, so make sure the server returns the correct MIME. Optionally provide a 'filename' (mandatory for documents if you want the recipient to see a proper name) and a 'caption' that will display under images and videos.", "tags": [ "sendwhatsapp" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" }, "idses": { "type": "string", "description": "WhatsApp session _id (24-char Mongo ObjectId) identifying which WhatsApp Business number sends the file. Obtain from /api/1.0/sendwhatsapp/getsessionsandtemplates.json. Required." }, "to": { "type": "string", "description": "Recipient phone number in full international format, digits only, no '+' sign or spaces (e.g. 34600000000). Required.", "example": "34682288834" }, "file_url": { "type": "string", "description": "Publicly reachable HTTPS URL of the file to send. Meta will fetch it; the host must serve the file without authentication and with the correct Content-Type header. Required." }, "filename": { "type": "string", "description": "Display filename (including extension) shown to the recipient — especially important for PDFs and documents. Optional for images/videos." }, "caption": { "type": "string", "description": "Optional caption text that appears under the media (images/videos only; ignored for audio and most document types)." } }, "required": [ "token", "idses", "to", "file_url" ] } } } } } }, "/api/1.0/companyuserdata/companyproperties.json": { "post": { "operationId": "get_company_properties", "summary": "Get all statuses, and additional data for company", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/companyuserdata/getallagents.json": { "post": { "operationId": "get_all_agents", "summary": "Get all agents for the company", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/payments/get.json": { "post": { "operationId": "get_payments", "summary": "Get a paginated list of payments/credits for the authenticated company. Supports filtering by payment type, lead, agent, and date range (datefrom/dateto/timezone). Dates are filtered against the payment 'date' field (unix timestamp in seconds). Use this to answer questions like 'show me payments last month', 'list credits for lead X', or 'how many payments did agent Y process in January'.", "tags": [ "payments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" }, "ispayment": { "type": "string", "description": "Filter by type: \"y\" for payments, \"n\" for credits (optional)" }, "id_lead": { "type": "string", "description": "Filter by lead ID (optional)" }, "agent_id": { "type": "string", "description": "Filter by agent ID (optional)" }, "datefrom": { "type": "string", "description": "Start date for filtering results by payment date (optional, format: YYYY-MM-DD, example: 2026-01-01). Requires dateto and timezone to apply." }, "dateto": { "type": "string", "description": "End date for filtering results by payment date (optional, format: YYYY-MM-DD, example: 2026-12-31). Requires datefrom and timezone to apply." }, "timezone": { "type": "string", "description": "Timezone for date filtering (optional, example: Europe/Madrid). Required together with datefrom and dateto." } }, "required": [ "token", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/payments/edit.json": { "post": { "operationId": "edit_payment", "summary": "Edit a payment", "tags": [ "payments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "payment_id": { "type": "string", "description": "ID of the payment to edit" }, "name": { "type": "string", "description": "Payment name (optional)" }, "agent_id": { "type": "string", "description": "Agent ID (optional)" }, "amount": { "type": "string", "description": "Payment amount (optional)" }, "amount_usd": { "type": "string", "description": "Amount in USD (optional)" }, "amount_eur": { "type": "string", "description": "Amount in EUR (optional)" }, "currency": { "type": "string", "description": "Currency code (optional)" }, "ispayment": { "type": "string", "description": "Payment type flag (optional)" }, "mt4_transtype": { "type": "string", "description": "Transaction type (optional)" } }, "required": [ "token", "payment_id" ] } } } } } }, "/api/1.0/payments/delete.json": { "post": { "operationId": "delete_payment", "summary": "Delete a payment (soft delete)", "tags": [ "payments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "payment_id": { "type": "string", "description": "ID of the payment to delete" } }, "required": [ "token", "payment_id" ] } } } } } }, "/api/1.0/leads/getactivity.json": { "post": { "operationId": "get_lead_activity", "summary": "Get activity/timeline for a contact", "tags": [ "leads" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "lead_id": { "type": "string", "description": "ID of the contact" }, "type": { "type": "string", "description": "Filter by activity type: callin, callout, email, emailin, emailout, note, sms, form_completed, etc. (optional)" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" } }, "required": [ "token", "lead_id", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/opportunities/getactivity.json": { "post": { "operationId": "get_opportunity_activity", "summary": "Get activity/timeline for an opportunity", "tags": [ "opportunities" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "opportunity_id": { "type": "string", "description": "ID of the opportunity" }, "type": { "type": "string", "description": "Filter by activity type (optional)" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" } }, "required": [ "token", "opportunity_id", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/companies/getactivity.json": { "post": { "operationId": "get_company_activity", "summary": "Get activity/timeline for a company (includes activity from contacts inside the company)", "tags": [ "companies" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "company_lead_id": { "type": "string", "description": "ID of the company" }, "type": { "type": "string", "description": "Filter by activity type (optional)" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" } }, "required": [ "token", "company_lead_id", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/tasks/getactivity.json": { "post": { "operationId": "get_task_activity", "summary": "Get activity/timeline for a task", "tags": [ "tasks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "task_id": { "type": "string", "description": "ID of the task" }, "type": { "type": "string", "description": "Filter by activity type (optional)" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" } }, "required": [ "token", "task_id", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/tickets/getactivity.json": { "post": { "operationId": "get_ticket_activity", "summary": "Get activity/timeline for a ticket", "tags": [ "tickets" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "ticket_id": { "type": "string", "description": "ID of the ticket" }, "type": { "type": "string", "description": "Filter by activity type (optional)" }, "var_resultspage": { "type": "string", "description": "Maximum number of results to display", "example": "20" }, "var_page": { "type": "string", "description": "Page number", "example": "1" } }, "required": [ "token", "ticket_id", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/companyuserdata/getpricepercredit.json": { "post": { "operationId": "get_price_per_credit", "summary": "Get price per credit for VOIP calls and SMS, balance and plan info", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/companyuserdata/agentstypes.json": { "post": { "operationId": "get_agents_types", "summary": "Get all agent types (roles) for the company, including the number of agents assigned to each type", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/companyuserdata/callerids.json": { "post": { "operationId": "get_callerids", "summary": "List ALL outbound caller IDs (phone lines) the company can dial from, filtered by agent permissions and campaign access. Returns a JSON object { status: 'ok', callerids: [...] } where 'callerids' is an array with one entry per available line — typically several entries, not just one. Each entry has a 'host' field which is the phone number in international format (digits only, no '+'), plus 'id', 'id_campana', 'pais' (ISO 3166-1 numeric country code: 724=ES, 826=GB, 840=US, 33=FR, 49=DE, 39=IT, 351=PT, 52=MX, 55=BR, 54=AR), 'alias', 'estado', and cost fields ('coste_mes', 'coste_xllam', 'coste_xmin'). Virtual rows (rotation) have 'virtual':1 and a synthetic 'host' like '9992078'. When the user asks 'dame mis callerids' / 'qué líneas tengo' / 'all my numbers', you MUST call this endpoint and show EVERY entry in the returned 'callerids' array — never truncate, never show only the first one. Use the 'host' value as the caller_id parameter when calling /api/1.0/sendvoicecall/createcall.json.", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/sendvoicecall/listaiagents.json": { "post": { "operationId": "sendvoicecall_listaiagents", "summary": "List every AI voice agent configured for this company. Call this BEFORE /api/1.0/sendvoicecall/createcall.json, because creating an AI call batch requires a valid 'agent_ai_id' — that id is the _id of one of the agents returned here. The response includes each agent's name, language, voice, system prompt summary and knowledge base so the caller can pick the agent that best fits the call's purpose (sales, support, appointment reminder, etc.). Does not place any call by itself.", "tags": [ "sendvoicecall" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/sendvoicecall/createcall.json": { "post": { "operationId": "sendvoicecall_createcall", "summary": "Create a new AI voice call batch campaign that will phone one or more recipients using an AI agent. Use this when the user wants the system to actually place outbound phone calls (e.g. 'call these leads', 'phone these customers', 'launch a reminder call campaign'). MANDATORY WORKFLOW: (1) call /api/1.0/sendvoicecall/listaiagents.json to pick the right 'agent_ai_id' for the campaign's purpose; (2) call /api/1.0/companyuserdata/callerids.json to pick a valid 'caller_id' (one of the company's phone lines allowed to place outbound calls); (3) build the 'recipients' array with one entry per person to call, each with phone (international format, digits only), name and country ISO code. Optionally schedule the campaign: set mode='schedule' plus start_date/start_time/end_time/timezone, or mode='immediately' to dial as soon as the worker picks it up. Returns a batch_id that can be later used with getone.json, stop.json, pause.json and unpause.json. Never invent phone numbers — only use the ones the user explicitly provided or the ones retrieved from a previous query.", "tags": [ "sendvoicecall" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" }, "agent_ai_id": { "type": "string", "description": "Mongo ObjectId of the AI voice agent that will conduct the calls. Obtain from /api/1.0/sendvoicecall/listaiagents.json. Required." }, "caller_id": { "type": "string", "description": "Phone number (caller id) the AI will dial out from. Must be one of the callerids available to the company — obtain from /api/1.0/companyuserdata/callerids.json. Can also be a shared caller id in the format 'compartido 999id_campana'. Required." }, "batch_name": { "type": "string", "description": "Human-readable name for this call batch (shown in the UI and reports). Optional." }, "recipients": { "type": "array", "description": "JSON array of call targets. Each element is an object with three string fields: 'phone' (international format, digits only, no '+' and no spaces, e.g. 34660558411), 'name' (display name, e.g. Marc) and 'country' (ISO 3166-1 alpha-2 lowercase, e.g. es, us, mx). At least one recipient is required. Pass it as a real JSON array of objects — do NOT wrap it in a string. See the 'default' field for a concrete example.", "example": [ { "name": "marc", "phone": "34660558411", "country": "es" }, { "name": "James", "phone": "34682288834", "country": "es" } ] }, "mode": { "type": "string", "description": "Dispatch mode. 'immediately' (default) starts dialing as soon as the worker picks up the batch; 'schedule' uses the start_date/start_time/end_time/timezone fields below. Required.", "example": "immediately" }, "timezone": { "type": "string", "description": "IANA timezone for start_date/start_time/end_time when mode='schedule' (e.g. 'Europe/Madrid', 'America/Mexico_City'). Optional, defaults to 'UTC'.", "example": "UTC" }, "start_date": { "type": "string", "description": "Date the campaign can start dialing, in YYYY-MM-DD format. Only used when mode='schedule'. Optional, defaults to today." }, "start_time": { "type": "string", "description": "Earliest hour of the day at which the AI is allowed to place calls, in 24h HH:MM format. Only used when mode='schedule'. Optional, defaults to '10:00'.", "example": "10:00" }, "end_time": { "type": "string", "description": "Latest hour of the day at which the AI is allowed to place calls, in 24h HH:MM format. Only used when mode='schedule'. Optional, defaults to '19:00'.", "example": "19:00" }, "rate_per_minute": { "type": "string", "description": "Maximum number of simultaneous new calls the dialer is allowed to open per minute. Use to throttle spend and avoid carrier rate-limits. Optional, defaults to '30'.", "example": "30" }, "date_start_ms": { "type": "string", "description": "Alternative to start_date/start_time: absolute Unix timestamp in MILLISECONDS (UTC) at which dialing should begin. Optional." } }, "required": [ "token", "agent_ai_id", "caller_id", "recipients", "mode" ] } } } } } }, "/api/1.0/companyuserdata/invoicesget.json": { "post": { "operationId": "invoices_get", "summary": "Get invoices for the authenticated agent, optionally filtered by date range", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "date_start": { "type": "string", "description": "Start timestamp for date range filter (optional)" }, "date_end": { "type": "string", "description": "End timestamp for date range filter (optional)" } }, "required": [ "token" ] } } } } } }, "/api/1.0/notifications/list.json": { "post": { "operationId": "notifications_list", "summary": "Get notifications for the authenticated agent with pagination", "tags": [ "notifications" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "var_resultspage": { "type": "string", "description": "Results per page (default 20)", "example": "20" }, "var_page": { "type": "string", "description": "Page number (default 1)", "example": "1" }, "read": { "type": "string", "description": "Filter by read status: 0 for unread, 1 for read (optional, returns all by default)" } }, "required": [ "token", "var_resultspage", "var_page" ] } } } } } }, "/api/1.0/notifications/sendpush.json": { "post": { "operationId": "notifications_sendpush", "summary": "Send a push notification to an agent. Same logic as workflows sendnoti block", "tags": [ "notifications" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "title": { "type": "string", "description": "Notification title" }, "text": { "type": "string", "description": "Notification text/body" }, "target_agent_id": { "type": "string", "description": "Agent ID to send the notification to (optional, defaults to self)" }, "assign_to": { "type": "string", "description": "Set to 'current' to send to the lead's owner agent (requires id_lead)" }, "id_lead": { "type": "string", "description": "Lead ID to link in the notification and resolve owner agent (optional)" }, "type": { "type": "string", "description": "Notification type (default 'noti')", "example": "noti" }, "badge": { "type": "string", "description": "Badge letter shown in notification (default 'L')", "example": "L" } }, "required": [ "token", "title", "text", "assign_to", "type", "badge" ] } } } } } }, "/api/1.0/notifications/read.json": { "post": { "operationId": "notifications_read", "summary": "Mark one or all notifications as read", "tags": [ "notifications" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "notification_id": { "type": "string", "description": "ID of a single notification to mark as read (optional if read_all is used)" }, "read_all": { "type": "string", "description": "Set to 'y' to mark all notifications as read" } }, "required": [ "token", "read_all" ] } } } } } }, "/api/1.0/costexplorer/get.json": { "post": { "operationId": "costexplorer_get", "summary": "Get aggregated cost/usage data from the calls_leads collection grouped by configurable dimensions with a date range filter. By default returns only real communication records (answered/received calls, SMS, WhatsApp) grouped by agent_id and type — excludes AI, file, payment, credit and other internal service types unless explicitly overridden via service_type. Date range must be within a single calendar year. Only master/admin users can call this endpoint. Use this to answer questions like 'cost of calls per agent this month', 'total SMS cost by country', or 'which agent spent most credits on callouts'.", "tags": [ "costexplorer" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "datestart_unix": { "type": "number", "description": "Start date as UNIX timestamp in seconds UTC (inclusive). Example: 1767225600 corresponds to 2026-01-01 00:00 UTC." }, "dateend_unix": { "type": "number", "description": "End date as UNIX timestamp in seconds UTC (exclusive). Example: 1769904000 corresponds to 2026-02-01 00:00 UTC." }, "group_by": { "type": "array", "description": "Array of dimensions to group by. Allowed values: type, country, agent_id, month, day, hour, phone, destination. Default when omitted: [\"agent_id\",\"type\"] — aggregates cost per agent and per service type.", "example": "[\"agent_id\",\"type\"]" }, "service_type": { "type": "array", "description": "Filter by call types (optional). Default when omitted: [\"callout\",\"callin\",\"callpush\",\"callai\",\"sms\",\"smsin\",\"whatsapp\"] — aggregates received/answered calls (incl. AI voice), SMS and WhatsApp (excludes ai, aitts, payment, credit, file, etc). Allowed values in DB: callout, callin, callpush (AI push/vozpush call), callai (AI voice call), sms, smsin, whatsapp, ai, aitts, payment, credit, file, calendar, sale, ticket, emailin, emailout, emailreaded, form_completed, budget-status, fbleads, cli2cal, voiceline (monthly subscription fee of each phone line, one record per line and month). Note: callpush and callai are distinct AI voice service types, each grouped and labeled separately (not merged into 'ai').", "example": "[\"callout\",\"callin\",\"callpush\",\"callai\",\"sms\",\"smsin\",\"whatsapp\"]" }, "var_agents_id": { "type": "array", "description": "Filter by agent IDs (optional, admin/master only). Admin users are limited to agents in their department." }, "collapse_by": { "type": "array", "description": "Re-aggregate results by these dimensions after initial grouping (optional). Subset of group_by dimensions." }, "timezone": { "type": "string", "description": "Timezone for date range validation (optional, example: Europe/Madrid). Used to ensure the date range stays within a single calendar year in the user's local timezone. Defaults to UTC if omitted or invalid.", "example": "Europe/Madrid" } }, "required": [ "token", "datestart_unix", "dateend_unix", "group_by" ] } } } } } }, "/api/1.0/costexplorer/getlistcallsleads.json": { "post": { "operationId": "costexplorer_getlistcallsleads", "summary": "Get call records grouped by agent and country with cost calculated from per-credit tariff. Dates in UNIX UTC seconds", "tags": [ "costexplorer" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "datestart_unix": { "type": "number", "description": "Start date as UNIX timestamp UTC seconds (inclusive)" }, "dateend_unix": { "type": "number", "description": "End date as UNIX timestamp UTC seconds (inclusive)" }, "service_type": { "type": "array", "description": "Filter by call types array e.g. ['callout','callin','sms'] (optional, returns all types if empty). callpush (AI push/vozpush call) and callai (AI voice call) are distinct service types." }, "var_agentfilterpayments": { "type": "string", "description": "Filter by single agent ID (optional)" }, "var_agents_id": { "type": "array", "description": "Filter by multiple agent IDs (optional)" }, "timezone": { "type": "string", "description": "Timezone for date filtering (optional, example: Europe/Madrid)" } }, "required": [ "token", "datestart_unix", "dateend_unix" ] } } } } } }, "/api/1.0/costexplorer/calls.json": { "post": { "operationId": "costexplorer_calls", "summary": "Call report: returns a paginated list of individual communication records (inbound/outbound calls, SMS, WhatsApp) for a date range, plus aggregate stats (total calls, answered, unanswered, total duration in seconds, total credits). Reads from monthly calls_leads collections and applies agent RBAC automatically. By default filters only real communications (callout, callin, sms, smsin, whatsapp) and excludes AI, files, payments, credits and other non-communication service types — override with service_type to include them. Use this to answer questions like 'show me my calls last week', 'how many calls did agent X make in March', 'list missed calls today', 'how many WhatsApp messages did I receive', or 'what's my call cost this month'. All dates are UNIX timestamps in seconds.", "tags": [ "costexplorer" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" }, "datestart_unix": { "type": "number", "description": "Start date as UNIX timestamp UTC seconds (inclusive). If omitted or invalid, defaults to current month. Example: 1767225600 corresponds to 2026-01-01 00:00 UTC." }, "dateend_unix": { "type": "number", "description": "End date as UNIX timestamp UTC seconds (inclusive). If omitted or invalid, defaults to current month. Example: 1769817599 corresponds to 2026-01-31 23:59 UTC." }, "service_type": { "type": "array", "description": "Filter by call types (optional). Default when omitted: [\"callout\",\"callin\",\"callpush\",\"callai\",\"sms\",\"smsin\",\"whatsapp\"] — filters received/answered calls (incl. AI voice), SMS and WhatsApp. Allowed values in DB: callout, callin, callpush (AI push/vozpush call), callai (AI voice call), sms, smsin, whatsapp, ai, aitts, payment, credit, file, calendar, sale, ticket, emailin, emailout, emailreaded, form_completed, budget-status, fbleads, cli2cal, voiceline (monthly subscription fee of each phone line, one record per line and month). Note: callpush and callai are distinct AI voice service types, each grouped and labeled separately (not merged into 'ai'). Example: [\"callout\",\"callin\"]", "example": "[\"callout\",\"callin\",\"callpush\",\"callai\",\"sms\",\"smsin\",\"whatsapp\"]" }, "status": { "type": "string", "description": "Filter by call status (optional). Common values: ANSWER (answered), NO ANSWER, BUSY, FAILED, CANCEL" }, "phone": { "type": "string", "description": "Filter by phone number substring (optional, case insensitive)" }, "var_agents_id": { "type": "array", "description": "Filter by agent IDs (optional). Ignored for agent-type users (they only see their own calls). Admin users are limited to agents in their department." }, "page": { "type": "number", "description": "Page number, starts at 1 (optional, default 1)", "example": 1 }, "pageSize": { "type": "number", "description": "Records per page, between 10 and 500 (optional, default 50)", "example": 50 }, "timezone": { "type": "string", "description": "Timezone for date filtering context (optional, example: Europe/Madrid).", "example": "Europe/Madrid" } }, "required": [ "token", "datestart_unix", "dateend_unix" ] } } } } } }, "/api/1.0/companyuserdata/myuserdata.json": { "post": { "operationId": "companyuserdata_myuserdata", "summary": "Get the full authenticated agent/user record from the clients collection", "tags": [ "companyuserdata" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/calendarwidget/getconfigurationbookingcalendar.json": { "get": { "operationId": "calendarwidget_get_config", "summary": "Get public calendar configuration. Returns availability ranges (per-day, minutes from midnight), duration, timezone and company logo. Calendar must have enabled=true. No authentication required (public endpoint).", "tags": [ "calendarwidget" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "bookingId", "in": "query", "required": true, "description": "Calendar widget ObjectId (query param)", "schema": { "type": "string" } } ] } }, "/api/1.0/calendarwidget/availabilityByDay.json": { "get": { "operationId": "calendarwidget_availability", "summary": "Get available time slots for a specific date. Returns UTC ISO slots filtered by agent availability. How it works: 1) Load calendar config 2) Check enabled=true 3) Get availability ranges for the day of week 4) Generate slots every {duration} minutes within each range 5) Filter out past slots 6) For each slot check if at least ONE assigned agent has no conflicting task in calendar collection 7) Return available slots as UTC ISO strings. No authentication required (public endpoint).", "tags": [ "calendarwidget" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "bookingId", "in": "query", "required": true, "description": "Calendar widget ObjectId (query param)", "schema": { "type": "string" } }, { "name": "selectedDay", "in": "query", "required": true, "description": "Date in YYYY-MM-DD format (query param)", "schema": { "type": "string", "example": "2026-03-30" } }, { "name": "timezone", "in": "query", "required": false, "description": "IANA timezone string (optional query param, auto-detected from company country if not sent)", "schema": { "type": "string", "example": "Europe/Madrid" } } ] } }, "/api/1.0/calendarwidget/booking.json": { "post": { "operationId": "calendarwidget_create_booking", "summary": "Create an appointment booking. How it works: 1) Load calendar config, check enabled=true 2) Calculate UTC start/end from start_time + duration 3) Find assigned agents 4) Check which agents already have a task at that date+time 5) Pick first free agent 6) Detect existing lead by phone then by email 7) If no lead found create new lead (source: calendarwidget) 8) Create calendar task via appexpress_modal_addcalendar() 9) Return agent info. No authentication required (public endpoint).", "tags": [ "calendarwidget" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "booking_id": { "type": "string", "description": "Calendar widget ObjectId" }, "start_time": { "type": "string", "description": "ISO 8601 UTC datetime of the chosen slot (e.g. 2026-03-30T09:00:00.000Z)" }, "timezone": { "type": "string", "description": "IANA timezone string (optional, auto-detected from company country if not sent)", "example": "Europe/Madrid" }, "contact": { "type": "object", "description": "Contact info object: { name: string, email: string, phone: string (with intl prefix), country: string (ISO 2-char code), notes: string }", "example": { "name": "John Doe", "email": "john@example.com", "phone": "+34600000000", "country": "es", "notes": "" } } }, "required": [ "booking_id", "start_time", "contact" ] } } } } } }, "/api/1.0/entities/schemas.json": { "post": { "operationId": "entities_get_schemas", "summary": "Get ALL CRM entities of the company with their full schemas in a single call: property identifiers, types, required/unique flags, select options, statuses, associations and the exact endpoints to create, query and edit records of each entity. This is the entry point for AI assistants, MCP integrations and developers: call it first and you will not need to fetch company properties or configuration from any other endpoint. ENTITY TYPES: entities with system='y' are the 6 built-in CRM entities (leads = Contacts, companies, opportunities = Deals, tasks, tickets, budgets); entities with system=null are CUSTOM entities created by this company and their key always starts with 'cust_'. Both share exactly the same schema shape. STATUSES: an entity can have status groups (statusgroups). Every status has a stable 'id', a human 'label', a color and (built-in entities only) a numeric 'legacyIndex'. The 'mode' of the group tells you which value is stored in records and therefore what to send in filters and on creation: mode 'index' (contacts/companies) uses the legacyIndex, mode 'id' (custom entities) uses the status 'id'. The property that backs each group carries 'statusgroup' and 'statusoptions'. ASSOCIATIONS: a property of type 'association' links a record to another entity: 'targetEntity' says which entity it points to and the stored value is the _id string of the target record; the entity's 'associations' array lists all its links. Association properties are CREATED through /api/1.0/entities/saveproperty.json (type 'association' + targetEntity) or directly at entity creation with the 'properties' parameter of /api/1.0/entities/createentity.json. GET is also supported with the same parameters as query string.", "tags": [ "entities" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "API access token of the company. Required.", "example": "YOUR_APIKEY" } }, "required": [ "token" ] } } } } } }, "/api/1.0/entities/getrecords.json": { "post": { "operationId": "entities_get_records", "summary": "Query records of any CRM entity — contacts (entitykey 'leads'), 'companies', 'opportunities', 'tasks', 'tickets' or any CUSTOM entity ('cust_...') — with filters on schema properties, free-text search, ordering, pagination and creation-date range. Records are returned CLEAN: only 'id', base fields (agent_id, agents_id, creation_date, last_update and, on entities that store it — opportunities/tasks —, a raw 'date' field), the properties defined in the entity schema, resolved status labels (extra '