Clients
This page includes all endpoints available for the clients module of Logiciel Actif.
List all clients
GET
https://app.gem-books.com/api/clients
This endpoint allows you to get the list of your clients. The clients are returned sorted by code (A-Z).
Query Parameters
Name | Type | Description |
---|---|---|
page | integer | The number of the page you wish to see. Default is 1. |
per_page | integer | The number of the desired result per page. Default is 20. Maximum is 100. |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token. |
Accept | string | Should be |
Retrieve a client
GET
https://app.gem-books.com/api/clients/:id
This endpoint allows you to get the details of the client.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | The ID of the client to retrieve. |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token. |
Accept | string | Should be |
Create a client
POST
https://app.gem-books.com/api/clients
This endpoint allows you to create a client. Returns the created client.
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token. |
Content-Type | string | Should be |
Accept | string | Should be |
Request Body
Name | Type | Description |
---|---|---|
code | string | Client code. |
name | string | Client name. |
Update a client
PUT
https://app.gem-books.com/api/clients/:id
This endpoint allows you to update a specific client. Returns the updated client.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Client id to update. |
Headers
Name | Type | Description |
---|---|---|
Authentication | string | Bearer token. |
Content-Type | string | Should be |
Accept | string | Should be |
Last updated