Get an organization and a bounded member page
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/organizations/{organizationId}', 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.openworklabs.com/v1/admin/organizations/{organizationId}",
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.openworklabs.com/v1/admin/organizations/{organizationId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/admin/organizations/{organizationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}")
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{
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"planTier": "<string>",
"seatLimit": 4503599627370495,
"memberCount": 4503599627370495,
"plan": {
"tier": "free",
"source": "default",
"paidBy": "none",
"users": 4503599627370495,
"userLimit": 4503599627370495,
"seats": 4503599627370495,
"endsAt": "<string>",
"ended": true
},
"people": {
"joined": 4503599627370495,
"invited": 4503599627370495
},
"subscriptions": {
"team": {
"status": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"cancelAtPeriodEnd": true
},
"enterprise": {
"status": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"cancelAtPeriodEnd": true
}
},
"openworkWeb": {
"complimentaryAccess": true,
"hasAccess": true,
"hasOngoingSubscription": true,
"subscriptionStatus": "<string>"
}
},
"members": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"joinedAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 4503599627370495,
"offset": 4503599627370495,
"search": "<string>",
"total": 4503599627370495,
"returned": 4503599627370495,
"hasMore": true,
"durationMs": 4503599627370495
},
"generatedAt": "2023-11-07T05:31:56Z"
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Admin
Get an organization and a bounded member page
Returns organization identity, the resolved plan (tier, who pays, users and the user limit every join path enforces, optional end date), and active memberships. Members are searched and paginated on the server. Does not calculate usage or resolve feature maps.
GET
/
v1
/
admin
/
organizations
/
{organizationId}
Get an organization and a bounded member page
curl --request GET \
--url https://api.openworklabs.com/v1/admin/organizations/{organizationId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/admin/organizations/{organizationId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/admin/organizations/{organizationId}', 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.openworklabs.com/v1/admin/organizations/{organizationId}",
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.openworklabs.com/v1/admin/organizations/{organizationId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.openworklabs.com/v1/admin/organizations/{organizationId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/admin/organizations/{organizationId}")
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{
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"planTier": "<string>",
"seatLimit": 4503599627370495,
"memberCount": 4503599627370495,
"plan": {
"tier": "free",
"source": "default",
"paidBy": "none",
"users": 4503599627370495,
"userLimit": 4503599627370495,
"seats": 4503599627370495,
"endsAt": "<string>",
"ended": true
},
"people": {
"joined": 4503599627370495,
"invited": 4503599627370495
},
"subscriptions": {
"team": {
"status": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"cancelAtPeriodEnd": true
},
"enterprise": {
"status": "<string>",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"cancelAtPeriodEnd": true
}
},
"openworkWeb": {
"complimentaryAccess": true,
"hasAccess": true,
"hasOngoingSubscription": true,
"subscriptionStatus": "<string>"
}
},
"members": [
{
"id": "<string>",
"userId": "<string>",
"name": "<string>",
"email": "<string>",
"role": "<string>",
"joinedAt": "2023-11-07T05:31:56Z"
}
],
"page": {
"limit": 4503599627370495,
"offset": 4503599627370495,
"search": "<string>",
"total": 4503599627370495,
"returned": 4503599627370495,
"hasMore": true,
"durationMs": 4503599627370495
},
"generatedAt": "2023-11-07T05:31:56Z"
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Path Parameters
Response
Organization detail returned.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?