Get custom fields

Retrieve the custom field definitions for a record type, including each field's type and choices. The field ids returned here are the keys used when filtering by custom fields. Valid record types are: people, businesses, events, smallgroups, group_members, group_types, forms, form_fields, connections, connection_types, locations, ministries, series, sermons, resource_rooms, resource_items, transaction_batch and safeguard_types. The required permission depends on the record type: people requires Limited Read People; smallgroups, group_members and group_types require Full Read Groups; connections and connection_types require Full Read Connections; businesses and transaction_batch require Limited Read Contributions; events requires Full Read Events; forms and form_fields require Full Read Forms; resource_rooms and resource_items require Full Read Facilities; safeguard_types requires Read Safeguards; the remaining record types require no specific permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The record type the fields belong to.

Query Params
boolean

When true (the default), only fields the caller may edit are returned; when false, every field the caller may view.

string

Return only fields in the given grouping (tab or section), e.g. group_12 for a group's member fields.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json