Contacts

Retrieve all

GET https://smsflow.su/api/contacts/
curl --request GET \
--url 'https://smsflow.su/api/contacts/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
search Optional String The search string.
search_by Optional String What field are you searching by. Allowed values are: phone_number , name.
continent_code Optional String Allowed values: AF , AN , AS , EU , NA , OC , SA
country_code Optional String Allowed values: AF , AX , AL , DZ , AS , AD , AO , AI , AQ , AG , AR , AM , AW , AU , AT , AZ , BS , BH , BD , BB , BY , BE , BZ , BJ , BM , BT , BO , BQ , BA , BW , BV , BR , IO , BN , BG , BF , BI , KH , CM , CA , CV , KY , CF , TD , CL , CN , CX , CC , CO , KM , CG , CD , CK , CR , CI , HR , CU , CW , CY , CZ , DK , DJ , DM , DO , EC , EG , SV , GQ , ER , EE , ET , FK , FO , FJ , FI , FR , GF , PF , TF , GA , GM , GE , DE , GH , GI , GR , GL , GD , GP , GU , GT , GG , GN , GW , GY , HT , HM , VA , HN , HK , HU , IS , IN , ID , IR , IQ , IE , IM , IL , IT , JM , JP , JE , JO , KZ , KE , KI , KP , KR , KW , KG , LA , LV , LB , LS , LR , LY , LI , LT , LU , MO , MK , MG , MW , MY , MV , ML , MT , MH , MQ , MR , MU , YT , MX , FM , MD , MC , MN , ME , MS , MA , MZ , MM , NA , NR , NP , NL , NC , NZ , NI , NE , NG , NU , NF , MP , NO , OM , PK , PW , PS , PA , PG , PY , PE , PH , PN , PL , PT , PR , QA , RE , RO , RU , RW , BL , SH , KN , LC , MF , PM , VC , WS , SM , ST , SA , SN , RS , SC , SL , SG , SX , SK , SI , SB , SO , ZA , GS , SS , ES , LK , SD , SR , SJ , SZ , SE , CH , SY , TW , TJ , TZ , TH , TL , TG , TK , TO , TT , TN , TR , TM , TC , TV , UG , UA , AE , GB , US , UM , UY , UZ , VU , VE , VN , VG , VI , WF , EH , YE , ZM , ZW
has_opted_out Optional Boolean
order_by Optional String What field to order the results by. Allowed values are: contact_id , name , phone_number , datetime , last_datetime , last_sent_datetime , last_received_datetime , total_sent_sms , total_pending_sms , total_failed_sms , total_received_sms.
order_type Optional String The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering.
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": "2026-02-28 23:07:07",
            "last_received_datetime": "2026-02-28 23:07:07",
            "last_datetime": null,
            "datetime": "2026-02-28 23:07:07",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://smsflow.su/api/contacts?page=1",
        "last": "https://smsflow.su/api/contacts?page=1",
        "next": null,
        "prev": null,
        "self": "https://smsflow.su/api/contacts?page=1"
    }
}

Retrieve one

GET https://smsflow.su/api/contacts/{contact_id}
curl --request GET \
--url 'https://smsflow.su/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": "2026-02-28 23:07:07",
        "last_received_datetime": "2026-02-28 23:07:07",
        "last_datetime": null,
        "datetime": "2026-02-28 23:07:07",
    }
}

Create

POST https://smsflow.su/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://smsflow.su/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://smsflow.su/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://smsflow.su/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://smsflow.su/api/contacts/{contact_id}
curl --request DELETE \
--url 'https://smsflow.su/api/contacts/{contact_id}' \
--header 'Authorization: Bearer {api_key}' \