Contacts API Documentation

Retrieve all

Endpoint

GET https://lifterbrand.com/api/contacts/

Example

curl --request GET \
--url 'https://lifterbrand.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`. Defaults to `25`.

Response example

{ "data": [ { "id": 1, "first_name": "ABC", "last_name": "ABC", "email": "abc@example.com", "phone_number": "123456789", "facebook_url": "", "linkedin_url": "", "x_url": "", "instagram_url": null, "status": "", "address_1": "ABC", "address_2": "ABC", "city": "", "province": "", "country": "BD", "metadata": null, "datetime": "2024-02-03 11:23:27", "last_datetime": null } ], "meta": { "page": 1, "total_pages": 1, "results_per_page": 25, "total_results": 3 }, "links": { "first": "https://lifterbrand.com/api/contacts?&page=1", "last": "https://lifterbrand.com/api/contacts?&page=1", "next": null, "prev": null, "self": "https://lifterbrand.com/api/contacts?&page=1" } }

Retrieve one

Endpoint

GET https://lifterbrand.com/api/contacts/{contact_manager_id}

Example

curl --request GET \
--url 'https://lifterbrand.com/api/contacts/{contact_manager_id}' \
--header 'Authorization: Bearer {api_key}' \

Response example

{ "data": { "id": 1, "first_name": "ABC", "last_name": "ABC", "email": "abc@example.com", "phone_number": "123456789", "facebook_url": "", "linkedin_url": "", "x_url": "", "instagram_url": null, "status": "", "address_1": "ABC", "address_2": "ABC", "city": "", "province": "", "country": "BD", "metadata": null, "datetime": "2024-02-03 11:23:27", "last_datetime": null }}

Create

Endpoint

POST https://lifterbrand.com/api/contacts

Parameters	Details	Description
first_name	Required String	-
last_name	Required String	-
email	Required String	-
phone_number	Required String	Allowed values: `+1246756984`
facebook_url	Optional String	Allowed values: `url`
linkedin_url	Optional String	Allowed values: `url`
x_url	Optional String	Allowed values: `url`
instagram_url	Optional String	Allowed values: `url`
status	Optional String	Allowed values: `hot`, `mild`, `cold`
address_1	Optional String	150-250
address_2	Optional String	150-250
city	Optional String	-
background_color_transparency	Optional Integer
province	Optional Boolean	-
country	Optional String	-
metadata	Optional String	200-1000

Example

curl --request POST \
--url 'https://lifterbrand.com/api/contacts' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'first_name=Jhon' \
--form 'last_name=Do' \
--form 'phone_number=+123456789' \

Response example

{ "data": { "id": 1 } }

Update

Endpoint

POST https://lifterbrand.com/api/contacts/{contact_manager_id}

Parameters	Details	Description
first_name	Required String	-
last_name	Required String	-
email	Required String	-
phone_number	Required String	Allowed values: `+1246756984`
facebook_url	Optional String	Allowed values: `url`
linkedin_url	Optional String	Allowed values: `url`
x_url	Optional String	Allowed values: `url`
instagram_url	Optional String	Allowed values: `url`
status	Optional String	Allowed values: `hot`, `mild`, `cold`
address_1	Optional String	150-250
address_2	Optional String	150-250
city	Optional String	-
background_color_transparency	Optional Integer
province	Optional Boolean	-
country	Optional String	-
metadata	Optional String	200-1000

Example

curl --request POST \
--url 'https://lifterbrand.com/api/contacts/{contact_manager_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \

Response example

{ "data": { "id": 1 } }

Delete

Endpoint

DELETE https://lifterbrand.com/api/contacts/{contact_manager_id}

Example

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