List organizations

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations \
  --header 'Authorization: <api-key>'

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

fetch('https://api.shareofmodel.ai/v1/organizations', 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.shareofmodel.ai/v1/organizations",
  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: <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.shareofmodel.ai/v1/organizations"

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

	req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations")

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

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

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "user_quota": 1073741823,
    "workspace_quota": 1073741823,
    "analysis_quota": 1073741823,
    "workspace_count": 123,
    "modules": [
      "<string>"
    ],
    "asset_evaluation_quota": 1073741823,
    "geo_audit_quota": 1073741823,
    "search_credits": 1073741823,
    "logo": "<string>",
    "salesforce_code": "<string>",
    "contract_end_date": "2023-12-25",
    "is_active": true,
    "is_pencil": true,
    "pencil_customer_id": 0
  }
]

GET

organizations

List organizations

curl --request GET \
  --url https://api.shareofmodel.ai/v1/organizations \
  --header 'Authorization: <api-key>'

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

fetch('https://api.shareofmodel.ai/v1/organizations', 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.shareofmodel.ai/v1/organizations",
  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: <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.shareofmodel.ai/v1/organizations"

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

	req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations")

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

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

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

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "user_quota": 1073741823,
    "workspace_quota": 1073741823,
    "analysis_quota": 1073741823,
    "workspace_count": 123,
    "modules": [
      "<string>"
    ],
    "asset_evaluation_quota": 1073741823,
    "geo_audit_quota": 1073741823,
    "search_credits": 1073741823,
    "logo": "<string>",
    "salesforce_code": "<string>",
    "contract_end_date": "2023-12-25",
    "is_active": true,
    "is_pencil": true,
    "pencil_customer_id": 0
  }
]

Authorizations

Authorization

string

header

required

Query Parameters

include_logo

boolean

If set to true, include the logo field in the response. Defaults to false.

Response

200 - application/json

string<uuid>

required

read-only

name

string

required

Maximum string length: 255

plan

enum<string>

required

pilot - pilot
starter - starter
suite - suite
enterprise - enterprise
pencil - pencil

Available options:

pilot,

starter,

suite,

enterprise,

pencil

user_quota

integer

required

Required range: 0 <= x <= 2147483647

workspace_quota

integer

required

Required range: 0 <= x <= 2147483647

analysis_quota

integer

required

Required range: 0 <= x <= 2147483647

workspace_count

integer

required

modules

string[]

required

read-only

asset_evaluation_quota

integer

Required range: 0 <= x <= 2147483647

geo_audit_quota

integer

Required range: 0 <= x <= 2147483647

search_credits

integer

Required range: 0 <= x <= 2147483647

logo

string

salesforce_code

string | null

SalesForce organization code

Maximum string length: 50

contract_end_date

string<date> | null

Contract end date

is_active

boolean

is_pencil

boolean

pencil_customer_id

integer<int64> | null

Required range: -9223372036854776000 <= x <= 9223372036854776000

Update favourite section

Create organization

Overview

Core API

Search API

List organizations

Authorizations

Query Parameters

Response