MFmfullbrook
Sites

List sites

Show all sites the current token has access to.

Processing mode: <small><code>sync</code></small>

get/sites

Request

  • Base URL
    https://forge.laravel.com/api
  • Auth
    OAuth 2
    Authorization codehttps://forge.laravel.com/oauth/authorize
    Token URLhttps://forge.laravel.com/oauth/token
    Scopesserver:view
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

includestring

Available includes are server, serverCount, serverExists, tags, tagsCount, tagsExists, latestDeployment, latestDeploymentCount, latestDeploymentExists, securityRules, securityRulesCount, securityRulesExists, redirectRules, redirectRulesCount, redirectRulesExists. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

page[cursor]string

The cursor to start the pagination from.

filter[name]string

Response

Paginated set of SiteResource

Example response

{
  "included": [
    {
      "attributes": {
        "created_at": "2025-07-29T09:00:00Z",
        "updated_at": "2025-07-30T09:00:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.