Ivvycode iVvy API
Official vendor OpenAPI document · agent-readyCRMContact ManagementapiKey6 EndpointsREST
For Agents
Look up contacts, events, venues, and invoices in the iVvy hospitality and events platform.
Use for: I need to retrieve a contact record by ID, Find all events scheduled for a specific venue, Get a list of venues in a region, Retrieve an invoice for a completed booking
Not supported: Does not handle payment capture, room inventory, or property management - use for iVvy contact, event, venue, and invoice lookups only.
The iVvy API provides programmatic access to iVvy's venue, events, and CRM products used by hotels, conference venues, and event teams to manage enquiries, bookings, and customer relationships. The 1.0.0 spec covers contact and event lookups, venue listings, and invoice retrieval. Authentication uses an X-API-Key header issued from the iVvy partner console.
Install Jentic One Beta
Connect the iVvy API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the iVvy API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fivvycode.com%2Fivvy" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fivvycode.com%2Fivvy" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with iVvy API.
Look up contact records and contact lists from the iVvy CRM
Retrieve event records including bookings, dates, and attached venue details
List venues across the iVvy marketplace and operator portfolio
Pull invoice lists for finance reconciliation against event bookings
Authenticate via the X-API-Key header for server-side integrations
Use Cases
Patterns agents use iVvy API for, with concrete tasks.
★ Hotel Sales CRM Sync
Hotel sales teams running iVvy as their venue CRM mirror contacts and event records into a central data warehouse for analysis. The /contact/getContactList and /event/getEventList endpoints let an integration paginate through current records and feed downstream analytics or marketing automation without manual export.
POST /contact/getContactList with a date filter and append the returned records to the warehouse contacts table
Finance Reconciliation
Finance teams reconcile event bookings against issued invoices at month end. The /invoice/getInvoiceList endpoint returns invoices in the period, which the team matches to /event/getEvent records to confirm that every confirmed booking was billed and that revenue is recognised against the correct property.
POST /invoice/getInvoiceList for the previous month and join the result against /event/getEvent records by booking_id
Venue Marketplace Aggregation
Aggregator sites and concierge tools list venues across many iVvy operators. The /venue/getVenueList endpoint returns the venues an integration is authorised to surface, so the aggregator can refresh its directory and propagate availability changes back to bookers.
POST /venue/getVenueList and update the aggregator's directory with the returned venue records
AI Agent Event Lookup
An AI assistant for a venue operator answers internal questions like 'what events are booked at the Sydney property next week?'. Through Jentic the agent searches for 'list iVvy events', loads the POST /event/getEventList schema, and executes against the iVvy API with the X-API-Key managed in your Jentic One instance.
Search Jentic for 'list events for venue', execute POST /event/getEventList with the venue_id, and summarise the upcoming bookings
Key Endpoints
6 endpoints — the ivvy api provides programmatic access to ivvy's venue, events, and crm products used by hotels, conference venues, and event teams to manage enquiries, bookings, and customer relationships.
METHOD
PATH
DESCRIPTION
POST
/contact/getContactList
List contacts in the iVvy CRM
POST
/contact/getContact
Retrieve a single contact by ID
POST
/event/getEventList
List events filtered by date or venue
POST
/event/getEvent
Retrieve a single event record
POST
/venue/getVenueList
List venues accessible to the API key
POST
/invoice/getInvoiceList
List invoices in a given period
POST
/contact/getContactList
List contacts in the iVvy CRM
POST
/contact/getContact
Retrieve a single contact by ID
POST
/event/getEventList
List events filtered by date or venue
POST
/event/getEvent
Retrieve a single event record
POST
/venue/getVenueList
List venues accessible to the API key
POST
/invoice/getInvoiceList
List invoices in a given period
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the iVvy API by hand means handling its API-key request header and the POST-style list and get operations yourself. Through Jentic you install once, import iVvy from the API Directory, store the key once, and your agent calls it.
Permission scoping
iVvy sends its lookup parameters in the request body, so scope by operation: limit the agent to the operations it needs, such as listing events or fetching a venue. You pick the allowed set, so it stays within contact, event, venue, and invoice lookups.
Credential isolation
Your iVvy API key is stored once, encrypted, by your own Jentic One instance and injected into the request header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list iVvy events' or 'get a venue invoice', and Jentic returns the matching iVvy operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using iVvy API through Jentic.
What authentication does the iVvy API use?
iVvy uses an X-API-Key header issued from the partner console. Each key is scoped to a tenant and its accessible venues. Through Jentic the key is stored in the credential vault and added to outbound requests automatically.
Can I list all events booked at a venue with the iVvy API?
Yes. POST /event/getEventList accepts venue and date filters and returns the matching bookings. Combine it with POST /event/getEvent to fetch the full record for any event of interest.
What are the rate limits for the iVvy API?
iVvy does not publish numeric rate limits in the spec. They ask integrators to keep request volume reasonable, batch list calls, and contact partner support before running large historical syncs.
How do I retrieve an event through Jentic?
Search Jentic for 'get ivvy event', load the POST /event/getEvent schema, and execute with the event_id. Jentic injects the X-API-Key header so the agent only supplies the body parameters.
Why are all iVvy endpoints POST requests?
iVvy uses POST with a JSON body for both reads and writes so that filter and pagination parameters can be expressed as structured payloads rather than long query strings. Treat the getContactList, getEventList, and getVenueList calls as read operations even though the HTTP verb is POST.
Can I limit what my agent is allowed to do with the iVvy API?
Yes. Because you run Jentic One yourself, your own rules decide which iVvy operations and credentials the agent may use, so you can allow only the calls it needs. Since iVvy sends its lookup parameters in the request body, you scope by operation: grant just the ones the task requires, such as listing events with POST /event/getEventList or fetching a venue with POST /venue/getVenueList. You can keep the agent within contact, event, venue, and invoice lookups and withhold the rest, and the API key stays with your instance rather than the agent.
GET STARTED