Search account records

curl --request GET \
  --url https://api.whop.com/api/v1/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/search', 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.whop.com/api/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.whop.com/api/v1/search"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.whop.com/api/v1/search")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "match_reason": "id",
      "record": {
        "banner_image_url": "<string>",
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "object": "account",
        "parent_account_id": "<string>",
        "subtitle": "<string>",
        "title": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": null
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Search Account Records

Searches one account’s records in one call. account rows are account_id itself and, when you send include_subaccounts, its subaccounts; every other row belongs to one of those accounts.

Each object needs its own read permission on the record’s account, and rows you can’t read are left out without an error: account (biz_, company:basic:read), member (mber_, member:basic:read), membership (mem_, member:basic:read), payment (pay_, payment:basic:read), affiliate (aff_, affiliate:basic:read), review (rev_, company:basic:read), resolution_center_case (reso_, payment:resolution_center_case:read) and promo_code (promo_, promo_code:basic:read). A query containing @ also needs member:email:read, and a phone match member:phone:read. An invoice’s number finds the invoice as its payment.

query is trimmed and has to be 2 to 250 characters; a full card number returns a 400. data comes identifier matches first, such as a pasted ID, email address, card digits or invoice number, newest first within each kind of match. Every query of 3 or more characters is also ranked, and ranked rows follow, best match first. Each record appears once, and match_reason says why it matched. Search lists the query shapes and match reasons.

first caps the rows, 20 by default and up to 100. There is no cursor yet, so the response is a single page. Search ranks; to filter one resource or page through every match, use its list endpoint, such as GET /payments?query=.

GET

Search account records

curl --request GET \
  --url https://api.whop.com/api/v1/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/search', 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.whop.com/api/v1/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.whop.com/api/v1/search"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.whop.com/api/v1/search")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "match_reason": "id",
      "record": {
        "banner_image_url": "<string>",
        "description": "<string>",
        "id": "<string>",
        "image_url": "<string>",
        "object": "account",
        "parent_account_id": "<string>",
        "subtitle": "<string>",
        "title": "<string>"
      }
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": null
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-11-04-1"

Query Parameters

query

string

required

Text to search for, 2 to 250 characters.

types

enum<string>[]

Kinds of records to search. Defaults to every kind. account rows are account_id itself and, with include_subaccounts, its subaccounts.

Available options:

account,

member,

membership,

payment,

affiliate,

review,

resolution_center_case,

promo_code

account_id

string

required

The account to search, prefixed biz_. Records other than accounts belong to it, or with include_subaccounts to its subaccounts. Your credential needs read access to it; an account you can't read is a 404.

include_subaccounts

boolean

true also searches the subaccounts of a platform account_id: an ID, an email, card digits or a phone number finds their records, and the subaccounts themselves are found as account rows by name, ID or store link, or by the email of their owner, a team member or a customer. Safe to send for any account: one without subaccounts is searched as if this were false.

first

integer

default:20

Number of results to return from the start of the range.

Required range: x <= 100

Response

Search results: identifier matches first, then ranked rows, best match first.

data

object[]

required

Show child attributes

page_info

object

required

Show child attributes

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Search Account Records

Authorizations

Headers

Query Parameters

Response