Contacts

Download the contact import template

Download the template accepted by POST /companies/{company}/contacts/import, generated from the same column descriptors as the importer. ?format=csv (default) is a UTF-8 CSV attachment with only the headers; ?format=xlsx is a workbook with the Data, Instructions, Examples and Allowed values sheets. It contains no company data.

get/companies/{company}/contacts/import/template

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/contacts/import/template
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

format'csv' | 'xlsx'

Template format. csv (default) returns only the headers; xlsx returns a workbook with the Data, Instructions, Examples and Allowed values sheets.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Import template generated from the importer column descriptors: a headers-only CSV by default, or the XLSX workbook with ?format=xlsx.

Changes

No recorded changes to this operation across all 1 revision of this API.