Skip to main content
GET
/
search
Cross-resource search (5-bucket)
curl --request GET \
  --url https://api.arcuserp.com/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

​
query
string
required

Full-text search term. Alias: q.

Required string length: 1 - 500
​
q
string

Alias for query.

​
limit
integer
default:5

Results per bucket (1-25).

Required range: 1 <= x <= 25
​
expand
enum<string>[]

Pass expand[]=full to include raw DB row.

Available options:
full

Response

5-bucket search result envelope

​
object
enum<string>
Available options:
search_result
​
orders
object[]
​
products
object[]
​
accounts
object[]
​
invoices
object[]
​
serial_numbers
object[]
​
meta
object