Skip to main content
GET
/
api
/
integration-sources
/
{source_id}
/
saas-objects
/
{object_id}
/
saas-fields
List Saas Fields
curl --request GET \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-objects/{object_id}/saas-fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "saas_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "field_name": "<string>",
    "api_identifier": "<string>",
    "data_type": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "is_required": true,
    "is_unique": true,
    "is_active": true,
    "semantic_type": "<string>",
    "semantic_type_confidence": 123,
    "sample_values": [
      "<unknown>"
    ],
    "enum_cardinality": 123,
    "null_pct": 123,
    "distinct_pct": 123,
    "last_analyzed": "2023-11-07T05:31:56Z",
    "approx_distinct_count": 123,
    "minhash_signature": [
      123
    ],
    "format_signature": {},
    "length_stats": {},
    "entropy": 123,
    "role": "<string>",
    "role_confidence": 123,
    "description_source": "ai_generated",
    "description_generated_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://heyhumm.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
source_id
string<uuid> | null
required
​
object_id
string<uuid>
required

Query Parameters

​
organization_id
string<uuid> | null
​
resource_id
string<uuid> | null
​
integration_source_id
string<uuid> | null
​
data_source_id
string<uuid> | null
​
context_source_id
string<uuid> | null
​
job_id
string<uuid> | null

Response

Successful Response

​
saas_object_id
string<uuid>
required

The SaaS object this field belongs to

​
field_name
string
required

Display name for the SaaS field (e.g., 'Email')

​
api_identifier
string
required

API identifier for the SaaS field (e.g., 'email')

​
data_type
string
required

The data type of the field (e.g., 'string', 'number')

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null

Optional description of the field

​
is_required
boolean | null

Whether this field is required

​
is_unique
boolean | null

Whether this field must be unique

​
is_active
boolean
default:true

Whether this field is enabled and visible to the analysis agent

​
semantic_type
string | null

Semantic type of the field (e.g., email, phone, date)

​
semantic_type_confidence
number | null

Confidence score for the detected semantic type

​
sample_values
any[] | null

Sample values from the field

​
enum_cardinality
integer | null

Number of distinct values (for enum-like fields)

​
null_pct
number | null

Percentage of null values in this field

​
distinct_pct
number | null

Percentage of distinct values in this field

​
last_analyzed
string<date-time> | null

When this field was last analyzed for metadata

​
approx_distinct_count
integer | null

Approximate number of distinct values (HyperLogLog)

​
minhash_signature
integer[] | null

MinHash signature for estimating Jaccard similarity

​
format_signature
Format Signature · object

Distribution of detected value formats / regex patterns

​
length_stats
Length Stats · object

Value length statistics (min, mean, p95)

​
entropy
number | null

Shannon entropy approximation for value distribution

​
role
string | null

Inferred field role (e.g., PRIMARY_KEY_CANDIDATE)

​
role_confidence
number | null

Confidence score for the inferred field role

​
description_source
enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:
ai_generated,
manual_edit,
imported,
information_schema
​
description_generated_at
string<date-time> | null

When description was last modified