canonical: https://jentic.com/apis/atarim.io/atarim

# Atarim API

The Atarim API exposes the visual collaboration and task surface of the Atarim web-agency platform, designed for agencies and freelancers managing client websites. It is structured around three groups - authentication, triggers that fire when something changes inside Atarim (new task, new comment, status change), and actions that create or fetch records. The spec is shaped for Zapier-style integrations, so each trigger and action maps cleanly to an automation node in an external workflow tool.

## For AI agents

Pull triggers (new task, new comment, status change) from Atarim and create or fetch tasks, sites, and comments to feed agency workflows.

## Scope

Does not handle hosting, billing, or full project management - use for client-feedback triggers and task-and-site lookups inside Atarim only.

## Capabilities

- Authenticate a Zapier or external integration against an Atarim account via POST /zapier_app_auth
- Trigger downstream automations on new sites, tasks, comments, notes, status changes, urgency changes, or new tags
- Fetch a specific task or page from a given site using POST /get_task_by_site and /get_page_by_site
- Create new task records inside Atarim from external systems through the action endpoints
- Mirror Atarim status and urgency changes into agency project trackers in near real time

## Use cases

### Atarim to Project Tracker Sync

Agencies often run Atarim for client-visual feedback and a separate tool (Asana, ClickUp, monday) for delivery tracking. The Atarim API's trigger endpoints fire when a new task or comment lands, so an integration agent can mirror that into the delivery tracker within seconds. The agency keeps client-facing collaboration in Atarim while internal teams stay inside their existing project tool.

Example prompt: Poll GET /get_task for new tasks since the last cursor and create matching tasks in the project tracker for each one

### Status and Urgency Escalation

Agencies need to escalate when a client task changes status to 'urgent' or sits idle. The /get_status and /get_urgency triggers expose those changes, so an automation agent can route a Slack or email alert to the account manager whenever urgency is raised on a flagged site. This keeps SLA-tracked tasks from slipping inside Atarim.

Example prompt: Trigger on /get_urgency, filter for tasks where urgency is now 'High', and post a Slack alert to the account-manager channel

### Reporting on Client Comments

Agencies want to summarise how much client feedback came in this week per site. The /get_comment trigger and /get_task_by_site action let a reporting agent count and group comments by site, then push a weekly digest to project leads. This turns scattered Atarim comments into a single Friday rollup without manual exports.

Example prompt: Pull /get_comment for the last 7 days, group counts by site id, and post a digest to the agency reporting channel

### Atarim Automation via Jentic

Through Jentic, an AI agent automating an agency workflow searches by intent and Jentic returns the matching Atarim trigger or action with its schema. The Atarim api-key credential is held in your Jentic One instance, so the agent never handles the raw key. Build an end-to-end agency automation - new comment to escalation to tracker update - without writing a Zapier zap.

Example prompt: Use Jentic to search 'find new Atarim tasks', load GET /get_task, and execute it on a 5-minute schedule

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/zapier_app_auth` | Authenticate the integration against an Atarim account |
| GET | `/get_task` | Trigger on new tasks |
| GET | `/get_comment` | Trigger on new comments |
| GET | `/get_status` | Trigger on status changes |
| GET | `/get_urgency` | Trigger on urgency changes |
| GET | `/get_site` | Trigger on new client websites |
| POST | `/get_task_by_site` | Fetch a task scoped to a given site |
| POST | `/get_page_by_site` | Fetch a page scoped to a given site |

## Key resources

- **Authentication** — Authenticate an external integration against an Atarim account
- **Triggers** — Fire on new sites, tasks, comments, notes, status changes, urgency changes, and tags
- **Actions** — Fetch a task or page by site and create new records

## Why Jentic

- **Setup:** Wiring Atarim by hand means handling its API-key header auth across its client-feedback trigger and its many /get_* lookup endpoints. Through Jentic you install once, import the Atarim API from the API Directory, store the key once, and your agent calls it while Jentic sets the header.
- **Permission scoping:** Atarim's lookups take their target in the query or request body rather than a resource id in the URL path, so limit the agent to the operations it needs, such as get_task or get_site. You choose the operations it may call, so the task-by-site lookup is not included unless you add it.
- **Credential handling:** Your Atarim API key is stored once, encrypted, by your own Jentic One instance and set as the api-key header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'detect new Atarim tasks', and Jentic returns the matching trigger or /get_* operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Project management platform commonly paired with Atarim for delivery tracking
- **ClickUp** — Work management platform used as the downstream tracker for Atarim tasks
- **monday.com** — Work OS used by some agencies as an alternative collaboration surface

## FAQ

### What authentication does the Atarim API use?

The Atarim API uses an API key passed in the api-key header. Through Jentic, the key is held in the encrypted vault and the header is set at call time, so the agent never sees the raw value.

### Can I trigger automations on new Atarim tasks?

Yes. GET /get_task is a Zapier-style trigger that returns new task records since the last cursor. An integration agent can poll it on a short interval and route each new task into a downstream workflow.

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

The spec does not declare a numeric rate limit. The API is shaped around Zapier-style polling, so safe practice is to back off on HTTP 429 responses and avoid polling more often than once per minute per trigger.

### How do I escalate urgency changes through Jentic?

Search Jentic for 'detect Atarim urgency change', load GET /get_urgency, and chain the result into a Slack or email send. Jentic injects the api-key for the Atarim call and validates the trigger response against the schema.

### Can I create tasks back into Atarim?

Yes. The action endpoints under the spec create records inside Atarim, so a workflow can both react to triggers and write changes back - for example mirroring a closed ticket from the agency tracker into Atarim's task list.

### Is the Atarim API designed for Zapier?

The spec is structured around Zapier triggers and actions, with clear /get_* endpoints and authentication shaped for the Zapier app model. It also works for any agent platform that follows the same trigger-and-action pattern.

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

Yes. Because you run Jentic One yourself, you decide which Atarim operations the agent may call, so you can allow only the ones it needs, such as get_task or get_site, and leave the rest out. Atarim's lookups take their target in the query or request body rather than a resource id in the URL path, which means the task-by-site lookup is not available to the agent unless you explicitly add it. Your own rules govern both the operations and the API-key credential, so the agent can never reach an endpoint you have not granted.
