Skip to navigation
API ReferenceContacts

Get a contact

View as Markdown

Authentication

AuthorizationBearer

JWT issued via POST /api/v1/auth/sign_in. Used by mobile and SPA clients. Revoked tokens are rejected.

OR
AuthorizationBearer

Lucanto API key. Two prefixes:

  • lct_pat_<random><checksum> — personal access token (owner: User)
  • lct_live_<random><checksum> — workspace token, live data

Issue keys at /settings/api_keys (personal) or /:workspace_id/settings/api_keys (workspace). Plaintext token is shown once and never again.

Path parameters

workspace_idlongRequired>=1
Workspace ID. The numeric ID shown in your URLs.
idlong or stringRequired

Contact ID. Either the numeric id or the public_id (cnt_…).

Response

OK
idlong

Contact ID (workspace-scoped). Not the legal-entity ID.

public_idstringRead-onlyformat: "^[a-z]+_[0-7][0-9a-hjkmnp-tv-z]{25}$"

Stable public identifier of this record. Never changes once assigned. Its prefix names the entity: doc_ document (invoice, proforma, credit note, quote, sales order), exp_ expense, cnt_ contact, prj_ project, ba_ bank account or cash register, txn_ transaction, lon_ loan, bst_ bank statement. Accepted in place of the numeric id in this resource’s path parameters and in request fields that reference it (customer_id, bank_account_id, …).

created_atdatetime
updated_atdatetime
legal_registration_idstring or nullOptional

Legal/company registration identifier (SK/CZ IČO). _id denotes identifier, not a foreign key; the value is an opaque string and may be alphanumeric outside SK/CZ (e.g. UK SC123456).

tax_idstring or nullOptional

Tax registration identifier (SK/CZ DIČ). An identifier string, not a number.

vat_idstring or nullOptional

VAT identifier (SK/CZ IČ DPH). Alphanumeric with a country prefix (e.g. SK2020123456, ATU12345678) — an identifier, not a number.

vat_payer_typeenum or nullOptional

VAT registration status (standard | non_payer_vat | foreign); nullable.

Allowed values:
emailstring or nullOptionalformat: "email"
phone_numberstring or nullOptional
websitestring or nullOptional
addressobject or nullOptional
postal_addressobject or nullOptional
legal_namestring or nullOptional

The contact’s registered legal name, including legal form (e.g. “ACME s.r.o.”). This is the contact’s name.

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error