List modules and their curation

GET

/orgs/{org}/config/modules

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

• Production
• Staging

Every module discovery has seen, with the org’s curation applied. present: false marks one the CRM no longer returns.

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

Every discovered module.

Media typeapplication/json

object

modules

required

Array<object>

A discovered CRM module with the org’s curation applied.

object

id

required

string

key

required

string

apiName

required

string

singular

required

string | null

enabled

required

boolean

present

required

False once discovery stops seeing the module in the CRM.

boolean

position

required

number | null

key

additional properties

Example^generated

{
  "modules": [
    {
      "id": "example",
      "key": "example",
      "apiName": "example",
      "singular": "example",
      "enabled": true,
      "present": true,
      "position": 1
    }
  ]
}

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