Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.talkturo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

teamId
string
erforderlich
The team ID that owns this company.
name
string
erforderlich
The company’s name.
website
string
The company’s website URL.
industry
string
The industry the company operates in (for example, "SaaS", "Healthcare", "Finance").
companySize
string
A descriptor of the company’s size (for example, "1-10", "51-200", "1000+").
addressLine1
string
First line of the company’s street address.
addressLine2
string
Second address line (suite, floor, etc.).
city
string
City.
state
string
State or province.
postalCode
string
Postal or ZIP code.
country
string
Country (for example, "US", "GB", "DE").
phone
string
Company main phone number in E.164 format.
notes
string
Free-text notes about the company.
customFields
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"
  }
}
company.id
string
Unique identifier for the company. Use this ID when creating contacts or campaigns.
company.team_id
string
The team this company belongs to.
company.name
string
Company name.
company.website
string
Company website URL.
company.industry
string
Industry descriptor.
company.company_size
string
Company size descriptor.
company.phone
string
Main company phone number.
company.address_line1
string
First line of the street address.
company.address_line2
string
Second line of the address.
company.city
string
City.
company.state
string
State or province.
company.postal_code
string
Postal or ZIP code.
company.country
string
Country code.
company.notes
string
Free-text notes.
company.custom_fields
object
Key-value pairs of custom company data.
company.contact_count
integer
Number of contacts associated with this company.
company.created_at
string
ISO 8601 timestamp of when the company was created.
company.updated_at
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

teamId
string
The team ID to list companies for. Provide either teamId or accountSlug.
accountSlug
string
Your account slug. Alternative to teamId.
Search by company name.
industry
string
Filter by industry value.
limit
integer
Maximum records to return. Defaults to 50.
offset
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
}
companies
array
Array von Unternehmensobjekten.
count
integer
Gesamtzahl der Unternehmen, die den Filtern entsprechen.
limit
integer
Der für diese Antwort verwendete limit-Wert.
offset
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.