List Contacts

Retrieve a paginated list of contacts with optional search and filtering.

GET /api/contacts

List contacts

cURL

curl --request GET \
  --url https://api.recepta.ai/api/v1/api/contacts \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.recepta.ai/api/v1/api/contacts"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.recepta.ai/api/v1/api/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.recepta.ai/api/v1/api/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.recepta.ai/api/v1/api/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.recepta.ai/api/v1/api/contacts")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recepta.ai/api/v1/api/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "message": "Clients retrieved successfully",
  "data": {
    "clients": [
      {
        "id": "697929d5ebccbcca5cdaf13b",
        "firstName": "Jane",
        "lastName": "Doe",
        "fullName": "Jane Doe",
        "email": "[e-mail]",
        "phone": "[phone]",
        "source": "API",
        "tags": [
          "lead",
          "website"
        ],
        "status": "active",
        "notes": "Interested in premium plan",
        "company_name": "Acme Corp",
        "address": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "customFields": {
          "referralSource": "google"
        },
        "isActive": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "total": 142,
      "page": 1,
      "limit": 20,
      "totalPages": 8
    }
  }
}

Authorizations

x-api-key · string · header · required

Your Recepta API key (starts with rcp_)

Query Parameters

page · integer · default: 1

Page number

limit · integer · default: 50

Results per page (max 100)

search · string

Search by name, email, or phone

source · enum<string>

Filter by source

Available options: MANUAL, FACEBOOK, CSV, API, CALL

tags · string

Filter by tag

Response

200 - application/json

Contacts retrieved

success · boolean

Example:

true

message · string

Example:

"Clients retrieved successfully"

data · object

Show child attributes