Custom Fields

List custom fields

Retrieve all custom field definitions for the community, optionally filtered by entity type.

get/custom-fields

Request

Base URL
https://api.commonroom.io/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/custom-fields/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

entityTypestring

Filter fields by entity type. Valid values: contact, organization, or a prefixed object type ID (format cot_<number>).

Response

OK

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.