client.customFieldValuesOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/custom-field-values/{targetType}/{resourceId}/batch-readcustomFieldValues.getMany
The cell-local App re-authenticates the credential and additionally requires a target-domain scope selected by targetType: contacts:read/write, projects:read/write, project-statements:read/write, or tasks:read/write. Reading a contact, project, tag, or user reference field, and validating a newly set reference, also requires the matching contacts:read, projects:read, tags:read, or users:read scope. Invalid legacy values are classified without exposing their payload. Batch reads accept 1–100 unique field ids for one resource and preserve request order.
client.customFieldValues.getMany(targetType: CustomFieldValueTargetType, resourceId: string, fieldIds: string[], options?: RequestOptions)- Return form
Promise- Operation ID
getCustomFieldValues- Required scopes
custom-field-values:read- Conditional scopes
contacts:readprojects:readproject-statements:readtags:readtasks:readusers:read- SDK parameters
targetType: CustomFieldValueTargetTyperesourceId: stringfieldIds: string[]options: RequestOptions- Path request fields
targetType: stringresourceId: string- Request body
CustomFieldValueBatchReadapplication/json- Success
200 Array<CustomFieldValue> envelope
/custom-field-values/{targetType}/{resourceId}/{fieldId}customFieldValues.get
The cell-local App re-authenticates the credential and additionally requires a target-domain scope selected by targetType: contacts:read/write, projects:read/write, project-statements:read/write, or tasks:read/write. Reading a contact, project, tag, or user reference field, and validating a newly set reference, also requires the matching contacts:read, projects:read, tags:read, or users:read scope. Invalid legacy values are classified without exposing their payload.
client.customFieldValues.get(targetType: CustomFieldValueTargetType, resourceId: string, fieldId: string, options?: RequestOptions)- Return form
Promise- Operation ID
getCustomFieldValue- Required scopes
custom-field-values:read- Conditional scopes
contacts:readprojects:readproject-statements:readtags:readtasks:readusers:read- SDK parameters
targetType: CustomFieldValueTargetTyperesourceId: stringfieldId: stringoptions: RequestOptions- Path request fields
targetType: stringresourceId: stringfieldId: string- Success
200 CustomFieldValue envelope
/custom-field-values/{targetType}/{resourceId}/{fieldId}customFieldValues.set
The cell-local App re-authenticates the credential and additionally requires a target-domain scope selected by targetType: contacts:read/write, projects:read/write, project-statements:read/write, or tasks:read/write. Reading a contact, project, tag, or user reference field, and validating a newly set reference, also requires the matching contacts:read, projects:read, tags:read, or users:read scope. Invalid legacy values are classified without exposing their payload.
client.customFieldValues.set(targetType: CustomFieldValueTargetType, resourceId: string, fieldId: string, data: CustomFieldValueSet, options: CustomFieldValueMutationOptions)- Return form
Promise- Operation ID
setCustomFieldValue- Required scopes
custom-field-values:write- Conditional scopes
contacts:readcontacts:writeprojects:readprojects:writeproject-statements:writetags:readtasks:writeusers:read- SDK parameters
targetType: CustomFieldValueTargetTyperesourceId: stringfieldId: stringdata: CustomFieldValueSetoptions: CustomFieldValueMutationOptions- Path request fields
targetType: stringresourceId: stringfieldId: string- Header request fields
If-Match: string- Request body
CustomFieldValueSetapplication/json- Success
200 CustomFieldValueMutation envelope
/custom-field-values/{targetType}/{resourceId}/{fieldId}customFieldValues.clear
The cell-local App re-authenticates the credential and additionally requires a target-domain scope selected by targetType: contacts:read/write, projects:read/write, project-statements:read/write, or tasks:read/write. Reading a contact, project, tag, or user reference field, and validating a newly set reference, also requires the matching contacts:read, projects:read, tags:read, or users:read scope. Invalid legacy values are classified without exposing their payload.
client.customFieldValues.clear(targetType: CustomFieldValueTargetType, resourceId: string, fieldId: string, options: CustomFieldValueMutationOptions)- Return form
Promise- Operation ID
clearCustomFieldValue- Required scopes
custom-field-values:write- Conditional scopes
contacts:writeprojects:writeproject-statements:writetasks:write- SDK parameters
targetType: CustomFieldValueTargetTyperesourceId: stringfieldId: stringoptions: CustomFieldValueMutationOptions- Path request fields
targetType: stringresourceId: stringfieldId: string- Header request fields
If-Match: string- Success
200 CustomFieldValueMutation envelope
Errors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.