Skip to main content
POST
/
api
/
search
/
v1
/
query
Search Accounts by Name
curl --request POST \
  --url https://{domo_instance}.domo.com/api/search/v1/query \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "count": 100,
  "offset": 0,
  "combineResults": false,
  "query": "*sdk*",
  "filters": [],
  "facetValuesToInclude": [
    "DATAPROVIDERNAME",
    "OWNED_BY_ID",
    "VALID",
    "USED",
    "LAST_MODIFIED_DATE"
  ],
  "queryProfile": "GLOBAL",
  "entityList": [
    [
      "account"
    ]
  ],
  "sort": {
    "fieldSorts": [
      {
        "field": "display_name_sort",
        "sortOrder": "ASC"
      }
    ]
  }
}
'
{
  "results": [
    {
      "accountId": "{account_id}",
      "displayName": "SDK Account",
      "status": "Active"
    }
  ]
}

Authorizations

​
X-DOMO-Developer-Token
string
header
required

Developer token for authentication.

Body

application/json
​
query
string
required

The search query string.

Example:

"*sdk*"

​
entityList
string[][]
required

The entity list to search within.

Example:
[["account"]]
​
count
integer
default:10

How many results to return.

Example:

100

​
offset
integer
default:0

The results offset.

​
combineResults
boolean
default:false
​
filters
object[]

Filters to apply to the search.

​
facetValuesToInclude
enum<string>[]

Facet values to include in the search results.

Available options:
DATAPROVIDERNAME,
OWNED_BY_ID,
VALID,
USED,
LAST_MODIFIED_DATE
​
queryProfile
string

The query profile to use.

Example:

"GLOBAL"

​
sort
object

Sort options.

Response

Search results returned successfully.

​
results
object[]