Kinderpedia icon

Kinderpedia

Interact with Kinderpedia API

Actions17

Custom Field → Get Values

AI-generated

Summary

Retrieves custom field (EAV) values for a specified entity type and optional entity ID from the Kinderpedia API.

Inputs

  • entityType (required) — The entity type to get custom field values for. Determines the EAV context suffix used in the API request (students → student_eavs, parents → parent_eavs, kg_admins → staff_member_eavs, teachers → teacher_eavs). Defaults to Students when no value is set via the UI but the parameter is mandatory in the node definition; workflow authors should explicitly select one of the four options to ensure correct context suffix mapping.
  • entityId — The ID of the entity (Student ID, Parent ID, etc.). Leave empty or set to 0 to retrieve custom field values for all entities of the selected type. If provided and non-zero, fetches values for that specific entity only.

Output shape

If entityId is a non-zero number: a single JSON response from GET /v1/{entityType}/{entityId}?includeContext[]={contextSuffix}, containing the custom field values for that entity. If entityId is 0 or omitted: a paginated collection of JSON objects, each representing an entity of the selected type along with its custom field values, fetched via repeated GET /v1/{entityType}?includeContext[]={contextSuffix}&page={n}&itemsPerPage={s} until all pages are consumed.

The API context suffix is derived from entityType: 'students' → 'student_eavs', 'parents' → 'parent_eavs', 'kg_admins' → 'staff_member_eavs', 'teachers' → 'teacher_eavs'. If entityType is 'students' (the fallback when none of the other three match), the suffix defaults to 'student_eavs'.

Examples

Example 1: Get custom field values for a specific student (ID 123).

entityType: Students; entityId: 123

Example 2: Get custom field values for all parents.

entityType: Parents; entityId: 0 (default)

Discussion