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?all=1' \
  --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 project.

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

all

Set to 1 to include fields the CRM no longer returns.

string

Example

1

Set to 1 to include fields the CRM no longer returns.

Responses

200

The module’s fields.

Media typeapplication/json

object

module

required

object

key

required

string

apiName

required

string

fields

required

Array<object>

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

object

key

additional properties

Example^generated

{
  "module": {
    "key": "example",
    "apiName": "example"
  },
  "fields": [
    {
      "additionalProperty": "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 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"
}