Repository navigation
docs(custom-fields): document the per-object filters on the custom field values API - #16378
Merged
Merged
Conversation
…eld values API List the query parameter for each object type that can hold a custom field value (asset, organization, finding, engagement, test, risk acceptance), with an example, and the entity_type filter on the definitions endpoint. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…he values API Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maffooch
enabled auto-merge
October 16, 2026 20:21
Contributor
Author
|
Docs review verdict: APPROVE I checked the changed text in docs/content/asset_modelling/PRO__custom_fields.md (head 9462559) against the Pro implementation of the custom field values and definitions endpoints. Checked and accurate:
Markdown and hygiene:
Nits (optional, none block merge):
|
blakeaowens
approved these changes
Oct 16, 2026
devGregA
approved these changes
Oct 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents how to list the custom field values on one object through
/api/v2/custom_fields/values/. The Pro custom fields page only gave?finding={id}as an example, so there was no documented way to get the values on an asset, organization, engagement, test or risk acceptance.The page now has a table of the query parameter for each object type that can hold a custom field value. It also notes that
?asset=and?organization=work alongside?product=and?product_type=, that filters combine, that a non-numeric id is a 400, and that the definitions endpoint filters byentity_type.This documents a Pro change that adds the
assetandorganizationaliases and the 400. Merge the two together.Docs only: no code changes.
🤖 Generated with Claude Code