API Clients

The Clients API allows you to manage your client data programmatically. Below you will find the necessary information to utilize the Clients endpoints effectively.

Retrieve All Clients

To get a list of all clients, make a GET request to the /clients endpoint.

GET /api/v1/clients HTTP/1.1
Host: app.mellohq.com
Authorization: Bearer YourApiTokenHere
Accept: application/json

Retrieve a Single Client

To get the details of a specific client, make a GET request to the /clients/{uuid} endpoint using the client's UUID.

GET /api/v1/clients/{uuid} HTTP/1.1
Host: app.mellohq.com
Authorization: Bearer YourApiTokenHere
Accept: application/json

Replace {uuid} with the actual UUID of the client.

Create a New Client

To create a new client, make a POST request to the /clients endpoint with the required payload.

POST /api/v1/clients HTTP/1.1
Host: app.mellohq.com
Authorization: Bearer YourApiTokenHere
Content-Type: application/json
Accept: application/json

{
    "name": "John Doe",
    // Additional client fields...
}

Payload Parameters

• name: Required. The name of the client.
• // Add additional required or optional fields as needed.

Handling Responses

All successful responses for the Clients API are returned in JSON format. Make sure to handle different HTTP status codes and response data appropriately in your application.