Sign in

v1

latestOpenAPI 3.1.02026-08-06492794.7 KB
Entities

Search entities

Search and filter entities using various criteria

get/entities/search

Query parameters

querystring
Example:acme corp

Search by entity name or client_id_number (contains match)

tagstring
Example:corporation

Filter by a single tag name

entity_types[]string[]

Filter by entity types (can specify multiple). Example: entity_types[]=LLC&entity_types[]=C-Corp

[
  "LLC",
  "C-Corp"
]
sort'name' | 'client_id_number' | 'entity_type' | 'primary_contact' | 'created_at' | 'updated_at'

Column to sort by

direction'asc' | 'desc'

Sort direction

query_type'and' | 'or'

How to combine advanced filters (used with filters parameter)

type'enum' required

Filter type (use 'enum' for tag filters)

field'tags' required

Field to filter on (currently only tags supported)

criteria'has_any_of' | 'has_all_of' | 'has_none_of' required

Tag filter criteria

valuesstring[] required

Array of tag names

Advanced filtering array. Each filter has type, field, criteria, and values. NOTE: Swagger UI generates filters[0][field]=tags format. Manually change [0] to [] for Rails: filters[][field]=tags Format: filters[][type]=enum&filters[][field]=tags&filters[][criteria]=has_any_of&filters[][values][]=tag1&filters[][values][]=tag2

[
  {
    "type": "enum",
    "field": "tags",
    "criteria": "has_any_of",
    "values": [
      "active",
      "verified"
    ]
  }
]

Response

Successful response with filtered entities

dataobject[]