canonical: https://jentic.com/apis/vomo.org/vomo

# VOMO Client API

REST-based API for querying and managing volunteer data in VOMO. The API provides access to campaigns, projects, organizations, groups, forms, and certifications. The API exposes 15 endpoints secured with bearer authentication.

## For AI agents

Programmatically list campaigns, get campaign. Covers 15 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- List campaigns
- Get campaign
- Create group
- Query and filter VOMO Client API records by parameters
- Monitor VOMO Client API operational status and events

## Use cases

### Marketing Operations

Use the VOMO Client API to perform marketing operations programmatically. The API provides 15 endpoints covering core functionality including list campaigns, get campaign, list projects.

Example prompt: Call GET /campaigns to list campaigns

### Automated campaigns Management

Automate campaigns operations by combining multiple VOMO Client API endpoints. Agents can get campaign and then list projects in a single workflow.

Example prompt: Call GET `/campaigns/{id}` to get campaign, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call VOMO Client API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'list campaigns', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/campaigns` | List campaigns |
| GET | `/campaigns/{id}` | Get campaign |
| GET | `/projects` | List projects |
| GET | `/projects/{id}` | Get project |
| POST | `/groups` | Create group |
| GET | `/groups` | List groups |
| GET | `/groups/{id}` | Get group |
| PUT | `/groups/{id}` | Update group |

## Key resources

- **campaigns** — Operations related to campaigns
- **certificates** — Operations related to certificates
- **forms** — Operations related to forms
- **groups** — Operations related to groups
- **organizations** — Operations related to organizations

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 63 / 100
- **View full report:** https://jentic.com/apis/vomo.org/vomo/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring VOMO by hand means handling its JWT bearer token against api.vomo.org and managing the campaign, project, and group calls yourself. Through Jentic you install once, import VOMO Client from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** VOMO puts the resource id in the URL path (`/groups/{id}`, `/projects/{id}`), so a rule can pin your agent to reading one project or group. You choose the operations it may call, so group updates via the PUT are not included unless you add them.
- **Credential handling:** Your VOMO bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list campaigns' or 'read a group', and Jentic returns the matching VOMO operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the VOMO Client API use?

The VOMO Client API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list campaigns with the VOMO Client API?

Yes. Use the GET /campaigns endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the VOMO Client API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list campaigns through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list campaigns'. Jentic returns the matching VOMO Client API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the VOMO Client API have?

The VOMO Client API exposes 15 endpoints covering campaigns, certificates, forms operations.

### Can I limit what my agent is allowed to do with the VOMO Client API?

Yes. Because Jentic One is self-hosted, you write the rules that decide which VOMO operations and credentials your agent may use. Since VOMO puts the resource id in the URL path, such as `/projects/{id}` and `/groups/{id}`, you can pin the agent to reading a single project or group. You also choose the exact operations it may call, so an action like the PUT `/groups/{id}` group update stays out of reach unless you explicitly grant it.
