Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface SpecialtyResource

    One of the tenant's specialties, as GET /v1/specialties lists them.

    interface SpecialtyResource {
        slug: string;
        name: string;
        description?: string;
        active?: boolean;
        catchAll?: boolean;
    }
    Index
    slug: string

    Stable machine identifier, lowercase kebab — what goes on consults, physicians and the agent's triage. Never changes once in use; name is what gets renamed.

    name: string

    Display name.

    description?: string

    Patient-facing one-liner, if the clinic wrote one.

    active?: boolean

    Soft-deleted specialties are false: no longer offered to the agent or to new bookings, still named on old consults. Absent means active.

    catchAll?: boolean

    THE catch-all: a physician holding it may take every consult of the clinic, whatever it was triaged to — the general practitioner, and the reason a clinic can route by specialty without stranding a patient whose complaint fits no box.