List connector fields

List the fields a connector exposes. inbound lists the fields Corma can read from the connector, outbound the fields Corma can write to it. The list holds the fields of the connector itself and the fields the workspace defined in it, the second of which Corma knows about from the last refresh.

GET

/v1/connectors/{id}/fields

GET

/connectors/{id}/fields

curl -X GET "https://api.corma.io/v1/connectors/{id}/fields?direction=inbound" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it, or the id of its connection. The kind.method form names the only connection of that integration; with several, it answers 409.
take
integer
query
Default:
50
skip
integer
query
Default:
0
direction
enum<string>
query
required
One of:
inbound
outbound

Response

application/json200

pagination
PaginationResponseMeta
required
items
ConnectorField[]
required
refreshedAt
string<date-time> | null
required
The timestamp of the last catalog refresh. ISO 8601 format. Null when Corma never read the catalog of this connector.

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

GET

/connectors/{id}/fields

curl -X GET "https://api.corma.io/v1/connectors/{id}/fields?direction=inbound" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

List connector fields - Corma Help Center | Productlane

API referenceConnectors

List connector fields

GET

/v1/connectors/{id}/fields

GET

/connectors/{id}/fields

curl -X GET "https://api.corma.io/v1/connectors/{id}/fields?direction=inbound" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required
The identifier of the connector, as GET /connectors returned it, or the id of its connection. The kind.method form names the only connection of that integration; with several, it answers 409.
take
integer
query
Default:
50
skip
integer
query
Default:
0
direction
enum<string>
query
required
One of:
inbound
outbound

Response

application/json200

pagination
PaginationResponseMeta
required
items
ConnectorField[]
required
refreshedAt
string<date-time> | null
required
The timestamp of the last catalog refresh. ISO 8601 format. Null when Corma never read the catalog of this connector.

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}

GET

/connectors/{id}/fields

curl -X GET "https://api.corma.io/v1/connectors/{id}/fields?direction=inbound" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "type": "string",
      "origin": "standard",
      "required": true,
      "note": "string"
    }
  ],
  "refreshedAt": "2026-01-15T09:30:00Z"
}