v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Community interpretations

Get community interpretations by cl

Retrieve a paginated collection of community interpretations associated with the specified community classification (using its cl_code).

get/community-classifications/{cl_code}/community-interpretations

Path parameters

cl_codestring required

Query parameters

detail'minimal' | 'full'

Level of detail for the response:

  • minimal: Returns basic fields only
  • full: Returns more fields
with_nestedboolean

Whether to include nested fields in the response

limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching community interpretation(s), with fields based on parameters:

  • detail=minimal&with_nested=false: Basic fields only
  • detail=minimal&with_nested=true: Basic fields + nested array fields
  • detail=full&with_nested=false: Extended fields, no nested array fields
  • detail=full&with_nested=true: Extended fields + nested array fields
OR
OR
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "ci_code": "ci.1",
      "cl_code": "cl.1",
      "cc_code": "cc.1",
      "class_fit": "Reasonable or acceptable answer",
      "class_confidence": "High",
      "comm_authority_rf_code": "rf.1",
      "notes": "no confidence associated with this classification"
    }
  ]
}