Skip to main content
GET
/
search
/
{object}
Per-object deep search with cursor pagination
curl --request GET \
  --url https://api.arcuserp.com/v1/search/{object} \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "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": {}
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "url": "<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.

Path Parameters

​
object
enum<string>
required
Available options:
orders,
products,
accounts,
invoices,
serial_numbers,
quotes,
purchase_orders,
returns,
vendor_bills,
payments,
fulfillment_packages

Query Parameters

​
query
string
Maximum string length: 500
​
limit
integer
default:25
Required range: 1 <= x <= 100
​
starting_after
string

Cursor: ID of the last item from the previous page.

​
status
string

Status filter (object-specific).

​
from_date
string<date>
​
to_date
string<date>
​
account_id
string<uuid>
​
account_type
enum<string>
Available options:
business,
individual,
vendor
​
category_id
string<uuid>
​
location_id
string<uuid>

Layer 4 location filter for order-type objects.

​
expand
enum<string>[]
Available options:
full

Response

Cursor-paginated list of matching resources

​
object
enum<string>
Available options:
list
​
data
object[]
​
has_more
boolean
​
next_cursor
string | null
​
url
string