NAV
shell ruby python javascript

Vollständige Feature-Liste

Diese Liste fasst die Acvire-Funktionen aus der lokalen Rails-Codebasis zusammen: Routen, Controller, Modelle, Services, Automationsmodule, Mobile-Endpunkte, Admin-Bereiche und vorhandene Produktdokumentation. Acvire ist ein KI-gestuetztes Sales CRM fuer Lead-Suche, Sales-Management, Kommunikation, Pipeline, Reporting und kontrollierte Automationen.

Produkt & Arbeitsbereiche

Leads & CRM-Daten

Lead-Import & Lead-Suche

KI & Datenanreicherung

Kommunikation & E-Mail

Aufgaben, Kalender & Aktivitaeten

Listen, Filter & Kanban

Deals, Produkte, Kunden & Unternehmen

Dashboards & Reporting

Automationen & Sales-Agenten

Integrationen & Extensions

API, Mobile & Webhooks

Sicherheit, Rollen & Zugriff

Usage, Billing, Support & Notifications

Admin, Content & SEO

A-Z Feature-Index

Introduction

Welcome to the Acvire API. Use the API to manage leads connected to your projects. This documentation provides detailed information about API endpoints and how to use them.

Code examples are available for Shell, Ruby, Python, and JavaScript. You can view examples in the dark panel on the right and switch the example language with the tabs in the upper-right corner.

Authentication

Use this code to authorize your request:

Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

import requests

headers = {"Authorization": "Bearer <your_api_token>"}
response = requests.get("https://acvire.com/api/v1/leads", headers=headers)

const fetch = require('node-fetch');

const url = 'https://acvire.com/api/v1/leads';
const options = { method: 'GET', headers: { Authorization: 'Bearer <your_api_token>' } };

fetch(url, options).then(response => response.json()).then(console.log);

The Acvire API uses API tokens for authentication. Add your API token to the Authorization header in every API request.

Endpoints

List leads

GET /api/v1/leads?ref_code=abc123
Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads?ref_code=abc123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

response = requests.get(
    "https://acvire.com/api/v1/leads",
    headers={"Authorization": "Bearer <your_api_token>"},
    params={"ref_code": "abc123"}
)

fetch('https://acvire.com/api/v1/leads?ref_code=abc123', {
  method: 'GET',
  headers: { Authorization: 'Bearer <your_api_token>' }
}).then(console.log);

Example response:

[
  {
    "id": 1,
    "name": "John Doe",
    "email": "johndoe@example.com",
    "organisation": "Example Corp",
    "status": "new"
  }
]

Returns all leads for the specified project.

HTTP request

GET /api/v1/leads

Query parameters

Parameter Type Description
ref_code string Project reference code (required).

Show lead details

GET /api/v1/leads/1
Authorization: Bearer <your_api_token>

require 'net/http'

uri = URI("https://acvire.com/api/v1/leads/1")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <your_api_token>"

response = requests.get(
    "https://acvire.com/api/v1/leads/1",
    headers={"Authorization": "Bearer <your_api_token>"}
)

fetch('https://acvire.com/api/v1/leads/1', {
  method: 'GET',
  headers: { Authorization: 'Bearer <your_api_token>' }
}).then(console.log);

Example response:

{
  "id": 1,
  "name": "John Doe",
  "email": "johndoe@example.com",
  "organisation": "Example Corp",
  "status": "new"
}

Returns details for a specific lead.

HTTP request

GET /api/v1/leads/:id

URL parameters

Parameter Type Description
id string The lead ID (required).

Create a lead

POST /api/v1/leads
Authorization: Bearer <your_api_token>
Content-Type: application/json

{
  "ref_code": "abc123",
  "lead": {
    "name": "Jane Doe",
    "email": "janedoe@example.com",
    "organisation": "Example Corp"
  }
}

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("https://acvire.com/api/v1/leads")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer <your_api_token>"
request.body = JSON.dump({
  "ref_code" => "abc123",
  "lead" => {
    "name" => "Jane Doe",
    "email" => "janedoe@example.com",
    "organisation" => "Example Corp"
  }
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body

headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json"
}
data = {
    "ref_code": "abc123",
    "lead": {
        "name": "Jane Doe",
        "email": "janedoe@example.com",
        "organisation": "Example Corp"
    }
}

response = requests.post(
    "https://acvire.com/api/v1/leads",
    headers=headers,
    json=data
)

fetch('https://acvire.com/api/v1/leads', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <your_api_token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ref_code: 'abc123',
    lead: {
      name: 'Jane Doe',
      email: 'janedoe@example.com',
      organisation: 'Example Corp'
    }
  })
}).then(console.log);

Example response:

{
  "id": 2,
  "name": "Jane Doe",
  "email": "janedoe@example.com",
  "organisation": "Example Corp",
  "status": "new"
}

Creates a new lead for the specified project.

HTTP request

POST /api/v1/leads

Request body

Parameter Type Description
ref_code string Project reference code (required).
lead object Lead attributes (required).

Lead-Attribute

Parameter Type Description
name string Lead name.
email string Lead email.
organisation string Organization name.
Additional fields varies According to lead_params.

Error responses

401 Unauthorized

Occurs when the token is missing or invalid, or when the user has no access to the resource.

Example response:

{
  "error": "Unauthorized: Invalid project or access denied"
}

422 Unprocessable entity

Occurs when lead attribute validation fails.

Example response:

{
  "errors": ["Email can't be blank"]
}

Security and subscription checks

Token authentication

Checks the Authorization token against User.api_token.

Subscription check

Ensures that the user has an active subscription before accessing endpoints.

Example error message:

No active subscription. Please activate your subscription at <subscription_url>

Developer notes

shell ruby python javascript