API Reference

Search entities

get
https://app2.gettruss.io/api/v1/entities/search

Search and filter entities using various criteria

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search by entity name or client_id_number (contains match)

string

Filter by a single tag name

entity_types[]
array of strings

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

entity_types[]
string
enum
Defaults to name

Column to sort by

Allowed:
string
enum
Defaults to asc

Sort direction

Allowed:
string
enum
Defaults to and

How to combine advanced filters (used with filters parameter)

Allowed:
filters
array of objects

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

filters
Response

Updated 7 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago