Skip to content

agent: Admin Page - update the README to highlight the API calls used and link #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sweetmantech wants to merge 1 commit into
base: main
Choose a base branch
from
Open

agent: Admin Page - update the README to highlight the API calls used and link #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,38 @@ admin/
- **Language:** TypeScript 5
- **Styling:** Tailwind CSS 4
- **React:** 19
- **Auth:** [Privy](https://privy.io) (Bearer token)
- **Data Fetching:** TanStack React Query
- **Linting:** ESLint 9 with next/core-web-vitals

## API Calls

All API calls are authenticated with a Privy Bearer token (`Authorization: Bearer <accessToken>`).

The base URL is resolved from `lib/consts.ts`:
- **Production:** `https://recoup-api.vercel.app`
- **Test:** `https://test-recoup-api.vercel.app`

| Method | Endpoint | Purpose | Docs |
|--------|----------|---------|------|
| `GET` | `/api/admins` | Check if the authenticated account is an admin | [Check Admin Status](https://developers.recoupable.com/api-reference/admins/check) |
| `GET` | `/api/admins/emails?account_id=<id>` | List all Resend emails sent to an account (for Pulse email preview) | [List Account Emails](https://developers.recoupable.com/api-reference/admins/emails) |
| `GET` | `/api/admins/sandboxes` | Fetch sandbox statistics per account | [List Sandboxes](https://developers.recoupable.com/api-reference/admins/sandboxes) |
| `GET` | `/api/admins/sandboxes/orgs` | Fetch org repo commit statistics | [List Sandbox Orgs](https://developers.recoupable.com/api-reference/admins/sandboxes-orgs) |
| `GET` | `/api/tasks/runs?account_id=<id>&limit=<n>` | Fetch recent Trigger.dev task runs for an account | [Get Task Runs](https://developers.recoupable.com/api-reference/tasks/runs) |

### Where each call is made

- **`/api/admins`** — `hooks/useIsAdmin.ts` — guards the entire dashboard; redirects non-admins
- **`/api/admins/emails`** — `lib/recoup/fetchAccountPulseEmails.ts` + `lib/recoup/fetchPulseEmailById.ts` — powers the `PulseEmailModal` on `/accounts/[account_id]`
- **`/api/admins/sandboxes`** — `lib/fetchAdminSandboxes.ts` — populates the main sandboxes data table
- **`/api/admins/sandboxes/orgs`** — `lib/recoup/fetchAdminSandboxOrgs.ts` — populates the `/sandboxes/orgs` org repos table
- **`/api/tasks/runs`** — `lib/recoup/fetchAccountTaskRuns.ts` — shows recent Pulse task runs on the `/accounts/[account_id]` detail page (auto-polls every 10 s)

Full API reference: [developers.recoupable.com](https://developers.recoupable.com)

## Learn More

- [Next.js Documentation](https://nextjs.org/docs)
- [Tailwind CSS v4](https://tailwindcss.com/docs)
- [Recoup API Docs](https://developers.recoupable.com)
Loading