API Reference

Full-text search across catalog and account records (request-body variant).

post
https://platform.routy.app/api/v1/search

Identical behaviour to GET /v{version}/search but reads the SearchRequest from
the request body, which keeps large entity-type lists, date ranges and sort options off the
URL. Requires an authenticated token; results are scoped by the calling user's permissions.

Pagination uses offset/limit (0-based offset), or limitPerCategory to
guarantee up to N results per entity type (mutually exclusive with limit).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The search request containing query text, filters, sort and pagination.

string | null
accountId
array of int32s | null
accountId
int32 | null
int32 | null
int32 | null
documentTypes
array of objects | null
documentTypes
string | null
enum
Allowed:
string | null
enum
Allowed:
date-time | null
date-time | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago