Search Accounts
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., status, title, city, type, accountId, etc.) or a custom property key name.
- Use the property key from your company settings.
- Filter by parent account with accountId. clientId is accepted as a deprecated alias for backwards compatibility.
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.
Request
- Base URL: https://api.coperniq.io/v1
- URL: https://api.coperniq.io/v1/accounts/search
- Auth: API key in header x-api-key
Query parameters
First field to filter (standard or custom keyName)
Operator for prop1
Value for prop1 (comma-separated values for in/nin or between)
Logical combination when both prop1 and prop2 are provided
Optional second field to filter
Operator for prop2
Value for prop2 (comma-separated values for in/nin or between)
Number of items per page (max 100)
Page number (1-based)
Sort order for results
Whether to include archived (inactive) records in the response. By default only active records are returned.
Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.
Response
List of accounts matching filters
Changes
No recorded changes to this operation across all 1 revision of this API.