Public APIs — overview
Yareta exposes separate public surfaces for different jobs. Pick one; do not mix keys.
| Need | Surface | Auth |
|---|---|---|
| Host the Yareta Assessment in your product | Assessment API /api/v1 | Developer key x-api-key |
| Act on behalf of a logged-in Yareta user | OAuth 2.0 then GraphQL | Bearer access token |
| No-code create deals/people | Zapier HTTP /api/zapier | Zapier key x-api-key |
| Deep partner embed (approved) | Partner GraphQL POST /api | OAuth Bearer or issued partner credentials |
Production API host: https://platform.yareta.ai
Human app: https://app.yareta.ai
Yareta is not API-only. Most customers never call these endpoints: they use the app and managed CRM. APIs exist so scores can flow into your scoring or CRM stack after you have built or chosen a Success Framework in Yareta.
You will not find platform source code or master secrets in the customer UI. You only receive credentials you create (or that Yareta issues for a named OAuth app).
What we do not publish here
Internal admin APIs, service-to-service tokens, infrastructure, and unpublished GraphQL admin operations are out of scope for this Help Centre. If you need a partner integration, connect@yareta.co will issue credentials and a scoped schema.
Conventions
- JSON request and response bodies (UTF-8).
- Assessment API errors:
{ "error": "Unauthorized"|"Bad Request"|…, "message": "…" }. - GraphQL: HTTP 200 with
{ "data", "errors" }for query errors; HTTP 401 for missing/invalid auth. - No published rate-limit numbers; treat the API as a business-volume integration and contact us before large bursts.
Environments
You will be given production credentials for live data. A sandbox/staging host may be issued for implementation; never point a production Zap at a preview URL.