Reminders

This page includes all endpoints available for the reminders module of Logiciel Actif.

List all reminders

GET https://app.gem-books.com/api/reminders

This endpoint allows you to get the list of your reminders. The resources are returned, sorted by code (A-Z).

Query Parameters

Name	Type	Description
page	String	The number of page you wish to see. Default is 1.
per_page	String	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 application/json.

200: OK

{
    "data": [
        {
            "id": 43,
            "titre": "teste",
            "module": "clients",
            "moduleID": 2197,
            "userID": "205",
            "date": "2021-08-31 07:46:00",
            "closed": 0,
            "labels": null,
            "notes": ""
        },
        {
            "id": 42,
            "titre": "tes es sdf",
            "module": "clients",
            "moduleID": 2178,
            "userID": "205",
            "date": "2021-06-10 13:51:00",
            "closed": 0,
            "labels": "test 1",
            "notes": ""
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

Retrieve a reminder

GET https://app.gem-books.com/api/reminders

This endpoint allows you to get the details of a reminder.

Path Parameters

Name	Type	Description
id*	String	The ID of the reminder to retrieve

Headers

Name	Type	Description
Authentication*	String	Bearer token.
Accept*	String	Should be application/json.

200: OK

{
    // Response
}

Create a reminder

POST https://app.gem-books.com/api/reminders

This endpoint allows you to create a reminder. Returns the created reminder.

Headers

Name	Type	Description
Authentication*	String	Bearer token.
Accept*	String	Should be application/json.
Content-type	String	Should be application/json

Request Body

Name	Type	Description
title*	String	Title of reminder
module*	enum	module to insert the reminder into, here are the options available : clients,providers,sales,attributes,bookings,purchases
moduleID*	String	ID of previous module (EX : client)
userID*	String	ID of user the reminder is set to
date*	String	Date of the reminder
closed	bool	1 if reminder is closed
labels	String	Labels on the reminder, comma separated
notes	String	Notes of the reminder

200: OK

{
    // Response
}

Update a reminder

PUT https://app.gem-books.com/api/reminders

This endpoint allows you to update a specific reminder. Returns the updated reminder.

Path Parameters

Name	Type	Description
id*	String	ID of resource to update

Headers

Name	Type	Description
Authentication*	String	Bearer token.
Accept*	String	Should be application/json.
Content-type	String	Should be application/json

200: OK

{
    // Response
}