Skip to main content
POST
/
api
/
query
/
v1
/
functions
/
search
http
POST https://{instance}.domo.com/api/query/v1/functions/search
X-DOMO-Developer-Token: YOUR_TOKEN
Content-Type: application/json

{
  "name": "",
  "filters": [
    {
      "field": "notvariable"
    }
  ],
  "sort": {
    "field": "name",
    "ascending": true
  },
  "limit": 3,
  "offset": 0
}
{
  "totalHits": 525,
  "results": [
    {
      "id": 427,
      "name": "% Behind Schedule Objects",
      "owner": 8811501,
      "lastModified": 1670963682352,
      "created": 1670963682352,
      "global": false,
      "locked": false,
      "legacyId": "calculation_ab07cd22-2558-4f8f-b692-f39f6869a01a",
      "status": "VALID",
      "links": [
        {
          "resource": {
            "type": "CARD",
            "id": "dr:1947052903:616023142"
          },
          "visible": true,
          "active": false,
          "valid": "VALID"
        },
        {
          "resource": {
            "type": "DATA_SOURCE",
            "id": "aa7d9422-9abe-4581-bbf3-4a8cb5d3fc25"
          },
          "visible": false,
          "active": false,
          "valid": "ILLEGAL_REFERENCE"
        }
      ],
      "archived": false,
      "activeLinks": {}
    }
  ],
  "hasMore": true,
  "degraded": false
}

Authorizations

X-DOMO-Developer-Token
string
header
required

Domo Developer Token for authentication

Body

application/json
filters
object[]
required

Filter criteria for the request.

sort
object
required

Object that takes the field to sort by and ascending as true or false

limit
integer
required

How many records to limit the request by. Must be between 1 and 5000.

Required range: 1 <= x <= 5000
name
string

To search for Beast Modes by name.

offset
integer

Which record to start the response with.

Response

200 - application/json

Successful response

totalHits
integer
results
object[]
hasMore
boolean
degraded
boolean