REST-API-Endpunkte für CRM-Unternehmen

Unternehmen sind Organisationseinträge im Talkturo-CRM — eine Ebene über Kontakten. Jeder Kontakt gehört zu einem Unternehmen, jede Kampagne ist einem Unternehmen zugeordnet. Sie speichern Adresse, Branche, Größe und eigene Felder; die KI-Infoextraktion kann diese Felder nach Gesprächen automatisch pflegen.

Create a company

POST /api/crm/companies Creates a new company in your CRM.

Request body

string

erforderlich

The team ID that owns this company.

string

erforderlich

The company’s name.

string

The company’s website URL.

string

The industry the company operates in (for example, "SaaS", "Healthcare", "Finance").

string

A descriptor of the company’s size (for example, "1-10", "51-200", "1000+").

string

First line of the company’s street address.

string

Second address line (suite, floor, etc.).

string

City.

string

State or province.

string

Postal or ZIP code.

string

Country (for example, "US", "GB", "DE").

string

Company main phone number in E.164 format.

string

Free-text notes about the company.

object

Key-value object for any additional company-level data.

Example request

curl -X POST https://<your-domain>/api/crm/companies \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "teamId": "team_01j...",
    "name": "Acme Corporation",
    "website": "https://acme.example.com",
    "industry": "Manufacturing",
    "companySize": "500-1000",
    "city": "Chicago",
    "state": "IL",
    "country": "US",
    "customFields": {
      "crm_id": "acme-001",
      "account_tier": "enterprise"
    }
  }'

Antwort

{
  "success": true,
  "company": {
    "id": "comp_01j...",
    "team_id": "team_01j...",
    "name": "Acme Corporation",
    "website": "https://acme.example.com",
    "industry": "Manufacturing",
    "company_size": "500-1000",
    "phone": null,
    "address_line1": null,
    "address_line2": null,
    "city": "Chicago",
    "state": "IL",
    "postal_code": null,
    "country": "US",
    "notes": null,
    "custom_fields": {
      "crm_id": "acme-001",
      "account_tier": "enterprise"
    },
    "contact_count": 0,
    "created_at": "2024-01-15T10:00:00Z",
    "updated_at": "2024-01-15T10:00:00Z"
  }
}

string

Unique identifier for the company. Use this ID when creating contacts or campaigns.

string

The team this company belongs to.

string

Company name.

string

Company website URL.

string

Industry descriptor.

string

Company size descriptor.

string

Main company phone number.

string

First line of the street address.

string

Second line of the address.

string

City.

string

State or province.

string

Postal or ZIP code.

string

Country code.

string

Free-text notes.

object

Key-value pairs of custom company data.

integer

Number of contacts associated with this company.

string

ISO 8601 timestamp of when the company was created.

string

ISO 8601 timestamp of the most recent update.

List companies

GET /api/crm/companies Returns a paginated list of companies. You can filter by team or account, search by name, and filter by industry.

Query parameters

string

The team ID to list companies for. Provide either teamId or accountSlug.

string

Your account slug. Alternative to teamId.

string

Search by company name.

string

Filter by industry value.

integer

Maximum records to return. Defaults to 50.

integer

Records to skip for pagination. Defaults to 0.

Example request

curl "https://<your-domain>/api/crm/companies?teamId=team_01j...&industry=SaaS&limit=25" \
  -H "Authorization: Bearer <token>"

Antwort

{
  "success": true,
  "companies": [
    {
      "id": "comp_01j...",
      "team_id": "team_01j...",
      "name": "Acme Corporation",
      "website": "https://acme.example.com",
      "industry": "Manufacturing",
      "company_size": "500-1000",
      "contact_count": 42,
      "created_at": "2024-01-15T10:00:00Z",
      "updated_at": "2024-01-15T10:00:00Z"
    }
  ],
  "count": 1,
  "limit": 25,
  "offset": 0
}

array

Array von Unternehmensobjekten.

integer

Gesamtzahl der Unternehmen, die den Filtern entsprechen.

integer

Der für diese Antwort verwendete limit-Wert.

integer

Der für diese Antwort verwendete offset-Wert.

Beim Anlegen einer Kampagne müssen Sie eine companyId angeben. Legen Sie zuerst den Unternehmensdatensatz an, dann Kontakte darunter, danach die Kampagne.

Überblick

Endpunkte

Webhooks

REST-API-Endpunkte für CRM-Unternehmen

Create a company

Request body

Example request

Antwort

List companies

Query parameters

Example request

Antwort

​Create a company

​Request body

​Example request

​Antwort

​List companies

​Query parameters

​Example request

​Antwort

Create a company

Request body

Example request

Antwort

List companies

Query parameters

Example request

Antwort