Using the Rock API

Whether you're a developer or someone integrating a third-party app with Rock, the APIs unlock Rock’s full potential. With built-in tools to secure, test, and extend your endpoints, you can integrate and innovate with ease—no extra setup required.

Why would I use an API with Rock?

• Data Integration: Connect Rock to other apps and services for seamless data exchange.
• Custom Development: Build custom tools and features to meet your unique needs.
• Data Access: Programmatically retrieve and update Rock data for reports, syncing, and dashboards.
• Automation: Save time by automating tasks like imports, user management, and reporting.
• User Experience: Create custom interfaces that fit your ministry’s needs.
• Flexibility: Build solutions that grow and adapt as your needs change.

To start using APIs in Rock, notice there are two different options:

API v1

Navigate to Admin Tools > Settings > API Docs. For new integrations, we recommend using API v2, as it offers expanded capabilities and improved consistency.

API v2

Navigate to Admin Tools > Settings > API v2 Docs. You will find a list of entities and the corresponding endpoint. Each one has a list of methods available such as:

• Get: Gets a single item from the database.
• Put: Performs a full update of the item. All property values must be specified.
• Delete: Deletes a single item from the database.
• Patch: Performs a partial update of the item. Only specified property keys will be updated.
• Post: Creates a new item in the database.