Fetch custom column values for records

post/v1/custom-columns/values

Returns computed custom-column values for a batch of records (1-500) on a root, keyed by record id then field key.

Requires a bearer token: Authorization: Bearer <token>.

Request

cURL
curl -X POST https://api.wellapp.ai/v1/custom-columns/values \
  -H "Authorization: Bearer $WELL_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "data": {
    "type": "custom_column_values",
    "attributes": {
      "root": "companies",
      "record_ids": [
        "co_1",
        "co_2"
      ]
    }
  }
}'
Request body
{
  "data": {
    "type": "custom_column_values",
    "attributes": {
      "root": "companies",
      "record_ids": [
        "co_1",
        "co_2"
      ]
    }
  }
}

Responses

200 — Values keyed by record id.

{
  "data": {
    "type": "custom_column_values_batch",
    "attributes": {
      "values": {
        "co_1": {
          "risk_score": 82
        },
        "co_2": {
          "risk_score": 31
        }
      }
    }
  }
}

400 — Validation error.

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized.

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}