List user fields

List each mappable field and where it takes its value from. The list holds the fields Corma defines and the ones the workspace added.

GET

/v1/user-fields

GET

/user-fields

curl -X GET "https://api.corma.io/v1/user-fields" \
  -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

take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

OK

pagination
PaginationResponseMeta
required
items
UserField[]
required

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "type": "string",
      "origin": "standard",
      "inboundMappable": true,
      "defaultSources": [
        "string"
      ],
      "mapping": {
        "mode": "default"
      }
    }
  ]
}

GET

/user-fields

curl -X GET "https://api.corma.io/v1/user-fields" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "type": "string",
      "origin": "standard",
      "inboundMappable": true,
      "defaultSources": [
        "string"
      ],
      "mapping": {
        "mode": "default"
      }
    }
  ]
}

- GETList user fields
- PUTSet user field mapping

API referenceUser fields

List user fields

List each mappable field and where it takes its value from. The list holds the fields Corma defines and the ones the workspace added.

GET

/v1/user-fields

GET

/user-fields

curl -X GET "https://api.corma.io/v1/user-fields" \
  -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

take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

OK

pagination
PaginationResponseMeta
required
items
UserField[]
required

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "type": "string",
      "origin": "standard",
      "inboundMappable": true,
      "defaultSources": [
        "string"
      ],
      "mapping": {
        "mode": "default"
      }
    }
  ]
}

GET

/user-fields

curl -X GET "https://api.corma.io/v1/user-fields" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "id": "string",
      "label": "string",
      "description": "string",
      "type": "string",
      "origin": "standard",
      "inboundMappable": true,
      "defaultSources": [
        "string"
      ],
      "mapping": {
        "mode": "default"
      }
    }
  ]
}