Quickstart

The EventPoint API uses HTTPS and JSON. You need the API base URL for your environment, an issued credential, and the project code configured for your integration.

1. Store your connection details

Keep credentials outside source control. The variable names below are examples; use your platform’s approved secret store in deployed applications.

API_URL="https://api.example.com"
API_KEY="your-issued-api-key"
PROJECT_CODE="your-project-code"

The examples use an API key. Use the credential type and authorization scope issued for your integration.

Codes and IDs

Codes are human-readable values used to locate a project or event. IDs are GUIDs used by most API operations. Codes and IDs are separate fields; do not send a code where an endpoint expects an ID.

2. Resolve the project code

Use GET /api/projects/get-for-code to turn the configured project code into the GUID expected by most later requests.

curl --get "$API_URL/api/projects/get-for-code" \
  --header "Accept: application/json" \
  --header "x-api-key: $API_KEY" \
  --data-urlencode "code=$PROJECT_CODE"

Retain the response’s id as your projectId. See the Get project by code reference for the current parameters and response schema.

3. Resolve an event code when needed

Operations that work with a specific event require an event GUID. If your configuration contains project and event codes, resolve both in one request:

GET /api/events/get-for-code?projectcode={projectCode}&eventcode={eventCode}

If you already retained the project GUID, use it directly:

GET /api/events/get-for-code-and-projectid?projectid={projectId}&eventcode={eventCode}

Both operations return an event whose id can be retained as eventId. Review the project-code operation or the project-ID operation for the current parameters and response schemas.

Codes are scoped

An event code is resolved within a project. Do not assume the same event code identifies the same event in another project.

Understand the context hierarchy

Scope	What it represents	Common use
Project	The boundary that owns event types, events, locations, categories, and people.	Required by most list and query operations.
Top-level event	The root event for a hierarchy, such as a conference.	Limits a workflow to one conference or program.
Parent event	An event that directly contains child events.	Finds sessions belonging to a conference or activities belonging to a trip.
Event	Any scheduled or unscheduled event.	Registration, facilitators, attendees, content, and event details.

For example, a conference is commonly a top-level event and its sessions are child events. Supply the conference event ID as parentIds in POST /api/events/query to find those sessions:

{
  "page": 1,
  "itemsPerPage": 25,
  "projects": ["00000000-0000-0000-0000-000000000000"],
  "parentIds": ["11111111-1111-1111-1111-111111111111"],
  "sort": "start",
  "sortDir": "Asc"
}

See Querying events for a complete request and pagination example.

4. Use the reference

Open the API reference to find supported paths, parameters, request bodies, and response schemas. The examples on each operation page are generated from the public contract.

Retain context safely

• Keep project and event IDs in request or application state once resolved.
• Cache stable code-to-ID mappings when appropriate, but refresh them if a lookup returns 404 Not Found.
• Keep credentials on a trusted server; identifiers are context, not secrets.
• Never use a cached identifier to bypass the authorization scope associated with the current credential.

Caution

An operation appearing in the reference does not grant access to every project or event. EventPoint still applies the permissions associated with your credential.

Continue to Registration or Forms when the workflow collects participant data.