Get the registry document

GET

/orgs/{org}/config/registry

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

• Production
• Staging

The RegistryDoc as it currently stands — the modules, their keys and singular names, and their match defaults.

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 registry document.

Media typeapplication/json

object

version

integer

modules

required

Array<object>

object

key

required

string

/^[a-z][a-z0-9_]*$/

apiName

required

string

>= 1 characters

label

required

string

>= 1 characters

singular

required

string

/^[A-Za-z_$][\w$]*$/

color

string

defaultEnabled

boolean

uniqueFields

Array<string>

defaultDuplicateCheck

object

searchField

string

searchMethod

string

expression

string

excludedFields

Array<string>

seedMappings

object

key

additional properties

object

mode

string

Allowed values: column static expression search skip

source

string | null

staticValue

string | null

transform

string | null

skip

boolean

searchField

string | null

searchMethod

string | null

searchExpression

string | null

patch

object

when

Array<string>

Allowed values: pending created updated exists skipped filtered guarded dryrun error blocked

overwrite

string

Allowed values: always if-absent

expressionContext

string

/^[A-Za-z_$][\w$]*$/

apiDelayMs

integer

systemExcludedFields

Array<string>

dateFormat

string

Allowed values: DMY MDY YMD

Example

{
  "modules": [
    {
      "seedMappings": {
        "additionalProperty": {
          "mode": "column",
          "patch": {
            "when": [
              "pending"
            ],
            "overwrite": "always"
          }
        }
      }
    }
  ],
  "dateFormat": "DMY"
}

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