get_content_group

Read a content group (collection) by id.

get_content_group

Read a content group (collection) by id.

Safety class: C · API type: portal · Min version:

📘

Confinement

Class C: read-only; reference only content groups you created. Non-prod only.

Signatures

def get_content_group(sdk, content_group_id):
    """Read a content group by id; return the group dict or None."""
    return sdk.get_content_group(content_group_id)
export async function getContentGroup(sdk, contentGroupId) {
    // Read a content group by id.
    return await sdk.getContentGroup(contentGroupId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
content_group_idcontentGroupIdstryese.g. <content-group-uuid>

Returns

dict | None — the content group (id, name, contents[], sharedUsers[], shares[], isShared); None if not found.

Errors

  • 401 unauthenticated
  • 404 not found
  • InvalidAPITypeException (admin session)

See also: Python ↔ JS naming map · Return shapes.