API ReferenceOverview

API Reference

The Tewdy API is organized around REST principles. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Base URL

All API requests should be made to:

https://api.tewdy.com/v1

Authentication

The Tewdy API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.

curl https://api.tewdy.com/v1/users \
  -H "Authorization: Bearer YOUR_API_KEY"

Endpoints

Users

  • GET /users - List all users
  • GET /users/:id - Get a specific user
  • POST /users - Create a new user
  • PUT /users/:id - Update a user
  • DELETE /users/:id - Delete a user

Projects

  • GET /projects - List all projects
  • GET /projects/:id - Get a specific project
  • POST /projects - Create a new project
  • PUT /projects/:id - Update a project
  • DELETE /projects/:id - Delete a project

Rate Limiting

API requests are rate-limited to 1000 requests per hour per API key.

Errors

The API uses standard HTTP response codes to indicate success or failure:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 500 - Server Error
Getting StartedOverview