Latest snapshot and diff

GET

/orgs/{org}/discovery/latest

curl --request GET \
  --url 'https://api.sloose.com/orgs/org_9f3c/discovery/latest?connector=con_8f2a&snapshot=true' \
  --header 'Authorization: Bearer <token>'

• Production

The most recent run and how it differed from the one before it. run is null when discovery has never run for this organisation — the normal state of a freshly installed organisation, not an error.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Path Parameters

org

required

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

string

Example

org_9f3c

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

Query Parameters

connector

The connection this is about, by id: one of the organisation’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another organisation’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

string

Example

con_8f2a

The connection this is about, by id: one of the organisation’s, or your own. REQUIRED: absent or empty is 400 CONNECTION_REQUIRED, listing the connections this bearer may name, because nothing picks one for a request that does not say (design §14.8). Any other — another organisation’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

snapshot

true to include the full snapshot. It is large — every module and every field — so it is opt-in.

string

Allowed values: true false

Example

true

true to include the full snapshot. It is large — every module and every field — so it is opt-in.

Responses

200

The latest run, and how it differed from the one before it. diff is null when there was no run before it — a first read changed nothing, because there was nothing to change.

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

snapshot

Every module and field as the CRM returned them. Only with ?snapshot=true.

object

key

additional properties

Example^generated

{
  "run": {
    "id": "example",
    "status": "example",
    "moduleCount": 1,
    "fieldCount": 1,
    "activeUserCount": 1,
    "errors": [
      "example"
    ],
    "startedByUserId": "example",
    "createdAt": "example"
  },
  "diff": "example",
  "snapshot": {
    "additionalProperty": "example"
  }
}

400

The request — its body or its query — did not match the schema (issues carries the Zod issue list), or: The request named no connection (code: CONNECTION_REQUIRED, with connections: the ones this bearer may name). Nothing picks one for a request that does not say (design §14.8).

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

401

No bearer, or one that no longer resolves: a session that is unknown or expired (code: AUTH_REQUIRED), or an API token that was revoked or expired (TOKEN_REVOKED, TOKEN_EXPIRED), whose organisation is gone (ORG_NOT_FOUND) or whose member or user row is (MEMBERSHIP_GONE).

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 (code: ROLE_REQUIRED), or it was issued for a different organisation; the organisation has been closed (code: ORG_CLOSED, either kind of bearer); the person is banned (code: BANNED, a session); or it is a session that is signed in but in no organisation (code: NO_ORG): one that never joined one, or whose person was taken out of the one it was in, or left it. Signing in again changes nothing for NO_ORG; choosing or making an organisation does.

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

404

?connector= names a connection this person may not use: another organisation’s, or another person’s (code: CONNECTION_NOT_FOUND).

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

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).