If this is your first time working with Engage's API or any API in general, please read through the sections below in order to gain a better understanding of how it works, what you can do with it, and where you should get started. Links to information on each of the API's endpoints is provided below, after the table of contents. The original API (Version 1.0) was retired on January 12th, 2015.

Introduction to the API
Getting Started

Overview | Obtaining Access | Workflow of Using the API

Connecting to the API (Security and Authentication)

Overview | How to Authenticate | Encryption | Additional Security Options

Working with Resources (Endpoints / Actions / Methods)

Overview | Making a Request / Call | Receiving a Response | Result Pagination | How to Call Successive Pages

Glossary of Terms
Frequently Asked Questions
Example Uses of the API

Endpoint References

Attendees

Events

Experiences

Finance Accounts | Requests | Transactions

Memberships

Organizations

Positions

Users

Curriculum Status

 


Attendees (/api/attendees)

Resource Description
GET /attendees or 

GET /attendees/{id}

Returns the event attendance tracking information for a single or multiple users, across individual or multiple events, ordered by Attendance ID.

 


Events (/api/events)

Resource Description

GET /events or 

GET /events/{id}

Returns event information for a single or multiple events, ordered by the event start date and time.

 


Experiences (/api/experiences)

Resource Description

GET /experiences or

GET /experiences/{id}

Returns single or multiple self-reported experience records, sorted by Experience ID.

 


Finance Accounts (/api/financeaccounts)

Resource Description

GET /financeaccounts or 

GET /financeaccounts/{id}

Returns a single or multiple finance accounts, ordered by Account ID.

 


Finance Requests (/api/financerequests)

Resource Description

GET /financerequests or 

GET /financerequests/{id}

Returns a single or multiple finance request submissions, ordered by the Submission Date.

 


Finance Transactions (/api/financetransactions)

Resource Description

GET /financetransactions or 

GET /financetransactions/{id}

Returns a single or multiple finance transaction records, ordered by Request ID and Transaction Date.

 


Memberships (/api/memberships)

Resource Description

GET /memberships or 

GET /memberships/{id}

Returns the memberships held by a single user, ordered by Organization Name and then Position Name.

 


Organizations (/api/organizations)

Resource Description

GET /organizations or 

GET /organizations/{id}

Returns a single or multiple organization profiles, sorted by Organization Name.

 


Positions (/api/positions)

Resource Description

GET /positions or

GET /positions/{id}

Returns the list of positions on an organization’s roster including the configuration settings specific to each position, ordered by Position ID.

 


Users (/api/users)

Resource Description

GET /users or 

GET /users/{id}

Returns the profile and other aggregate information for a single or multiple users, ordered by Username.

 

 

Curriculum Status (/api/curriculumstatus)

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Contact Us