Cross-resource search (5-bucket)
curl --request GET \
--url https://api.arcuserp.com/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/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.arcuserp.com/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.arcuserp.com/v1/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.arcuserp.com/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "search_result",
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"accounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"serial_numbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"meta": {
"did_you_mean": "<string>"
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Search
Cross-resource search (5-bucket)
Returns up to limit results per bucket across orders, products, accounts,
invoices, and serial_numbers. Results are ranked by relevance. Use
GET /v1/search/{object} for per-object deep search with cursor pagination.
GET
/
search
Cross-resource search (5-bucket)
curl --request GET \
--url https://api.arcuserp.com/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/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.arcuserp.com/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.arcuserp.com/v1/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.arcuserp.com/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "search_result",
"orders": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"products": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"accounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"invoices": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"serial_numbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object": "<string>",
"label": "<string>",
"sublabel": "<string>",
"snippet": "<string>",
"url": "<string>",
"relevance_score": 123,
"status": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"_raw": {}
}
],
"meta": {
"did_you_mean": "<string>"
}
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}Authorizations
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.
Query Parameters
Full-text search term. Alias: q.
Required string length:
1 - 500Alias for query.
Results per bucket (1-25).
Required range:
1 <= x <= 25Pass expand[]=full to include raw DB row.
Available options:
full Response
5-bucket search result envelope
Was this page helpful?
⌘I

