Contacts

Retrieve all

GET https://lopbe.com/api/contacts/
curl --request GET \
--url 'https://lopbe.com/api/contacts/' \
--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,
            "user_id": 1,
            "name": "John Doe",
            "phone_number": "+123 123 123",
            "custom_parameters": {
                "age": 18,
            },
            "continent_code": "EU",
            "country_code": "IT",
            "has_opted_out": false,
            "total_sent_sms": 10,
            "total_pending_sms": 5,
            "total_failed_sms": 0,
            "total_received_sms": 20,
            "last_sent_datetime": "2025-10-01 11:42:40",
            "last_received_datetime": "2025-10-01 11:42:40",
            "last_datetime": null,
            "datetime": "2025-10-01 11:42:40",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://lopbe.com/api/contacts?page=1",
        "last": "https://lopbe.com/api/contacts?page=1",
        "next": null,
        "prev": null,
        "self": "https://lopbe.com/api/contacts?page=1"
    }
}

Retrieve one

GET https://lopbe.com/api/contacts/{contact_id}
curl --request GET \
--url 'https://lopbe.com/api/contacts/{contact_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "John Doe",
        "phone_number": "+123 123 123",
        "custom_parameters": {
            "age": 18,
        },
        "continent_code": "EU",
        "country_code": "IT",
        "has_opted_out": false,
        "total_sent_sms": 10,
        "total_pending_sms": 5,
        "total_failed_sms": 0,
        "total_received_sms": 20,
        "last_sent_datetime": "2025-10-01 11:42:40",
        "last_received_datetime": "2025-10-01 11:42:40",
        "last_datetime": null,
        "datetime": "2025-10-01 11:42:40",
    }
}

Create

POST https://lopbe.com/api/contacts
Parameters Details Description
phone_number Required String -
name Optional String -
custom_parameter_key[index] Optional String -
custom_parameter_value[index] Optional String -
curl --request POST \
--url 'https://lopbe.com/api/contacts' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'phone_number=+1231231231' \
--form 'name=Example name' \
{
    "data": {
        "id": 1
    }
}

Update

POST https://lopbe.com/api/contacts/{contact_id}
Parameters Details Description
phone_number Optional String -
name Optional String -
custom_parameter_key[index] Optional String -
custom_parameter_value[index] Optional String -
curl --request POST \
--url 'https://lopbe.com/api/contacts/{contact_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'custom_parameter_key[0]=name' \
--form 'custom_parameter_value[0]=john@example.com' \
{
    "data": {
        "id": 1
    }
}

Delete

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