Lookup customer by email

curl --request GET \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers \
  --header 'x-api-key: <api-key>'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers"

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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers",
  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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers")

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "nationality": "<string>",
    "region": "<string>",
    "whatsapp": "<string>",
    "facebook": "<string>",
    "instagram": "<string>",
    "linkedin": "<string>",
    "comments": "<string>",
    "currencies": "<string>",
    "assigned_to": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "jsmith@example.com"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "whatsapp": "<string>",
        "type": "<string>",
        "notes": "<string>"
      }
    ],
    "custom_fields": {},
    "stats": {
      "total_deals": 123,
      "total_leads": 123,
      "total_activities": 123
    }
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

GET

customers

Lookup customer by email

curl --request GET \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers \
  --header 'x-api-key: <api-key>'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers"

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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers",
  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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/customers")

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

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "nationality": "<string>",
    "region": "<string>",
    "whatsapp": "<string>",
    "facebook": "<string>",
    "instagram": "<string>",
    "linkedin": "<string>",
    "comments": "<string>",
    "currencies": "<string>",
    "assigned_to": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "full_name": "<string>",
      "email": "jsmith@example.com"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "whatsapp": "<string>",
        "type": "<string>",
        "notes": "<string>"
      }
    ],
    "custom_fields": {},
    "stats": {
      "total_deals": 123,
      "total_leads": 123,
      "total_activities": 123
    }
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

Authorizations

x-api-key

string

header

required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Query Parameters

string<email>

required

Response

Customer found

success

enum<boolean>

Available options:

true

data

object

Show child attributes

Getting started

Working with data

Workspace administration

Communications & scheduling

Connect an application

Endpoints

Lookup customer by email

Authorizations

Query Parameters

Response