Run discovery now

POST

/orgs/{org}/discovery/run

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

• Production
• Staging

Reads every module and field from the CRM using the org’s stored connection, and writes a snapshot. Existing annotations are preserved; a field the CRM no longer returns is flagged as removed rather than deleted, so a project that mapped it still explains itself.

This route needs a connected org (POST /auth/orgs/{org}/connect), because it runs with no browser present. It is not the only way to discover: an administrator signing in gets an org discovered automatically with the token Zoho issues on the way through, and GET /auth/zoho/start?rediscover=1 re-reads the CRM the same way. Connecting is for working when nobody is there.

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 snapshot that was written, and how it differs from the one before it.

Media typeapplication/json

object

run

required

object

id

required

string

status

required

string

moduleCount

required

number

fieldCount

required

number

activeUserCount

required

number | null

errors

required

Array

startedByUserId

required

string | null

createdAt

required

string

diff

required

What changed against the previous run: modules and fields added, removed or altered.

object | null

Example^generated

{
  "run": {
    "id": "example",
    "status": "example",
    "moduleCount": 1,
    "fieldCount": 1,
    "activeUserCount": 1,
    "errors": [
      "example"
    ],
    "startedByUserId": "example",
    "createdAt": "example"
  },
  "diff": "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"
}

409

The org has no usable Zoho connection, so there is nothing to read from.

Media typeapplication/json

object

error

required

string

code

required

string

key

additional properties

Example^generated

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

502

The CRM could not be read. The message says why, bounded to 500 characters.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: DISCOVERY_FAILED

key

additional properties

Example

{
  "code": "DISCOVERY_FAILED"
}