Contacts

Find anagrafiche — customers, suppliers, people (status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

Full-text search over the register of everybody the organisation deals with — customers, prospects, suppliers, agents, employees, consultants: company and person names, partita IVA, codice fiscale, email and PEC. Narrow by kind (a company or an individual), by role (one role key, e.g. fornitore), by the company a person works for (parent_id) or by owner. Each row carries the fiscal identifiers an Italian invoice needs and the roles the record holds. Newest first, paged with cursor; ask for a name, not for an id.

Examples

  • Do we have Rossi in the register? GET /api/v1/rest/anagrafiche/parties/status?query=rossi
  • List our suppliers GET /api/v1/rest/anagrafiche/parties/status?role=fornitore&kind=company&limit=50
  • Find the company with VAT 12345678903 GET /api/v1/rest/anagrafiche/parties/status?query=12345678903
  • Who do we know at Rossi S.r.l.? GET /api/v1/rest/anagrafiche/parties/status?parent_id=11111111-2222-4333-8444-555555555555
get/api/v1/rest/anagrafiche/parties/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/anagrafiche/parties/status
  • Auth: HTTP bearer

Query parameters

querystring

At least two characters. Omit to list the whole register, newest first.

kind'company' | 'person'

company or person.

rolestring

Only records holding this role — one key: cliente, fornitore, dipendente… (anagrafiche_list_roles has the organisation’s own). A record holds a set of roles, so a customer that is also a supplier matches both.

lifecycle'lead' | 'prospect' | 'customer' | 'former'

DEPRECATED — send roles instead. The CRM’s old «Relazione», still accepted from callers written before it became roles: lead and prospect mean the role potenziale_cliente, customer means cliente, former means ex_cliente. Ignored whenever roles is also given.

parent_idstring uuid

Only the people filed under this company — «who do we know at Rossi S.r.l.».

owner_user_idstring uuid

Only records this colleague owns. Your own id is in custodo_whoami.

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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