Getting SOAR Playbooks via API - Options?

From the ApiWorkflowMenuCardDefinitionDataModel docs, it looks like the workflow menu card response already includes fields that may help with filtering, such as categoryId, categoryName, environments[], playbookType, isEnabled, and hasRestrictedEnvironments.

I do not see a documented server-side filter parameter for “containment vs enrichment” playbooks in that model. The practical option may be to retrieve the menu card definitions and filter client-side by categoryName/categoryId, playbookType, environment, or naming convention.

If your containment playbooks are consistently categorized, categoryId/categoryName would probably be cleaner than string matching on n

ame.

​@whathehack81 I did take a look at those fields - environments, playbookType, environment are not a meaningful differnetiator.

Naming convention is an option. What are categoryId/categoryName reflective of in the GUI when managing playbooks?

Good question. My read is that categoryId / categoryName map to the Playbooks folder/category used for organization in the Playbooks page, not to an execution semantic like containment vs enrichment.

In the GUI, when creating or managing playbooks, the docs describe selecting a folder/environment, renaming folders, creating new folders, and moving playbooks or blocks between folders. So I would treat categoryName as the folder/category label shown in the Playbooks management view.

That means it may still be useful if your team has a folder convention like “Containment” vs “Enrichment,” but I would not rely on it as a built-in Chronicle/SOAR classification unless your local GUI layout confirms that mapping.