Workflows

This page includes all endpoints available for the agenda workflows of Logiciel Actif (GEM-CAR required).

List all agenda workflows

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

This endpoint allows you to get the list of your workflows. The workflows are returned sorted by most recent number.

Headers

NameTypeDescription

Authentification*

string

Bearer Token

Accept

string

Should be application/json

{
    "data": [
        {
            "id": 2,
            "name": "Conflict",
            "order": 1,
            "color": "#000000",
            "background_color": "#ff0000"
        },
        {
            "id": 1,
            "name": "Not available",
            "order": 0,
            "color": "#000000",
            "background_color": "#cccccc"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 25,
        "total": 2
    },
    "success": true
}

List a specific agenda workflow

GET https://app.gem-books.com/api/agenda_workflows/:id

This endpoint allows you to get one specific workflow.

Headers

NameTypeDescription

Authentification*

string

Bearer Token

Accept

string

Should be application/json

{
    "data": [
        {
            "id": 1,
            "name": "Not available",
            "order": 0,
            "color": "#000000",
            "background_color": "#cccccc"
        }
    ],
    "success": true
}

Create an agenda workflow

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

Headers

NameTypeDescription

Authentification

string

Bearer Token

Accept

string

Should be application/json

{
    "data": [
        {
            "id": 1,
            "name": "Not available",
            "order": 0,
            "color": "#000000",
            "background_color": "#cccccc"
        }
    ],
    "success": true
}

Body Example

{
    "name": "Not available",
    "order": 0,
    "color": "#000000",
    "background_color": "#cccccc"
}

Update a workflow

PUT https://app.gem-books.com/api/agenda_workflows/:id

Headers

NameTypeDescription

Authentification

string

Bearer Token

Accept

string

Should be application/json

{
    "data": [
        {
            "id": 1,
            "name": "Not available",
            "order": 0,
            "color": "#000000",
            "background_color": "#cccccc"
        }
    ],
    "success": true
}

Body Example

{
    "name": "Not available",
    "order": 0,
    "color": "#000000",
    "background_color": "#cccccc"
}

Last updated