List Sites - Makeswift Docs

List Sites

curl --request GET \
  --url https://api.makeswift.com/v2/sites \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.makeswift.com/v2/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.makeswift.com/v2/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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.makeswift.com/v2/sites"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v2/sites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "object": "error",
  "code": "forbidden",
  "message": "<string>"
}

GET

/

v2

/

sites

List Sites

curl --request GET \
  --url https://api.makeswift.com/v2/sites \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.makeswift.com/v2/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.makeswift.com/v2/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 => [
    "x-api-key: <api-key>"
  ],
]);

$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.makeswift.com/v2/sites"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v2/sites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

{
  "object": "error",
  "code": "forbidden",
  "message": "<string>"
}

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

Show child attributes

hasMore

boolean

required

The flag that indicates whether there are more sites available.