Contacts
Look up contacts by external reference
From a list of your references, says which ones already exist in Filmo and which do not.
contacts:readcontacts:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
notFound are the ones to create. It is the primitive of any synchronization: without it, the alternative is one call per reference and guessing from the 404. It writes NOTHING, even though it is a POST: the list of references does not fit in a query string.
Arguments
External references to look up. At least one, at most 200.
Limits: min 1 items, max 200 items, each min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Contacts that matched at least one reference.
Show child attributesHide child attributes
Identifier of the contact in Filmo.
Contact name.
Filmo contact number.
References that did not match any contact. These are the ones to create.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
Is there already a contact with the email ana@example.com?
The same operation by REST
This tool runs POST /api/v1/contacts/lookup.
Related pages
Link to this section: Related pagesContacts
Look up contacts by external reference
From a list of your references, says which ones already exist in Filmo and which do not.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?