List Care Items by Care Type

GET 
/v1/cares/care-types/:careTypeId/items

Retrieve a list of care items belonging to the specified care type. Supports keyword search, filtering, exclusion, and more.

Request

Path Parameters

careTypeId integerrequired

The unique ID of the care type.

Query Parameters

search string

Keyword to filter care item names.

exclude_names string[]

List of care item names to exclude. Comma-separated values.

v string

Filter care items by cve_version.

parents_only boolean

Include only items with children.

only_children_of integer

Include only children of a particular care item.

used_in_band_ids string

Filter care items by associated tariff band IDs. Comma-separated values.

Responses

200

Array of care items for the specified care type

application/json

Schema

Schema

• Array [
id integer
name string
type_id integer
updated_at date-time
• ]

Example (from schema)

[
  {
    "id": 8194,
    "name": "001:Pen V tabs",
    "type_id": 1,
    "updated_at": "2021-07-15T20:47:48.000000Z"
  }
]

404

Care type not found

Loading...