@jackdevau/up-api API Reference
    Preparing search index...

    Interface CategoryResource

    Represents a category resource in Up.

    interface CategoryResource {
        type: string;
        id: string;
        attributes: { name: string };
        relationships: {
            parent?: {
                data?: { type: string; id: string };
                links?: { related: string };
            };
            children?: {
                data: { type: string; id: string }[];
                links?: { related: string };
            };
        };
        links: { self: string };
    }
    Index

    Properties

    type id attributes relationships links

    Properties

    type: string

    The type of this resource: categories

    id: string

    The unique identifier for this category. This is a human-readable but URL-safe value.

    attributes: { name: string }

    Type Declaration

    • name: string

      The name of this category as seen in the Up application.

    relationships: {
        parent?: {
            data?: { type: string; id: string };
            links?: { related: string };
        };
        children?: {
            data: { type: string; id: string }[];
            links?: { related: string };
        };
    }
    links: { self: string }

    Settings

    Member Visibility

    On This Page

    Properties