GET /v1/search — Atom Files Developers

← API referenceBrowse & search · API access unavailable

API REFERENCE / SEARCH

`GET` /v1/search

Search names and selected metadata across authorized folders. This is not a promise of full-text content indexing. Filter by parent_id, paginate with cursor, and expose index freshness rather than silently implying real-time results.

Request fields

Location	Field	Type	Required	Description
Header	`Authorization`	string	Yes	Credential scoped to the authorized resource.
Query	`q`	string	Yes	Search text.
Query	`parent_id`	string	No	Limit search to an authorized folder.
Query	`cursor`	string	No	Opaque pagination cursor.

Request example

Example request

GET /v1/search?q=invoice&parent_id=folder_123
Authorization: Bearer <scoped token>

HTTP status codes

Status	Meaning
`200 OK`	Success response shown below.
`400 Bad Request`	Invalid query, filter, or cursor.
`401 Unauthorized`	Missing, expired, or invalid credential.
`403 Forbidden`	Credential is valid but lacks the required scope or role.
`429 Too Many Requests`	Rate limit reached; honor Retry-After when provided.
`503 Service Unavailable`	Service temporarily unavailable; retry safely.

Response fields

Field	Type	Example
`items`	object[]	[1 shown]
`items[].id`	string	file_789
`items[].name`	string	invoice.pdf
`items[].parent_id`	string	folder_123
`items[].version_id`	string	ver_012
`next_cursor`	string \| null	null
`indexed_through`	string (date-time)	2026-10-20T18:00:00Z

Response example

Example response

200 OK
Content-Type: application/json

{
  "items": [
    {
      "id": "file_789",
      "name": "invoice.pdf",
      "parent_id": "folder_123",
      "version_id": "ver_012"
    }
  ],
  "next_cursor": null,
  "indexed_through": "2026-10-20T18:00:00Z"
}