curl --request GET \
--url https://api.ionworks.com/searchimport requests
url = "https://api.ionworks.com/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/search', 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://api.ionworks.com/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"entity_type": "<string>",
"name": "<string>",
"project_id": "<string>",
"created_at": "<string>",
"parent_id": "<string>"
}
],
"query": "<string>",
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Search
Search across all entity types within the authenticated organization.
Applies ilike substring matching on name fields and Postgres prefix
tsquery (to_tsquery with :*) FTS on free-form text fields (description, notes).
Parameters
q : str Search query, minimum 2 characters. limit : int Maximum number of results to return in this page (1–100). offset : int Number of results to skip before this page. per_type : int Maximum results to return per entity type (1–20). Defaults to 5. entity_types : list[str] | None When provided, restrict results to these entity type strings. Omit to search all types. project_id : str | None When set, scope project-scoped entities (pipelines, optimizations, studies) to this project. Org-scoped entities are unaffected.
Returns
SearchResponse
Paginated results from matching entity types with total count.
curl --request GET \
--url https://api.ionworks.com/searchimport requests
url = "https://api.ionworks.com/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.ionworks.com/search', 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://api.ionworks.com/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ionworks.com/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ionworks.com/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ionworks.com/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "<string>",
"entity_type": "<string>",
"name": "<string>",
"project_id": "<string>",
"created_at": "<string>",
"parent_id": "<string>"
}
],
"query": "<string>",
"total": 123,
"limit": 123,
"offset": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Query Parameters
Search query (minimum 2 characters)
2Maximum results to return in this page
1 <= x <= 100Number of results to skip before this page
x >= 0Maximum results to return per entity type (1–20).
1 <= x <= 20Restrict to these entity type strings (repeatable). Omit to search all types.
When set, scope project-scoped entities to this project.
Was this page helpful?