v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
ResourceDescriptors

List resource descriptor fields

Lists fields declared for a resource descriptor. Fields carry path/column names, value type hints, required/multi-valued semantics, semantic attribute references, sensitivity, and optional retention metadata.

get/resource/descriptors/{resourceDescriptorId}/fields

Path parameters

resourceDescriptorIdstring uuid required

Stable identifier for a described external or internal resource shape.

Example:41436f49-040c-4f5f-9c7f-657f43762e2b

Stable identifier of the resource descriptor that describes the shape, representation, and semantic meaning of a connector resource.

Query parameters

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged field descriptors.

Example response

{
  "data": [
    {
      "fieldDescriptorId": "f00b9edc-5498-483f-9b91-a42ef080b909",
      "fieldPath": "email",
      "displayName": "Work email",
      "valueType": "string",
      "required": true
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}