Ivvycode iVvy API

Name: iVvy API
Brand: iVvy API
Availability: InStock

✓ Official Vendor SpecCRMContact ManagementapiKey6 EndpointsREST

For Agents

Look up contacts, events, venues, and invoices in the iVvy hospitality and events platform.

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.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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

GET STARTED

Start building with iVvy API

Explore with Jentic

View OpenAPI Document

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 the Jentic vault.

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

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

iVvy X-Api-Key values are stored encrypted in the Jentic vault. Agents receive scoped execution tokens — the header is injected at request time and never enters agent context or logs.

Intent-based discovery

Agents search by intent (e.g. 'list iVvy events' or 'get a venue invoice') and Jentic returns matching iVvy operations with their input schemas, so the agent can call the right endpoint without consulting iVvy documentation.

Time to first call

Direct iVvy integration: 1-2 days for partner key issuance, request body modelling, and pagination. Through Jentic: under 1 hour — search, load schema, execute.

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.

Ivvycode iVvy API

Connect the iVvy API to your agent

Capabilities

Start building with iVvy API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs