Skip to content

Common API Endpoints

This guide covers common API endpoints available in Gohorto.

User Management

Get Users

GET /api/v1/users Retrieve list of users with filtering options.

Get User

GET /api/v1/users/{id} Retrieve specific user details.

Create User

POST /api/v1/users Create new user account.

Update User

PUT /api/v1/users/{id} Update user information.

Application Management

Get Applications

GET /api/v1/applications Retrieve applications with filters.

Get Application

GET /api/v1/applications/{id} Retrieve specific application.

Update Application Status

PUT /api/v1/applications/{id}/status Update application status.

Program Management

Get Programs

GET /api/v1/programs Retrieve list of programs.

Get Program

GET /api/v1/programs/{id} Retrieve program details.

Create Program

POST /api/v1/programs Create new program.

Reporting

Get Reports

GET /api/v1/reports Generate and retrieve reports.

Export Data

GET /api/v1/export/{type} Export data in various formats.

Request Format

Headers

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Response Format

Responses are in JSON format with standard HTTP status codes.

Error Handling

Error Responses

Errors are returned with appropriate HTTP status codes and error messages.

Common Status Codes

  • 200: Success
  • 201: Created
  • 400: Bad Request
  • 401: Unauthorized
  • 404: Not Found
  • 500: Server Error

Next Steps