Skip to content

One org, as staff see it

GET
/staff/orgs/{orgId}
curl --request GET \
--url https://api.sloose.com/staff/orgs/org_9f3c \
--header 'Authorization: Bearer <token>'

Backoffice route: a staff session, or ADMIN_TOKEN. The org, its entitlements resolved fresh, everyone in it, its connectors, its invitations and its newest runs — what a support conversation needs, read-only. Looking is written down, so an org can later see who looked.

orgId
required

The org

string
Example
org_9f3c

The org

The org.

Media typeapplication/json
object
org
required
object
id
required
string
name
required
string
dc
required
string
kind
required
string
Allowed values: production sandbox
zohoOrgId
required
string
createdAt
required
string
closedAt
required
string | null
closedReason
required
string | null
purgeAfter
required
string | null
billingAccountId
required
string | null
entitlements
required

Everything the widget needs to know about what this org may do.

object
orgId
required
string
kind
required
string
Allowed values: production sandbox
subscriptionOrgId
required

The org whose subscription governs this one.

string
creditsOrgId
required

The org whose ledger holds the AI credits this one spends.

string
plan
required
object
id
required
string
key
required
string | null
Allowed values: free team business enterprise
name
required
string
version
required
number
rank
required
number
status
required
string | null
Allowed values: free trialing active past_due suspended cancelled
period
required
object
start
required
string
end
required
string
limits
required
object
crm_users_max
required

CRM users allowed to use the widget; null = unlimited.

number | null
connectors_max
required

Production connectors the org may have; null = unlimited. CSV uploads do not count.

number | null
runs_per_month
required

Import runs that write at least one row, per period; null = unlimited (fair use). Dry runs never count.

number | null
rows_per_run
required

The most rows one import set may declare. Checked before anything is written.

number
rows_per_month
required

Server-side runs only. Browser runs are never refused on it.

number
row_overage_per_1000
required

USD per 1,000 rows beyond rows_per_month, server-side runs only; null = not offered.

number | null
modules_max
required

Null = unlimited.

number | null
schedules_max
required
number
history_days
required
number
ai_credits_monthly
required
number
sandbox_orgs
required
number
features
required
object
shared_projects
required
boolean
helper_libraries
required
boolean
server_run
required
boolean
mcp
required
boolean
rollback
required
boolean
scheduled_imports
required
boolean
crmUsers
required
object
active
required
number | null
max
required
number | null
overrides
required
Array<object>
object
id
required
string
key
required
string
value
required
Any of:
number
reason
required
string
grantedBy
required
string
expiresAt
required
string | null
overageAllowed
required
boolean
overageEnabled
required
boolean
graceEndsAt
required
string | null
trialEndsAt
required
string | null
cancelAtPeriodEnd
required
boolean
subscriptionVersion
required
string
resolvedAt
required
string
usage
required
object
periodStart
required
string
periodEnd
required
string
rowsWritten
required
number
rowsOverage
required
number
creditsUsed
required
number
runs
required
number
balance
required

AI credits. Included credits reset each period; purchased ones do not.

object
included
required
number
purchased
required
number
reserved
required
number
available
required

Included + purchased − reserved

number
periodStart
required
string
periodEnd
required
string
warnings
required

Applies right now regardless of the action.

Array<string>
Allowed values: LIMIT_ROWS LIMIT_RUNS LIMIT_ROWS_PER_RUN LIMIT_CONNECTORS LIMIT_MODULES LIMIT_SCHEDULES LIMIT_CRM_USERS LIMIT_SANDBOX FEATURE_SHARED_PROJECTS FEATURE_HELPER_LIBRARIES FEATURE_SERVER_RUN FEATURE_MCP FEATURE_ROLLBACK FEATURE_SCHEDULED_IMPORTS CREDITS_EXHAUSTED STATUS_SUSPENDED STATUS_PAST_DUE
cached
required
boolean
members
required
Array<object>
object
userId
required
string
email
required
string
displayName
required
string | null
role
required
string
Allowed values: operator builder admin owner
roleSource
required

Where the role came from: the CRM profile at sign-in, or set by hand here. A manual role is not reset by signing in again.

string | null
zohoProfile
required
string | null
externalUserId
required

How the org’s CRM knows this member — the Zoho user id. Null for someone who joined another way.

string | null
lastSeenAt
required
string | null
blockedAt
required

When access was revoked. Null while they can still use the org.

string | null
banned
required

The person is banned — refused in every org, not just this one.

boolean
key
additional properties
connectors
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: zoho_crm
roles
required

Source | destination | both

string
environment
required
string
Allowed values: production sandbox
label
required
string
externalId
required

The system’s own id — the Zoho org id.

string | null
region
required

The Zoho data centre.

string | null
status
required
string
Allowed values: active revoked
connected
required

Whether it holds a usable credential, so the server can read the system with nobody present.

boolean
health
required

Ok | revoked | error, from the credential’s last use.

string
scopes
required
Array<string>
activeUserCount
required
number | null
checkedAt
required
string | null
grantedByUserId
required
string | null
followRoles
required
boolean
createdAt
required
string
revokedAt
required
string | null
invitations
required
Array<object>
object
id
required
string
email
required
string
role
required
string
status
required
string
Allowed values: pending accepted revoked expired
invitedByEmail
required
string
expiresAt
required
string
createdAt
required
string
runs
required

The newest ten.

Array<object>

One import run. Retired nightly past the plan’s history window.

object
id
required
string
orgId
required
string
connectorId
required

The destination this run wrote to. Null means the org’s default CRM: a run from before connectors were named, or one authorised by an API token or an older session, which name no connector.

string | null
projectId
required
string | null
userId
required
string | null
mode
required
string
Allowed values: widget server
dryRun
required
boolean
status
required
string
Allowed values: authorised running complete cancelled error
declaredRows
required
number
rowsWritten
required
number
rowsCreated
required
number
rowsUpdated
required
number
rowsFailed
required
number
modules
required
Array<string> | null
error
required
string | null
summary
required
object | null
startedAt
required
string | null
finishedAt
required
string | null
createdAt
required
string
Example
{
"org": {
"kind": "production"
},
"entitlements": {
"kind": "production",
"plan": {
"key": "free"
},
"status": "free",
"warnings": [
"LIMIT_ROWS"
]
},
"members": [
{
"role": "operator"
}
],
"connectors": [
{
"kind": "zoho_crm",
"environment": "production",
"status": "active"
}
],
"invitations": [
{
"status": "pending"
}
],
"runs": [
{
"mode": "widget",
"status": "authorised"
}
]
}

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

No such org, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}