canonical: https://jentic.com/apis/counselmore.com/counselmore

# CounselMore API

Jentic publishes the only available OpenAPI specification for CounselMore API, keeping it validated and agent-ready. The CounselMore API is a small Zapier-style integration surface for the CounselMore independent education consulting platform, exposing exactly two endpoints: a login endpoint that authenticates a consultant with username and password, and a contact-pull endpoint that returns the consultant's contact records in a shape compatible with Zapier and similar low-code integration tools.

## For AI agents

Authenticate a CounselMore consultant and pull their contact records for Zapier-style integrations. Two-endpoint API using HTTP Basic credentials.

## Scope

Does not handle student matching, college admissions data, or contact creation - use for CounselMore consultant login and read-only contact retrieval only.

## Capabilities

- Authenticate a CounselMore consultant by submitting username and password to the login endpoint and receive access credentials for follow-up calls
- Pull the full contact list for the authenticated consultant in a Zapier-compatible payload to drive downstream sync
- Use the contact pull as a periodic poll source so that newly added students or families propagate to a connected CRM or email tool
- Wrap the login and pull pair in a single agent action so an end-user can simply ask 'sync my CounselMore contacts' without handling credentials

## Use cases

### Daily CounselMore-to-CRM Contact Sync

An education consultant pulls their CounselMore contact list each night and upserts new or changed records into a downstream CRM such as HubSpot or Pipedrive. The login endpoint produces credentials, the pull endpoint returns the contacts, and the integration tool handles deduplication.

Example prompt: Call POST /zLogin with the consultant's credentials, then GET /pullContactsForZapier with the returned access credentials and upsert each contact into the target CRM.

### Email Marketing Audience Refresh

Refresh a Mailchimp or similar email audience with the consultant's CounselMore contact list once a week so that new families on the consultant's roster start receiving newsletters automatically. Avoids the manual CSV export-import loop.

Example prompt: Call POST /zLogin, then GET /pullContactsForZapier and push the resulting list into the email tool's audience-update endpoint.

### AI Agent Contact Lookup via Jentic

An assistant for an education consultant answers questions like 'how many CounselMore contacts do I have?' or 'give me my contact list for next week's prep' by calling the pull-contacts endpoint through Jentic. The agent never sees the consultant's password - Jentic injects it from the encrypted vault at call time.

Example prompt: Search Jentic for 'pull CounselMore contacts', load GET /pullContactsForZapier, and execute it to return the contact list directly to the consultant.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/zLogin` | Authenticate a consultant and return access credentials |
| GET | `/pullContactsForZapier` | Retrieve contacts for Zapier-style integration |

## Key resources

- **Authentication** — Submit username and password to receive access credentials for subsequent calls.
- **Contacts (Zapier)** — Retrieve the consultant's contact list in a Zapier-friendly payload.

## Why Jentic

- **Setup:** Wiring CounselMore by hand means handling its basic auth login flow against the counselmore.com host and coding your own contact-pull request. Through Jentic you install once, import CounselMore from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The CounselMore surface is a login call and a read-only contact pull with no resource id in the URL path, so scope by operation: limit the agent to the operations it needs, such as retrieving contacts. You choose the operations it may call, so it stays limited to that read.
- **Credential handling:** Your CounselMore credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'pull my CounselMore contacts', and Jentic returns the matching CounselMore operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **HubSpot CRM Contacts API** — Full-featured CRM contacts endpoint that can absorb CounselMore contacts as the system of record.
- **Pipedrive API** — Sales-focused CRM that can ingest CounselMore contacts as new persons or leads.
- **Copper CRM API** — Google Workspace-native CRM that can act as the destination for CounselMore contacts in a Workspace-centric stack.

## FAQ

### Why is there no official OpenAPI spec for CounselMore API?

CounselMore exposes a small Zapier-oriented integration surface but does not publish an OpenAPI specification for it. Jentic generates and maintains this spec so that AI agents and developers can call CounselMore API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the CounselMore API use?

The API uses HTTP Basic-style credentials: a consultant's username and password are submitted to POST /zLogin in the request body or query parameters and the response carries the access credentials used on the contacts endpoint. Through Jentic, the username and password are stored encrypted and injected at call time.

### Can I retrieve all my CounselMore contacts?

Yes. GET /pullContactsForZapier returns the consultant's contact list in the Zapier-compatible payload designed for downstream integrations, which is the only contact-read primitive in this surface.

### Can I create or update CounselMore contacts via the API?

No. The current spec only exposes a login endpoint and a read-only contacts pull. Contact creation and updates must happen inside the CounselMore application itself.

### What are the rate limits for the CounselMore API?

The OpenAPI spec does not declare numeric rate limits. Treat HTTP 429 responses as authoritative, back off using the Retry-After header where present, and contact CounselMore support to confirm acceptable polling frequency before scheduling frequent pulls.

### How do I sync CounselMore contacts to my CRM through Jentic?

Search Jentic for 'pull CounselMore contacts', load GET /pullContactsForZapier, execute it, and route the response into your CRM's contact upsert endpoint via a second Jentic operation. The agent does not need to handle the CounselMore login flow directly.

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

Yes. Because you run Jentic One yourself, your own rules decide which CounselMore operations the agent may call, and this surface is just a login step and a read-only contact pull with no resource id in the path. You can restrict the agent to only GET /pullContactsForZapier so it can read the consultant's contact list but nothing else, since contact creation and updates are not part of this API anyway. Your CounselMore username and password stay stored encrypted by your instance and are injected at call time, never entering the agent's prompt or logs.