Get site shares for user

Returns all site shares with access level info (Can Edit, Can View, Is Owner) for the specified user or the currently logged-in user if no userId is provided.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do

Returns all site shares with access level info (Can Edit, Can View, Is Owner) for the specified user or the currently logged-in user if no userId is provided. When basicInfo is true, additional site details such as active status, creation date, contact name/email, description, and advertising category IDs are included in the response for all or selected entities. The response is a JSON array of share objects, each containing the site ID, name, share type, and optionally a basicInfo map. Deleted sites are left out. Requires SHARED or ALL level permission on INVENTORY with VIEW access; viewing shares of other users requires ALL permission.

Query Params

userId integer

Unique identifier of the user whose site shares should be retrieved. If omitted, returns shares for the currently authenticated user

5001

basicInfo boolean

When true, includes additional site details (active status, creation date, contact name/email, description, category IDs) in the response for each share entry

true

basicInfoIds array<string>

Comma-separated list of site IDs for which to include basic information. If omitted or empty while basicInfo is true, basic info is included for all sites

4001

Responses

200

Site shares retrieved successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/siteShares.do?userId=5001&basicInfo=true&basicInfoIds=4001")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body