API Overview

Introduction

Welcome to the Gangmates API documentation. This API allows developers to integrate with the Gangmates platform, providing access to features such as paystubs and user management. This document provides an overview of the available endpoints and how to interact with them.

Base URLs

• Staging Environment: https://stage.gangmates.com

• Production Environment: https://gangmates.com

Rate Limiting

Each company is limited to 100 requests per minute. If the limit is exceeded, requests will be delayed and must be retried after the limit resets.

Endpoints

Paystubs

• Get List of Paystubs

  GET /api/paystubs

  Retrieves a list of paystubs for the authenticated company.

• Create a New Paystub

  POST /api/paystubs

  Creates a new paystub for the authenticated company.

Users

• Get List of Users

  GET /api/users

  Retrieves a list of users for the authenticated company.

• Create a New User

  POST /api/users

  Creates a new user for the authenticated company.

• Get User by ID

  GET /api/users/{id}

  Retrieves a user by their ID.

• Update User by ID

  PUT /api/users/{id}

  Updates a user by their ID.

• Delete User by ID

  DELETE /api/users/{id}

  Deletes a user by their ID.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request.

• 200 OK - The request was successful.

• 201 Created - The resource was successfully created.

• 400 Bad Request - The request was invalid or cannot be otherwise served.

• 401 Unauthorized - Authentication credentials were missing or incorrect.

• 404 Not Found - The requested resource does not exist.

• 429 Too Many Requests - The rate limit has been exceeded.

Contact

For any questions or support, please contact our support team at [e-mail].