Search Accounts by Name

Search for accounts using a query string and filters.

POST /api/search/v1/query

Search Accounts by Name

cURL

curl --request POST \
  --url https://{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"
      }
    ]
  }
}
'

import requests

url = "https://{instance}.domo.com/api/search/v1/query"

payload = {
    "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"
            }
        ] }
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}]}
  })
};

fetch('https://{instance}.domo.com/api/search/v1/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/search/v1/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{instance}.domo.com/api/search/v1/query"

	payload := strings.NewReader("{\n  \"count\": 100,\n  \"offset\": 0,\n  \"combineResults\": false,\n  \"query\": \"*sdk*\",\n  \"filters\": [],\n  \"facetValuesToInclude\": [\n    \"DATAPROVIDERNAME\",\n    \"OWNED_BY_ID\",\n    \"VALID\",\n    \"USED\",\n    \"LAST_MODIFIED_DATE\"\n  ],\n  \"queryProfile\": \"GLOBAL\",\n  \"entityList\": [\n    [\n      \"account\"\n    ]\n  ],\n  \"sort\": {\n    \"fieldSorts\": [\n      {\n        \"field\": \"display_name_sort\",\n        \"sortOrder\": \"ASC\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.domo.com/api/search/v1/query")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"count\": 100,\n  \"offset\": 0,\n  \"combineResults\": false,\n  \"query\": \"*sdk*\",\n  \"filters\": [],\n  \"facetValuesToInclude\": [\n    \"DATAPROVIDERNAME\",\n    \"OWNED_BY_ID\",\n    \"VALID\",\n    \"USED\",\n    \"LAST_MODIFIED_DATE\"\n  ],\n  \"queryProfile\": \"GLOBAL\",\n  \"entityList\": [\n    [\n      \"account\"\n    ]\n  ],\n  \"sort\": {\n    \"fieldSorts\": [\n      {\n        \"field\": \"display_name_sort\",\n        \"sortOrder\": \"ASC\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/search/v1/query")

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

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"count\": 100,\n  \"offset\": 0,\n  \"combineResults\": false,\n  \"query\": \"*sdk*\",\n  \"filters\": [],\n  \"facetValuesToInclude\": [\n    \"DATAPROVIDERNAME\",\n    \"OWNED_BY_ID\",\n    \"VALID\",\n    \"USED\",\n    \"LAST_MODIFIED_DATE\"\n  ],\n  \"queryProfile\": \"GLOBAL\",\n  \"entityList\": [\n    [\n      \"account\"\n    ]\n  ],\n  \"sort\": {\n    \"fieldSorts\": [\n      {\n        \"field\": \"display_name_sort\",\n        \"sortOrder\": \"ASC\"\n      }\n    ]\n  }\n}"

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

200

{
  "results": [
    {
      "accountId": "{account_id}",
      "displayName": "SDK Account",
      "status": "Active"
    }
  ]
}

{
  "message": "<string>"
}

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.

Show child attributes

Response

200

application/json

Search results returned successfully.

results · object[]

Show child attributes