866-908-4748
Support

THRIVE LOCAL API DOCUMENTATION

Introduction

The Thrive Local REST API provides a powerful, consistent, and flexible way to integrate our services into your applications. Our API follows REST principles, making it intuitive and easy to use with predictable resource-oriented URLs and standard HTTP methods. It supports JSON for both request and response formats, enabling seamless integration with any programming language. With comprehensive error handling, versioning, and robust authentication, the Thrive Local API empowers developers to build reliable and scalable applications that leverage our platform's full capabilities.

GET List All Customers

Endpoint

https://api.thrivelocal.com/v1/customers

Description

Retrieves a list of all customers in the Thrive Local system. Results can be filtered and paginated using query parameters.

Query Parameters

Parameter Type Required Description
page integer Optional Page number for pagination (default: 1)
limit integer Optional Number of results per page (default: 20, max: 100)
sort string Optional Field to sort by (e.g., "created_at", "last_name")
order string Optional Sort order ("asc" or "desc", default: "asc")
search string Optional Search term to filter results

Response

Success Response (200 OK)

JSON
{ "success": true, "data": { "customers": [ { "id": "cust_12345", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "+1 (555) 123-4567", "created_at": "2023-05-21T12:34:56Z" }, { "id": "cust_12346", "first_name": "Jane", "last_name": "Doe", "email": "[email protected]", "phone": "+1 (555) 987-6543", "created_at": "2023-05-20T10:22:33Z" }, { "id": "cust_12347", "first_name": "Robert", "last_name": "Johnson", "email": "[email protected]", "phone": "+1 (555) 456-7890", "created_at": "2023-05-19T08:11:22Z" } ], "pagination": { "total": 42, "page": 1, "limit": 20, "pages": 3 } } }
GET Get Customer Details

Endpoint

https://api.thrivelocal.com/v1/customers/{customer_id}

Description

Retrieves detailed information about a specific customer by their unique identifier.

Path Parameters

Parameter Type Required Description
customer_id string Required Unique identifier of the customer

Response

Success Response (200 OK)

JSON
{ "success": true, "data": { "id": "cust_12345", "first_name": "John", "last_name": "Smith", "email": "[email protected]", "phone": "+1 (555) 123-4567", "address": { "street": "123 Main St", "city": "Anytown", "state": "CA", "postal_code": "12345", "country": "US" }, "tags": ["new", "retail"], "created_at": "2023-05-21T12:34:56Z", "updated_at": "2023-05-21T12:34:56Z", "orders": [ { "id": "ord_7890", "amount": 125.99, "status": "completed", "date": "2023-05-22T14:30:00Z" }, { "id": "ord_7891", "amount": 89.50, "status": "processing", "date": "2023-05-25T09:15:00Z" } ] } }

Error Response (404 Not Found)

JSON
{ "success": false, "error": { "code": "resource_not_found", "message": "Customer not found", "details": { "resource": "customer", "id": "cust_12345" } } }
POST Add Customer

Endpoint

https://api.rizereviews.com/add_customer_data_thrivelocal

Description

Creates a new customer record in the Thrive Local system. This endpoint allows you to add a new customer with their personal information, contact details, and preferences.

Headers

Key Value Required
Content-Type application/json Required
X-API-Token Your API Token Required

Request Parameters

Parameter Type Required Description
id string Required Business ID
first_name string Required First Name
last_name string Required Last Name
email string Required Email
phone_number string Optional Phone Number
tag string Optional Use only for specific automation

Request Example

JSON
{ "id": "17XXXXXXXXXXXXX", "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone_number": "9876514321", "tag": "special_tag" }

Response

Success Response

JSON
{ "customerId": "987654321", "checkinId": "1234567890" }

Error Responses

JSON
{ "status": 401, "code": 1161, "message": "Invalid API key" }
JSON
{ "status": 401, "code": 1011, "message": "Business id is invalid" }
JSON
{ "status": "error", "message": "Missing required field(s): id, first_name, last_name, email" }
Aaron-Whittaker-1