The HireOrSell API
Read and manage clients, contacts, projects, invoices, time entries, transactions and more from your own tools or from an AI agent.
Quick start
The base URL is https://hireorsell.com/api/v1. Create an API key in the developer portal, then send it with every request.
curl https://hireorsell.com/api/v1/clients \
-H "X-API-Key: YOUR_API_KEY"The API root, GET /api/v1, needs no credentials and returns a JSON index with links to this page and the spec.
Authentication
- API key: send it in the
X-API-Keyheader. - Bearer token: send
Authorization: Bearer <token>. - OAuth 2.0: use the authorization code flow for third-party integrations.
Rate limits
| Plan | Requests per minute | Requests per day |
|---|---|---|
| Developer | 60 | 1,000 |
| Professional | 300 | 10,000 |
| Enterprise | 1,000 | 100,000 |
Errors
Every error is JSON with a machine-readable code, a message, a request id and a hint that says how to fix the problem. Unknown API addresses return a JSON 404 too, never an HTML page.
{
"error": {
"code": "unauthorized",
"message": "Missing or invalid authentication credentials",
"type": "authentication_error",
"request_id": "req_0123456789abcdef01234567",
"documentation_url": "https://hireorsell.com/developers#errors",
"hint": "Send your API key in the X-API-Key header..."
}
}Idempotency
For requests that create data, send an Idempotency-Key header. Repeating a request with the same key returns the original response and sets X-Idempotent-Replayed: true.
Resources
| Group | What it covers | Operations |
|---|---|---|
| Authentication | Token-based authentication | 1 |
| OAuth | OAuth 2.0 authorization flows | 5 |
| Developer Portal | Developer account management, API keys, subscriptions, and usage | 12 |
| Clients | Client management with contacts, notes, invoices, and projects | 15 |
| Contacts | Contact management with activity, comments, notes, tags, and tasks | 22 |
| Projects | Project management with members, files, milestones, and reports | 23 |
| Invoices | Invoice creation, payments, PDF generation, and delivery | 8 |
| Workflows | Workflow management with issues, pause/resume, and archiving | 12 |
| Time Entries | Time tracking with clock in/out and break management | 9 |
| Transactions | Financial transactions and categories | 10 |
| Emails | Email management, drafts, sending, sync, and threads | 9 |
| Calendar | Calendar event management | 5 |
| Organization | Organization settings, members, invitations, and business hours | 13 |
| Webhooks | Webhook management, testing, deliveries, and verification | 9 |
| Reports | Financial, project, time, and lead reports | 4 |
| User | User notifications and preferences | 4 |
| Favorites | Favorite items management | 3 |
Every operation, with parameters and response shapes, is in the OpenAPI spec.
Ready to connect your tools?
Start free, create an API key, and make your first request in minutes.