Retrieve Custom APIs

Get all the Custom APIs and their rules currently defined on your token

Running a GET request to this endpoint will retrieve all Custom APIs currently defined for your token.


Custom APIs are returned as a JSON array of Custom API rulesets.

Each Custom API ruleset listed in the JSON array will include a rules objects array, the name of the custom api, and a urlPattern matching URLs to be extracted with this API.

The following is an example response when retrieving Custom APIs from this endpoint.

    "rules": [
        "name": "Description",
        "selector": ".entry-content p"
    "api": "/api/list",
    "urlPattern": "(http(s)?://)?(.*\\.)?*",
    "testUrl": ""

Learn more about Custom API Rulesets here.

Click Try It! to start a request and see the response here!