> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Crewhu API

> Answer questions about your CSAT surveys, ratings per technician and per customer, badges and prizes from Crewhu, and send contest results

The common use is a question in chat: a technician asks an internal chat agent in Teams "what was our CSAT last month?" or "show me this week's negative surveys", and the agent reads the answer from Crewhu.

> [!NOTE]
>
> Automatically enabled when you configure Crewhu permissions in your agent workflow, or on a dashboard.

## What It Does

* Read CSAT surveys for any period: rating, comment, ticket number and title, the technicians the customer chose, and the customer's company and contact
* Count positive, neutral and negative ratings for the whole team, per technician or per customer
* List negative surveys with their comment and ticket, for a follow-up
* Read your Crewhu users with their PSA employee id, department and location
* Read badges given and prizes redeemed per technician
* Send the results of a contest that runs on an external metric

## Permission Groups

| Group | Covers |
| - | - |
| CSAT Surveys | Rating, rating label, comment, tags, survey type, ticket number and summary, the technicians the customer chose, the customer's company, contact name, email, phone and IP address, and when it was answered and reviewed. Read only |
| Employees | Your Crewhu users: name, employee id from your PSA, hire date, picture, location, department, position, and what each one manages. Read only |
| Badges & Prizes | Badges and the badges given, with who gave them, to whom, the message and points; prizes and the prizes redeemed. Read only |
| Contest Results | Send each technician's score for a contest's period; it replaces the leaderboard's results. Write only |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Sending contest results |
| **IT Admin** | Every read, and sending contest results | Nothing |
| **Full Automation** | Every read and write | Nothing |

## Safety Controls

| Control | Behavior |
| - | - |
| **One contest at a time** | A contest update must name the contest's start and end dates. Without them Crewhu would replace the results of every active contest that uses the metric, so Neo refuses it |
| **Only documented calls** | Crewhu documents one write. Neo refuses any other write to Crewhu |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.