List a module’s fields

GET

/orgs/{org}/config/fields/{module}

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

• Production
• Staging

Every field discovery found on the module, with the org’s annotations attached. Fields the CRM has stopped returning are hidden unless you ask for them — they still matter when reading an old template.

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.

module

required

The module’s key or CRM API name — either is accepted.

string

Example

accounts

The module’s key or CRM API name — either is accepted.

Query Parameters

connector

The connection this is about, by id: one of the org’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 org’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

string

Example

con_8f2a

The connection this is about, by id: one of the org’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 org’s, or another person’s — is 404 CONNECTION_NOT_FOUND.

all

true to include fields the CRM no longer returns.

string

Allowed values: true false

Example

true

true to include fields the CRM no longer returns.

Responses

200

The module’s fields, and the registry version they belong to.

Media typeapplication/json

object

module

required

object

key

required

string

apiName

required

string

hidden

required

How many fields this answer LEFT OUT because the CRM no longer returns them — always 0 when all=true. Without it a client cannot tell “none are gone” from “you did not ask”, and would have to send the second request to find out there was nothing to show.

number

fields

required

Array<object>

A destination field definition, plus present, removedAt and the org’s annotation.

object

key

additional properties

registryVersion

required

number

Example^generated

{
  "module": {
    "key": "example",
    "apiName": "example"
  },
  "hidden": 1,
  "fields": [
    {
      "additionalProperty": "example"
    }
  ],
  "registryVersion": 1
}

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

404

No such module or connection, or it is not visible to this session.

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