Skip to main content
GET
Required ACL: settings

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

appID
string

Algolia application ID for filtering the API response. Algolia application ID where the crawler creates and updates indices.

itemsPerPage
integer
default:20

Number of items per page to retrieve. Number of items per page of the paginated API response.

Required range: 1 <= x <= 100
name
string

Name of the crawler for filtering the API response. Name of the crawler.

Maximum string length: 64
Example:

"test-crawler"

page
integer
default:1

Page to retrieve. Current page of the paginated API response.

Required range: 1 <= x <= 100

Response

OK

Pagination information.

items
crawlerResponse Ā· object[]

Crawlers.

itemsPerPage
integer
default:20

Number of items per page of the paginated API response.

Required range: 1 <= x <= 100
page
integer
default:1

Current page of the paginated API response.

Required range: 1 <= x <= 100
total
integer

Total number of retrievable items.

Example:

100

Last modified on March 23, 2026