Get organization
Get the organisation this request works in: the role it has there and what the request may do, the organisation’s standing, and whether zero data retention is on. An inference key can’t call it.
curl --request GET \
--url https://api.sqwish.ai/v1/organization \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sqwish.ai/v1/organization"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sqwish.ai/v1/organization', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"kind": "personal",
"name": "<string>",
"role": "owner",
"sees_billing": true,
"permissions": [
"<string>"
],
"status": "active",
"zero_data_retention": {
"enabled": true,
"since": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}Authorizations
Create an API key in the console.
Response
Successful Response
personal for a person's own organisation, organization for one shared by several people.
personal, organization The role this request works with. A console session's is its person's. An API key works as an owner in a personal organisation; in a shared one, an admin key as an owner, a billing member's as billing, and any other as a developer.
owner, developer, billing Whether this role sees billing: owners and billing members do.
What this request is allowed to do here, such as work.write: what its role allows and, for an API key, its access, but for changes only the console makes. Its standing, the projects it is kept to and a project's spending limit may still refuse a call.
Whether it may work: waitlisted until a personal organisation is admitted, blocked while it is suspended.
active, waitlisted, blocked, deleted Whether nothing a decision sends or answers is kept once its answer is returned. Sqwish switches it on for an organisation that has signed for it. Each switch takes a few minutes to reach every region, as the zero data retention guide says.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.sqwish.ai/v1/organization \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sqwish.ai/v1/organization"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sqwish.ai/v1/organization', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"kind": "personal",
"name": "<string>",
"role": "owner",
"sees_billing": true,
"permissions": [
"<string>"
],
"status": "active",
"zero_data_retention": {
"enabled": true,
"since": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}