Get v2orgs

Get an organization by slug

GET /v2/orgs/{orgSlug}

cURL

cURL

curl --request GET \
  --url https://api.eda.prisme.ai/v2/orgs/{orgSlug} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.eda.prisme.ai/v2/orgs/{orgSlug}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.eda.prisme.ai/v2/orgs/{orgSlug}', 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.eda.prisme.ai/v2/orgs/{orgSlug}",
  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.eda.prisme.ai/v2/orgs/{orgSlug}"

	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.eda.prisme.ai/v2/orgs/{orgSlug}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/orgs/{orgSlug}")

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

200

{
  "name": "<string>",
  "slug": "<string>",
  "id": "<string>",
  "description": "<string>",
  "photo": "<string>",
  "domains": [
    "<string>"
  ],
  "branding": {
    "version": "<string>",
    "platformName": "<string>",
    "description": "<string>",
    "logo": {
      "light": "<string>",
      "dark": "<string>"
    },
    "favicon": "<string>",
    "colors": {
      "primary": "<string>",
      "secondary": "<string>",
      "accent": "<string>"
    },
    "fonts": {
      "heading": "<string>",
      "body": "<string>"
    },
    "customCssUrl": "<string>",
    "customCssInline": "<string>"
  },
  "navigation": {
    "version": 123,
    "homePage": "<string>",
    "menu": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "footer": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "quickActions": [
      {
        "id": "<string>",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ]
  },
  "joinRules": [
    {
      "rules": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ],
      "role": "<string>",
      "groups": [
        "<string>"
      ]
    }
  ],
  "defaultRole": "<string>",
  "settings": {},
  "subscriptionSlug": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgSlug · string · required

Response

200

application/json

Success

name · string · required

slug · string · required

id · string

description · string

photo · string

status · enum<string>

Available options: active, suspended

domains · string[]

branding · object

Show child attributes

navigation · object

Organization navigation configuration

Show child attributes

joinRules · object[]

Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]

Show child attributes

defaultRole · string

settings · object

subscriptionSlug · string

createdBy · string

updatedBy · string

createdAt · string

updatedAt · string