Skip to main content
GET
/
v2
/
sites
List Sites
curl --request GET \
  --url https://api.makeswift.com/v2/sites \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "object": "site",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Hearth Furniture Company",
      "hostOrigin": "https://hearthfurniture.com",
      "publicApiKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "defaultLocale": "en-US"
    }
  ],
  "hasMore": true
}

Authorizations

​
x-api-key
string
header
required

API key authentication. Accepts either:

  • App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
  • Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Query Parameters

​
workspaceId
string<uuid>
required

The workspace ID to list sites from.

​
limit
number
default:20

The maximum number of sites to return.

Required range: 1 <= x <= 100
​
startingAfter
string<uuid>

The pagination cursor. This is used to indicate what ID to list from.

Response

​
object
enum<string>
required
Available options:
list
Example:

"list"

​
data
object[]
required
​
hasMore
boolean
required

The flag that indicates whether there are more sites available.