GOGENCY Logo

API Reference

Comprehensive documentation for developers integrating with the GOGENCY API

API Reference

Introduction

v2.0

The GOGENCY API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-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 the following base URL:

https://api.gogency.com/v2

Authentication

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

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET "https://api.gogency.com/v2/clients" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Format

{
  "data": [
    {
      "id": "client_1a2b3c4d5e6f",
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "+1 (555) 123-4567",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z"
    },
    {
      "id": "client_2b3c4d5e6f7g",
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+1 (555) 987-6543",
      "created_at": "2025-03-14T10:30:00Z",
      "updated_at": "2025-03-14T10:30:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 10,
    "total_pages": 1
  }
}