Sign in

v1

latestOpenAPI 3.1.0AGPL-3.0 license2026-07-1210336283.6 KB
Customers

Create customer

Create a new customer for the authenticated team.

post/customers

Request body

idstring uuid

Unique identifier of the customer. Required for updates, omit for new customers

namestring required

Name of the customer or organization

emailstring email required

Primary email address of the customer

billingEmailstring nullable

Billing email addresses of the customer (comma-separated for multiple)

countrystring nullable

Country name where the customer is located

addressLine1string nullable

First line of the customer's address

addressLine2string nullable

Second line of the customer's address (suite, apartment, etc.)

citystring nullable

City where the customer is located

statestring nullable

State or province where the customer is located

zipstring nullable

ZIP or postal code of the customer's address

phonestring nullable

Primary phone number of the customer

websitestring nullable

Website URL of the customer

notestring nullable

Internal notes about the customer for team reference

vatNumberstring nullable

VAT (Value Added Tax) number of the customer

countryCodestring nullable

Country code in ISO 3166-1 alpha-2 format

contactstring nullable

Primary contact person's name at the customer organization

Example request

{
  "id": "b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
  "name": "Acme Corporation",
  "email": "contact@acme.com",
  "billingEmail": "finance@acme.com, accounting@acme.com",
  "country": "United States",
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 400",
  "city": "San Francisco",
  "state": "California",
  "zip": "94105",
  "phone": "+1-555-123-4567",
  "website": "https://acme.com",
  "note": "Preferred contact method is email. Large enterprise client.",
  "vatNumber": "US123456789",
  "countryCode": "US",
  "contact": "John Smith",
  "tags": [
    {
      "id": "e7a9c1a2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
      "name": "VIP"
    },
    {
      "id": "f1b2c3d4-5678-4e7a-9c1a-2b7c1e24c2a4",
      "name": "Enterprise"
    }
  ]
}

Response

Customer created

idstring uuid required

Unique identifier of the customer

namestring required

Name of the customer or organization

emailstring email required

Primary email address of the customer

billingEmailstring nullable required

Billing email addresses of the customer (comma-separated for multiple)

phonestring nullable required

Primary phone number of the customer

websitestring nullable required

Website URL of the customer

createdAtstring required

Date and time when the customer was created in ISO 8601 format

countrystring nullable required

Country name where the customer is located

addressLine1string nullable required

First line of the customer's address

addressLine2string nullable required

Second line of the customer's address (suite, apartment, etc.)

citystring nullable required

City where the customer is located

statestring nullable required

State or province where the customer is located

zipstring nullable required

ZIP or postal code of the customer's address

notestring nullable required

Internal notes about the customer for team reference

vatNumberstring nullable required

VAT (Value Added Tax) number of the customer

countryCodestring nullable required

Country code in ISO 3166-1 alpha-2 format

tokenstring required

Unique token for the customer (used for internal identification)

contactstring nullable required

Primary contact person's name at the customer organization

invoiceCountnumber required

Total number of invoices created for this customer

projectCountnumber required

Total number of projects associated with this customer

totalRevenuenumber

Total revenue from paid invoices for this customer (in invoice currency). Only returned in list queries.

outstandingAmountnumber

Total outstanding amount from unpaid/overdue invoices (in invoice currency). Only returned in list queries.

lastInvoiceDatestring nullable

Date of the most recent invoice in ISO 8601 format. Only returned in list queries.

invoiceCurrencystring nullable

Primary currency used in invoices for this customer. Only returned in list queries.

descriptionstring nullable required

AI-generated description of what the company does

industrystring nullable required

Primary industry of the company

companyTypestring nullable required

Business model type

employeeCountstring nullable required

Estimated number of employees

foundedYearnumber nullable required

Year the company was founded

estimatedRevenuestring nullable required

Estimated annual revenue range

fundingStagestring nullable required

Current funding stage

totalFundingstring nullable required

Total funding raised

headquartersLocationstring nullable required

Company headquarters location

timezonestring nullable required

IANA timezone of the company headquarters

linkedinUrlstring nullable required

LinkedIn company page URL

twitterUrlstring nullable required

Twitter/X profile URL

instagramUrlstring nullable required

Instagram profile URL

facebookUrlstring nullable required

Facebook page URL

logoUrlstring nullable required

URL to the company logo

ceoNamestring nullable required

Name of the CEO or founder

financeContactstring nullable required

Name of the finance/AP contact for invoicing

financeContactEmailstring nullable required

Email of the finance/AP contact

primaryLanguagestring nullable required

Primary business language (ISO 639-1 code)

fiscalYearEndstring nullable required

Month when the fiscal year ends

enrichmentStatusstring nullable required

Status of the enrichment process

enrichedAtstring nullable required

When the customer was last enriched

Example response

{
  "id": "b3b7c1e2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
  "name": "Acme Corporation",
  "email": "contact@acme.com",
  "billingEmail": "finance@acme.com, accounting@acme.com",
  "phone": "+1-555-123-4567",
  "website": "https://acme.com",
  "createdAt": "2024-05-01T12:34:56.789Z",
  "country": "United States",
  "addressLine1": "123 Main Street",
  "addressLine2": "Suite 400",
  "city": "San Francisco",
  "state": "California",
  "zip": "94105",
  "note": "Preferred contact method is email. Large enterprise client.",
  "vatNumber": "US123456789",
  "countryCode": "US",
  "token": "cus_abc123xyz789",
  "contact": "John Smith",
  "invoiceCount": 12,
  "projectCount": 3,
  "totalRevenue": 15000.5,
  "outstandingAmount": 2500,
  "lastInvoiceDate": "2024-04-15",
  "invoiceCurrency": "USD",
  "tags": [
    {
      "id": "e7a9c1a2-4c2a-4e7a-9c1a-2b7c1e24c2a4",
      "name": "VIP"
    },
    {
      "id": "f1b2c3d4-5678-4e7a-9c1a-2b7c1e24c2a4",
      "name": "Enterprise"
    }
  ],
  "description": "A cloud-based project management platform for remote teams.",
  "industry": "Software",
  "companyType": "SaaS",
  "employeeCount": "51-200",
  "foundedYear": 2018,
  "estimatedRevenue": "$10M-$50M",
  "fundingStage": "Series A",
  "totalFunding": "$15M",
  "headquartersLocation": "San Francisco, CA",
  "timezone": "America/Los_Angeles",
  "linkedinUrl": "https://linkedin.com/company/acme",
  "twitterUrl": "https://twitter.com/acme",
  "instagramUrl": "https://instagram.com/acme",
  "facebookUrl": "https://facebook.com/acme",
  "logoUrl": "https://example.com/logo.png",
  "ceoName": "Jane Smith",
  "financeContact": "John Doe",
  "financeContactEmail": "finance@acme.com",
  "primaryLanguage": "en",
  "fiscalYearEnd": "December",
  "enrichmentStatus": "completed",
  "enrichedAt": "2024-05-01T12:34:56.789Z"
}