aVenture APIAddresses

Batch directory + companies payload

View as Markdown
Fetch the location directory, exact letter counts, and optional company URL slots in one request.

Authentication

X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 100
The size of the page to be returned
sortlist of stringsOptional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Request

This endpoint expects an object.
letterstringRequired
scopeenumRequired
Accepted location scope tokens for path and batch inputs
cursorstring or nullOptional

Opaque continuation from companyNextCursor; keeps deep company traversal keyset-based.

slugstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
410
Gone Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error