> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# Search Accounts

GET https://api.coperniq.io/v1/accounts/search

Search accounts using up to two filters (prop1/op1/value1 and optionally prop2/op2/value2), combined with `logic` (AND/OR).

Properties:
- `propX` can be a standard field (e.g., `title`, `city`, `accountType`, `parentAccountId`, etc.) or a custom property key name.
- Use the `property key` from your company settings.
- Find the sub-accounts of an account with `parentAccountId` (e.g., `?prop1=parentAccountId&op1=eq&value1=123456`).

Sub-accounts are included in results like any other account. To keep only top-level accounts, drop results whose `parentAccountId` is not null.

Operators (`opX`):
- Equality: `eq`, `neq`
- Numeric/datetime comparisons: `gt`, `gte`, `lt`, `lte`
- Text/string matching: `contains` (case-insensitive)
- Lists: `in`, `nin` (CSV list in `valueX`)
- Ranges: `between` (use `valueX` as `from,to`)
- Existence: `exists` is not supported for custom properties due to performance limitations. Use `eq` or `neq` instead.

Value formats:
- `in`/`nin`: lists can be provided as:
  - Plain CSV: `value1=OPEN,ACTIVE`
  - Quoted CSV (to include commas inside a value): `value1="Last, First",Other`
  - JSON array: `value1=["Last, First","Other"]`
- `between`: `from,to` (e.g., `value1=2025-01-01,2025-12-31` or `value1=10,20`)
- Dates should be ISO 8601 strings; numeric-like values on custom properties are matched against both numeric and text representations.

Examples:
- status equals ACTIVE: `?prop1=status&op1=eq&value1=ACTIVE`
- custom id equals 1234: `?prop1=legacy_tool_project_id&op1=eq&value1=1234`
- title contains "Solar": `?prop1=name&op1=contains&value1=Solar`
- status IN (ACTIVE, ON_HOLD) AND city = Austin: `?prop1=status&op1=in&value1=ACTIVE,ON_HOLD&logic=and&prop2=city&op2=eq&value2=Austin`

**Note:** The `/clients` path is an alias for `/accounts` and will continue to work until users are individually notified and migrated.


Reference: https://docs.coperniq.io/api-reference/accounts/search-accounts

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Query parameters

- `prop1` (string, required) — First field to filter (standard or custom keyName)
- `op1` (enum, required) — Operator for prop1
  - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `in`, `nin`, `between`
- `value1` (string, required) — Value for prop1 (comma-separated values for in/nin or between)
- `logic` (enum, optional, default: and) — Logical combination when both prop1 and prop2 are provided
  - Allowed values: `and`, `or`
- `prop2` (string, optional) — Optional second field to filter
- `op2` (enum, optional) — Operator for prop2
  - Allowed values: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `in`, `nin`, `between`
- `value2` (string, optional) — Value for prop2 (comma-separated values for in/nin or between)
- `page_size` (integer, optional, default: 20) — Number of items per page (max 100)
- `page` (integer, optional, default: 1) — Page number (1-based)
- `order_by` (enum, optional, default: asc) — Sort order for results
  - Allowed values: `asc`, `desc`
- `include_archived` (boolean, optional, default: false) — Whether to include archived (inactive) records in the response. By default only active records are returned.
- `include_contacts` (boolean, optional, default: false) — Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

## Response

### 200

List of accounts matching filters

- `list of Account`

## Errors

### 400 Bad Request Error

Invalid request

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `UNAUTHORIZED`
- `field` (string, optional) — Field that caused the validation error (if applicable)

### 401 Unauthorized Error

Authentication failed

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `UNAUTHORIZED`

## Types

### Account

- `id` (integer, optional) — Unique identifier
- `createdAt` (string, optional) — Creation timestamp
- `updatedAt` (string, optional) — Timestamp of the most recent update to the record, including changes to its custom property values.
- `title` (string, optional) — Record title/name
- `description` (string, optional, nullable) — Record description
- `address` (list of string, optional) — Record location/address
- `isActive` (boolean, optional) — Whether the record is active
- `primaryEmail` (string, optional, nullable) — Primary contact email
- `primaryPhone` (string, optional, nullable) — Primary contact phone
- `number` (integer, optional) — Record number (e.g., 1234)
- `createdBy` (UserSummary, optional, nullable) — User who created the record. Null when the record was created by a non-user actor (e.g. automation or a contact).
- `updatedBy` (UserSummary, optional, nullable) — User who last edited a field on the record, derived from the changelog. Null when the record has never been edited or the last edit was made by a non-user actor. Returned by single-record GET only; list and search responses omit it.
- `custom` (map from string to any, optional) — Custom fields
- `accountType` (enum, optional, nullable) — Type of account (residential or commercial)
  - Allowed values: `RESIDENTIAL`, `COMMERCIAL`
- `contacts` (list of ContactRef, optional) — On GET requests, only populated when include_contacts=true is passed. Always populated on POST (create) and PATCH (update) responses. Ordered with the primary contact first, capped at 20 contacts.
- `parentAccountId` (integer, optional, nullable) — ID of the parent account when this account is a sub-account, otherwise null. Sub-accounts nest 1 level deep: a parent account is always a top-level account.

### UserSummary

Minimal user representation used in responses

- `id` (integer, optional)
- `firstName` (string, optional, nullable)
- `lastName` (string, optional, nullable)
- `email` (string, optional, nullable)
- `avatarUrl` (string, optional, nullable)

### ContactRef

- `id` (integer, optional)
- `name` (string, optional)
- `title` (string, optional, nullable) — Contact title (e.g. job title)
- `description` (string, optional, nullable)
- `emails` (list of string, optional)
- `phones` (list of string, optional)
- `isPrimary` (boolean, optional) — True for the primary contact (the first contact in the list). At most one contact is primary.

## Examples

**Response**

```json
[
  {
    "id": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "title": "string",
    "description": "string",
    "address": [
      "string"
    ],
    "isActive": true,
    "primaryEmail": "string",
    "primaryPhone": "string",
    "number": 1,
    "createdBy": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    },
    "updatedBy": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "avatarUrl": "string"
    },
    "custom": {},
    "accountType": "RESIDENTIAL",
    "contacts": [
      {
        "id": 1,
        "name": "string",
        "title": "string",
        "description": "string",
        "emails": [
          "string"
        ],
        "phones": [
          "string"
        ],
        "isPrimary": true
      }
    ],
    "parentAccountId": 123456
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.coperniq.io/v1/accounts/search"

querystring = {"prop1":"prop1","op1":"eq","value1":"value1"}

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

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

print(response.json())
```

```javascript
const url = 'https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1"

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1")

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

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

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/accounts/search?prop1=prop1&op1=eq&value1=value1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```