Connection health and members

GET

/auth/orgs/{org}/connection

curl --request GET \
  --url https://api.sloose.com/auth/orgs/org_9f3c/connection \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

Whether the org is connected, which scopes were granted, when it was last checked, and how many CRM users are active — the number plan limits are banded on. Also lists the org’s members and where each one’s role came from.

Never returns the token itself.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

The org id the session was issued for. A token for one org can never read another.

string

Example

org_9f3c

The org id the session was issued for. A token for one org can never read another.

Responses

200

Connection state and the org’s members.

Media typeapplication/json

object

connected

required

boolean

connection

required

object

scopes

required

Array<string>

health

required

string

activeUserCount

required

number | null

checkedAt

required

string | null

grantedByUserId

required

string | null

createdAt

required

string

members

required

Array<object>

object

userId

required

string

email

required

string

displayName

required

string | null

role

required

string

roleSource

required

Whether the role came from the CRM profile or was set here.

string | null

zohoProfile

required

string | null

lastSeenAt

required

string | null

Example^generated

{
  "connected": true,
  "connection": {
    "scopes": [
      "example"
    ],
    "health": "example",
    "activeUserCount": 1,
    "checkedAt": "example",
    "grantedByUserId": "example",
    "createdAt": "example"
  },
  "members": [
    {
      "userId": "example",
      "email": "example",
      "displayName": "example",
      "role": "example",
      "roleSource": "example",
      "zohoProfile": "example",
      "lastSeenAt": "example"
    }
  ]
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

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

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

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

Example^generated

{
  "error": "example",
  "code": "example"
}