NextSDS Docs

List the custom-field groups your team defines

The groups of custom fields your team has defined, with the JSON Schema each one validates against, this is what tells you which fields are writable and under which group id.

GET
/custom-field-schemas

The groups of custom fields your team has defined, with the JSON Schema each one validates against -- this is what tells you which fields are writable and under which group id. Only active groups are listed; values written against a group that was since deactivated are still returned by the product's custom-fields endpoint.

Authorization

bearerAuth
AuthorizationBearer <token>

A machine API key from Settings > API keys, in the form nsds_live_.... Shown once at creation and never retrievable afterwards.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/custom-field-schemas"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "version": 0,      "json_schema": {        "property1": null,        "property2": null      },      "updated_at": "string"    }  ]}