v49

latestOpenAPI 3.0.2raw.githubusercontent.com2026-02-0620117129.6 KB
crawler

List crawlers

Lists all your crawlers.

get/1/crawlers

Query parameters

itemsPerPageinteger

Number of items per page of the paginated API response.

Number of items per page to retrieve.

pageinteger

Current page of the paginated API response.

Page to retrieve.

namestring

Name of the crawler.

Example:test-crawler

Name of the crawler for filtering the API response.

appIDstring

Algolia application ID where the crawler creates and updates indices.

Algolia application ID for filtering the API response.

Response

OK

itemsPerPageinteger

Number of items per page of the paginated API response.

pageinteger

Current page of the paginated API response.

totalinteger

Total number of retrievable items.

Example response

{
  "total": 100,
  "items": [
    {
      "id": "e0f6db8a-24f5-4092-83a4-1b2c6cb6d809",
      "name": "test-crawler"
    }
  ]
}