Entity reference · v1

ds-components

DSC-NNNNNNtable ds_componentssoft delete

Design system components.

Endpoints

GET/api/v1/ds-componentsList ds-components

POST/api/v1/ds-componentsCreate ds-components

GET/api/v1/ds-components/{id}Read one

PATCH/api/v1/ds-components/{id}Update

DELETE/api/v1/ds-components/{id}Soft-delete (?hard=true to skip trash)

POST/api/v1/ds-components/{id}/restoreRestore from trash

Writable fields

* required on create. PATCH treats every field as optional.

Field	Type	Constraints
name*	string
category	string
description	text
status	string	`draft \| review \| stable \| deprecated`
figma_url	string
documentation_url	string
feature_ids	json
variants	json
props	json
sort_order	integer
is_draft	boolean
metadata	json

Listing & filtering

Pagination: ?limit=50&offset=0 · max limit 200
Default sort: ?sort=sort_order&order=asc
Sortable fields: created_at · updated_at · sort_order · name · id_number
Search (?q=): name, description
Filters: ?status= ?category= , repeat any filter to OR multiple values
Trash: hidden by default; pass ?include_deleted=true

Examples

curlbash

curl 'https://productos.ca/api/v1/ds-components?limit=10' \
  -H "Authorization: Bearer $TOKEN"

Try it out

Paste a token and hit a real endpoint. The request goes from your browser straight to /api/v1/ds-components. The token is held in this page only for the request and is never stored.

Try it out

API token

Issue tokens in Settings → API tokens. Token never leaves this page.

GET/api/v1/ds-components?limit=3