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

# StaffViz API

StaffViz is a productivity and workforce management tool that streamlines time tracking, task monitoring, and team performance analysis. The API exposes 20 endpoints secured with bearer, oauth2 authentication.

## For AI agents

Programmatically retrieve current user info, list users. Covers 20 operations with bearer, oauth2 authentication.

## Scope

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

## Capabilities

- Retrieve current user info
- List users
- Create a new client
- Update an existing client
- Delete a client
- Search for a client

## Use cases

### Analytics Operations

Use the StaffViz API to perform analytics operations programmatically. The API provides 20 endpoints covering core functionality including retrieve current user info, list users, create a new client.

Example prompt: Call GET `/api/me` to retrieve current user info

### Automated Users Management

Automate users operations by combining multiple StaffViz API endpoints. Agents can list users and then create a new client in a single workflow.

Example prompt: Call GET `/api/users` to list users, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call StaffViz 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, oauth2 tokens manually.

Example prompt: Search Jentic for 'retrieve current user info', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/me` | Retrieve current user info |
| GET | `/api/users` | List users |
| POST | `/api/client/add` | Create a new client |
| POST | `/api/client/update` | Update an existing client |
| DELETE | `/api/client/delete` | Delete a client |
| GET | `/api/client/search` | Search for a client |
| POST | `/api/client/update_or_create` | Update or create a client |
| GET | `/api/clients` | List all clients |

## Key resources

- **Users** — User and account operations
- **Clients** — Client management operations
- **Projects** — Project management operations
- **Tasks** — Task management operations
- **Teams** — Team operations

## 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:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 75 / 100
  - AI Discoverability: 63 / 100
- **View full report:** https://jentic.com/apis/staffviz.com/staffviz/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 the StaffViz API by hand means choosing between its bearer and OAuth 2.0 auth on app.staffviz.com and managing client create, update, and delete calls yourself. Through Jentic you install once, import the StaffViz API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** You can limit the agent to the operations it needs, such as reading the current user, listing clients, or searching clients, so it stays on reads and never deletes a client or runs update-or-create unless you add those operations.
- **Credential handling:** Your StaffViz credential 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 all clients' or 'search for a client', and Jentic returns the matching StaffViz operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mixpanel** — Alternative analytics API
- **Amplitude** — Alternative analytics API
- **Segment** — Complementary analytics API
- **Pendo** — Complementary analytics API

## FAQ

### What authentication does the StaffViz API use?

The StaffViz API uses bearer, oauth2 authentication. 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 retrieve current user info with the StaffViz API?

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

### What are the rate limits for the StaffViz 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 retrieve current user info through Jentic?

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

### How many endpoints does the StaffViz API have?

The StaffViz API exposes 20 endpoints covering users, clients, projects operations.

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

Yes. Jentic One is self-hosted by you, so your own rules decide which StaffViz operations and credentials the agent may use. You can restrict it to read-only calls such as GET `/api/me`, GET `/api/users`, GET `/api/clients`, and GET `/api/client/search`, so it never reaches POST `/api/client/add`, POST `/api/client/update`, POST `/api/client/update_or_create`, or DELETE `/api/client/delete` unless you explicitly add those operations. This keeps the agent scoped to reading client and user data while write and delete actions stay off-limits.
