List organizations
curl --request GET \
--url https://web-api.dev.soxai.site/api/orgs \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.dev.soxai.site/api/orgs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.dev.soxai.site/api/orgs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"orgId": "org_ab12cd34",
"orgName": "SOXAI Research",
"orgEmail": "research@example.com",
"orgPhone": "03-0000-0000",
"orgAddress": "1-1-1 Chiyoda, Tokyo",
"companyId": "company_9f8e7d",
"userCount": 12
}
]{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Organizations
List organizations
Not callable with a Sandbox key
A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it is internal or operational, outside the Sandbox surface. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox.
List the organizations the caller can see, each with its current member count.
The list is scoped, not filtered by a parameter: a PartnerAdmin receives only the
organizations owned by its own company, and an Admin receives every organization.
Parameters
- None. This endpoint takes no path, query or body parameter.
Response
200returns an array of organization documents. Each carriesuserCount, the number of documents on its roster, which counts members whose invitation is still pending as well.
Errors
- None specific to this endpoint. The statuses every endpoint can answer with are listed at the top of this page.
Authorization
- Scheme:
Authorization: Bearer <idToken>orsoxai-api-key: <api key>. - Accepted roles:
Admin,PartnerAdmin - Any other caller receives
403 Not enough permission.
GET
/
api
/
orgs
List organizations
curl --request GET \
--url https://web-api.dev.soxai.site/api/orgs \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.dev.soxai.site/api/orgs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.dev.soxai.site/api/orgs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"orgId": "org_ab12cd34",
"orgName": "SOXAI Research",
"orgEmail": "research@example.com",
"orgPhone": "03-0000-0000",
"orgAddress": "1-1-1 Chiyoda, Tokyo",
"companyId": "company_9f8e7d",
"userCount": 12
}
]{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Authorizations
HTTPBearerSoxaiApiKey
Response
Every organization the caller may see. userCount counts the roster documents, which includes members whose invitation is still pending.