Entity reference · v1

competitors

CMP-NNNNNNtable competitorssoft delete

Competitors with strengths, weaknesses, differentiators.

Endpoints

GET/api/v1/competitorsList competitors

POST/api/v1/competitorsCreate competitors

GET/api/v1/competitors/{id}Read one

PATCH/api/v1/competitors/{id}Update

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

POST/api/v1/competitors/{id}/restoreRestore from trash

Writable fields

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

Field	Type	Constraints
name*	string
website	string
description	text
strengths	json
weaknesses	json
differentiators	json
notes	text
status	string	`active \| emerging \| declining \| archived`
is_draft	boolean
metadata	json

Listing & filtering

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

Examples

curlbash

curl 'https://productos.ca/api/v1/competitors?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/competitors. 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/competitors?limit=3