List sites with the Netlify API

Lists the sites (projects, in the Netlify UI) the account can reach, with id, name, url, custom_domain, the published deploy and build settings. The id or the domain of a site is the site_id that the other tools take. Paginate with page and per_page: a page with fewer items than per_page is the last one.

Identifier
netlify_list_sites

The request

POST https://connect.reportei.com/api/tools/netlify_list_sites/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
namestringNoText matched against the site name.
filterstringNoall, only the sites of the teams the account owns, or only those it reaches as a guest.Values: all, owner, guest
per_pageintegerNoResults per page, up to 100.
pageintegerNoPage number, starting at 1.

Supported connections

Your customer connects their Netlify account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/netlify_list_sites. It becomes your agent's tool definition with no conversion.

Other Netlify tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.