API Endpoint Glossary (V3)


Accounts

  • Read Account by ID – Get a single account.

GET /api/v3/accounts/{accountId}

  • Update Account (Partial) – Patch fields for an account by ID.

PATCH /api/v3/accounts/{accountId}

  • Read Visit Account Logos – Logos for the visit’s customers.

GET /api/v3/visits/{visitId}/customerLogos

Configuration & Picklist Lookups

  • Get Account Options – Lookup option items by type.

GET /api/v3/accounts/options

  • List Account Sales Channels – Sales channels for the authenticated account.

GET /api/v3/accounts/sales-channels

  • List Account Statuses – All account/customer statuses.

GET /api/v3/accounts/statuses

  • List Attendee Roles – All attendee roles.

GET /api/v3/attendee-roles

  • List Coordinator Roles – All coordinator roles.

GET /api/v3/coordinator-roles

  • List Countries – Available countries.

GET /api/v3/countries

  • List Engagement Types – Engagement types.

GET /api/v3/engagement-types

  • List Industries – Industries (optionally include inactive).

GET /api/v3/industries

  • List Topics – Topics (optionally include inactive).

GET /api/v3/topics

  • List Visit Types – Visit types.

GET /api/v3/visit-types

  • List Opportunity Categories – Opportunity categories.

GET /api/v3/opportunity-categories

  • List Opportunity Stages – Opportunity stages.

GET /api/v3/opportunity-stages

  • List User Sales Channels – Sales channels for the authenticated user.

GET /api/v3/user-sales-channels

Persons

  • List Persons – Paginated persons list (optional active filter).

GET /api/v3/persons

  • Read Person by ID – Get a single person.

GET /api/v3/persons/{personId}

  • Update Person (Partial) – Patch fields for a person by ID.

PATCH /api/v3/persons/{personId}

  • Search Persons – Search by criteria.

POST /api/v3/persons/search

Rooms

  • Create or Update Room – Create or update a room.

PUT /api/v3/rooms

  • Read Room by ID – Get a single room.

GET /api/v3/rooms/{roomId}

  • Delete Room by ID – Delete a room.

DELETE /api/v3/rooms/{roomId}

Sites

  • List Sites – Paginated list of sites.

GET /api/v3/sites

  • Read Site by ID – Get a single site.

GET /api/v3/sites/{siteId}

Opportunities

  • Create Opportunity – Create a new opportunity.

POST /api/v3/opportunities

  • Update Opportunities (Bulk by IDs) – Partial update by IDs.

PATCH /api/v3/opportunities

  • Read Opportunity by ID – Get a single opportunity.

GET /api/v3/opportunities/{opportunityId}

  • Update Opportunity by ID (Partial) – Patch a single opportunity.

PATCH /api/v3/opportunities/{opportunityId}

Visits

  • Read Visit by ID – Get visit details.

GET /api/v3/visits/{visitId}

  • List Visits – Paginated visit records with optional filters.

GET /api/v3/visits

  • Create Visit Request (CRM) – Submit a CRM-originated visit request.

POST /api/v3/visits/request

Itinerary

  • Read Visit Itinerary – Itinerary details for the visit.

GET /api/v3/visits/{visitId}/itinerary

Surveys

  • Read Visit Survey – Survey data for a specific visit attendee.

GET /api/v3/visits/{visitId}/survey

  • Update Survey Response – Patch survey response for a survey/response.

PATCH /api/v3/surveys/{surveyId}/responses/{responseId}