Flows

Retrieve all

GET https://lopbe.com/api/flows/
curl --request GET \
--url 'https://lopbe.com/api/flows/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "settings": {},
            "wait_time": 3,
            "wait_time_type": "days",
            "is_enabled": true,
            "total_sent_sms": 0,
            "total_pending_sms": 0,
            "total_failed_sms": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2025-10-01 11:39:42",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://lopbe.com/api/flows?page=1",
        "last": "https://lopbe.com/api/flows?page=1",
        "next": null,
        "prev": null,
        "self": "https://lopbe.com/api/flows?page=1"
    }
}

Retrieve one

GET https://lopbe.com/api/flows/{flow_id}
curl --request GET \
--url 'https://lopbe.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "settings": {},
        "wait_time": 3,
        "wait_time_type": "days",
        "is_enabled": true,
        "total_sent_sms": 0,
        "total_pending_sms": 0,
        "total_failed_sms": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2025-10-01 11:39:42",
    }
}

Create

POST https://lopbe.com/api/flows
Parameters Details Description
name Required String -
content Required String -
device_id Required Integer -
sim_subscription_id Required Integer -
wait_time Required Integer -
wait_time_type Required String Allowed values: minutes , hours , days
segment Optional String Allowed values: all , INT segment_id
is_enabled Optional Boolean -
curl --request POST \
--url 'https://lopbe.com/api/flows' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

Update

POST https://lopbe.com/api/flows/{flow_id}
Parameters Details Description
name Optional String -
content Optional String -
device_id Optional Integer -
sim_subscription_id Optional Integer -
wait_time Optional Integer -
wait_time_type Optional String Allowed values: minutes , hours , days
segment Optional String Allowed values: all , INT segment_id
is_enabled Optional Boolean -
curl --request POST \
--url 'https://lopbe.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
{
    "data": {
        "id": 1
    }
}

Delete

DELETE https://lopbe.com/api/flows/{flow_id}
curl --request DELETE \
--url 'https://lopbe.com/api/flows/{flow_id}' \
--header 'Authorization: Bearer {api_key}' \