The org’s connectors

GET

/orgs/{org}/connectors

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

• Production
• Staging

Every external system this org is connected to, with whether each holds a credential the server can use unattended, and how many production connectors the plan allows. Never returns a credential.

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

The connectors.

Media typeapplication/json

object

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

allowed

required

Production connectors the plan allows; null = unlimited.

number | null

Example

{
  "connectors": [
    {
      "kind": "zoho_crm",
      "environment": "production",
      "status": "active"
    }
  ]
}

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"
}