Company Sites index
Token-authenticated; requires storefront.view (application_themes.view
accepted). Returns the company’s own sites in every state but
archived, unless filter[status]=archived asks for those. Members’
sites and branches are not listed. Returns 404 while member sites
are off for the company.
curl --request GET \
--url https://api.fluid.app/api/v202604/company/sites \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fluid.app/api/v202604/company/sites"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fluid.app/api/v202604/company/sites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fluid.app/api/v202604/company/sites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/v202604/company/sites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fluid.app/api/v202604/company/sites")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/v202604/company/sites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"meta": {
"request_id": "7f3c9a1e-52d4-4b8e-9c61-2a8e4f0d7b35",
"timestamp": "2026-11-09T14:08:31Z",
"pagination": {
"cursor": null,
"limit": 25,
"prev_cursor": null,
"next_cursor": null
}
},
"sites": [
{
"id": 52018,
"slug": "scranton-branch",
"title": "Scranton Branch",
"description": "Paper, toner and the people who sell them, straight from the Scranton branch.",
"image_url": "https://ik.imagekit.io/fluidapp/dunder-mifflin/sites/scranton-branch.png",
"canonical_url": "https://shop.dundermifflin.com/home/sites/scranton-branch",
"images": {
"thumb": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-200,c-at_max,f-auto,q-70/dunder-mifflin/sites/scranton-branch.png",
"width": 200
},
"medium": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/dunder-mifflin/sites/scranton-branch.png",
"width": 600
},
"large": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-1200,c-at_max,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png",
"width": 1200
}
},
"active": true,
"status": "published",
"publish_at": null,
"created_at": "2026-11-01T12:00:00Z",
"updated_at": "2026-11-08T09:30:00Z",
"seo": {
"title": "Scranton Branch",
"description": "Paper, toner and the people who sell them, straight from the Scranton branch.",
"image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png",
"indexable": true,
"id": null
},
"metafields": [],
"languages": [
"en"
],
"countries": [],
"visibility": "public",
"owner_kind": "company",
"required": false,
"position": 0,
"lock_version": 3,
"suspended_at": null,
"suspension_reason": null
}
]
}{
"message": "Invalid credentials."
}{
"error": "Not authorized."
}{
"error": {
"message": "<string>",
"details": {}
},
"status": 123,
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"pagination": {
"cursor": "<string>",
"limit": 25,
"prev_cursor": "<string>",
"next_cursor": "<string>"
}
}
}{
"error": {
"message": "<string>",
"details": {}
},
"status": 123,
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"pagination": {
"cursor": "<string>",
"limit": 25,
"prev_cursor": "<string>",
"next_cursor": "<string>"
}
}
}Authorizations
Bearer token authentication. Accepts company-admin tokens with
storefront.view for read operations and storefront.update
for writes and scan triggers (legacy per-resource grants like
categories.update / products.view / etc. are still accepted
during the migration), required on every company operation.
Storefront public operations under /api/v202604/{resource} and
/api/v202604/{resource}/{slug} are unauthenticated
(security: []).
Query Parameters
Response locale. ISO code (e.g. fr, de). When omitted,
responds in the company's default locale. On reads an
unsupported or unknown locale is ignored — the response comes
back in the default locale, never a 422. Any translated field
with no value in the requested locale falls back to its en
value.
"fr"
Free-text search over
translation-aware title and description fields, plus slug.
On /products it additionally matches the product-level sku and
every variant SKU.
On /products the match is TIERED: the term is matched first against
the fields that NAME a product — title in every locale, slug, sku
and every variant SKU — and description / metafields answer only when
no name match survives the other filters on the request. A bundle's copy
lists the products it contains, so matching name and copy in one pass
returned every pack that merely mentions a product ahead of the product
itself.
Substring-aware (word_middle), so partial terms match. Results are
returned in the requested sort order, not by relevance — search
resolves to an id set that the ordinary paginated query then filters,
and that id set is capped at 1000 matches per request.
Opaque cursor returned in meta.pagination.next_cursor (or
prev_cursor). Omit on the first page.
Page size. Default 25. Max 100. Requests above 100 return 422.
1 <= x <= 100ISO-2 country code. Restricts the catalog to resources available
in that country — combining the with_country_iso scope's
OR-empty semantics: unrestricted resources (no access_countries
rows) match every country.
"GB"
ISO locale. Restricts the catalog to resources translated in that locale.
"fr"
One of draft, scheduled, published or archived. Matches the
status the response shows, resolved at read time, so a scheduled
site whose publish_at has passed matches published. Suspended
sites are listed under the status they show.
draft, scheduled, published, archived Company-surface only. "true" / "false" restrict to active /
inactive rows; a blank value (filter[active]=) means "no
filter" — it is NOT where(active: nil).
, true, false Single sort key. Prefix with - for descending. Default
-created_at. These resources have no manual position, so
the position sort key is not offered.
title, -title, created_at, -created_at, updated_at, -updated_at Response
A page of the company's sites.
Shared success envelope for list / show / create / update
responses: the resource payload is returned alongside a top-level
integer status and meta. Composed onto each resource response
via allOf.
curl --request GET \
--url https://api.fluid.app/api/v202604/company/sites \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fluid.app/api/v202604/company/sites"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fluid.app/api/v202604/company/sites', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fluid.app/api/v202604/company/sites",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fluid.app/api/v202604/company/sites"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fluid.app/api/v202604/company/sites")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fluid.app/api/v202604/company/sites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": 200,
"meta": {
"request_id": "7f3c9a1e-52d4-4b8e-9c61-2a8e4f0d7b35",
"timestamp": "2026-11-09T14:08:31Z",
"pagination": {
"cursor": null,
"limit": 25,
"prev_cursor": null,
"next_cursor": null
}
},
"sites": [
{
"id": 52018,
"slug": "scranton-branch",
"title": "Scranton Branch",
"description": "Paper, toner and the people who sell them, straight from the Scranton branch.",
"image_url": "https://ik.imagekit.io/fluidapp/dunder-mifflin/sites/scranton-branch.png",
"canonical_url": "https://shop.dundermifflin.com/home/sites/scranton-branch",
"images": {
"thumb": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-200,c-at_max,f-auto,q-70/dunder-mifflin/sites/scranton-branch.png",
"width": 200
},
"medium": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-600,c-at_max,f-auto,q-75/dunder-mifflin/sites/scranton-branch.png",
"width": 600
},
"large": {
"url": "https://ik.imagekit.io/fluidapp/tr:w-1200,c-at_max,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png",
"width": 1200
}
},
"active": true,
"status": "published",
"publish_at": null,
"created_at": "2026-11-01T12:00:00Z",
"updated_at": "2026-11-08T09:30:00Z",
"seo": {
"title": "Scranton Branch",
"description": "Paper, toner and the people who sell them, straight from the Scranton branch.",
"image_url": "https://ik.imagekit.io/fluidapp/tr:w-1200,h-630,c-maintain_ratio,fo-auto,f-auto,q-80/dunder-mifflin/sites/scranton-branch.png",
"indexable": true,
"id": null
},
"metafields": [],
"languages": [
"en"
],
"countries": [],
"visibility": "public",
"owner_kind": "company",
"required": false,
"position": 0,
"lock_version": 3,
"suspended_at": null,
"suspension_reason": null
}
]
}{
"message": "Invalid credentials."
}{
"error": "Not authorized."
}{
"error": {
"message": "<string>",
"details": {}
},
"status": 123,
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"pagination": {
"cursor": "<string>",
"limit": 25,
"prev_cursor": "<string>",
"next_cursor": "<string>"
}
}
}{
"error": {
"message": "<string>",
"details": {}
},
"status": 123,
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"pagination": {
"cursor": "<string>",
"limit": 25,
"prev_cursor": "<string>",
"next_cursor": "<string>"
}
}
}