Contacts

List the roles an anagrafica can hold

The organisation’s roles catalogue: the nine built-in roles (cliente, potenziale_cliente, ex_cliente, fornitore, agente, dipendente, collaboratore, consulente, firmatario) and the organisation’s own, each with how many records the caller can see holding it. The keys are what roles takes on anagrafiche_create_party and anagrafiche_update_party and what role filters anagrafiche_search_parties by. label is null for a built-in the organisation did not rename — its key IS its Italian name. uses says what the OTHER modules pick the role for (crm_customer, firme_signer, raccolta_recipient, documents_party, staff, ordini_customer): their pickers open on the roles carrying the use, and the person filling the form can still widen the list to every record — except staff, which is also a rule: only a person holding a role that carries it can have an employment (login, Responsabile, matricola, dates). access says what the CALLER may do with records holding the role (read, write, delete) — an administrator decides that per member; a role with read false is one whose records the caller cannot see. An archived role is no longer offered for new records, and existing holders keep it. Changing the catalogue is a settings act and has no tool.

Examples

  • What kinds of contacts do we keep? GET /api/v1/rest/anagrafiche/roles
  • Including the roles we stopped using GET /api/v1/rest/anagrafiche/roles?include_archived=true
get/api/v1/rest/anagrafiche/roles

Request

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

Query parameters

include_archivedboolean

Also list the roles the organisation archived. Default false.

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.