• Features
  • Pricing
Get Started

OverviewList ItemsCreate ItemGet ItemUpdate ItemTrash ItemRestore ItemDelete Permanently

Items

GET /v1/items

List items with pagination, free-text search, and an optional trash-only filter.

GET /v1/items returns a paginated list of items.

Authentication

Send an organization API key in x-api-key or Authorization: Bearer <key>.

Query Parameters

NameTypeDefaultDescription
pageinteger1Page number to return.
limitinteger20Number of results per page. Maximum: 100.
qstring""Free-text search term.
deletedOnlybooleanfalseWhen true, only trashed items are returned.

Example

curl "https://api.blueputto.com/v1/items?page=1&limit=20&q=chair&deletedOnly=false" \
  -H "x-api-key: YOUR_API_KEY"

Success Response

200 OK

{
  "data": [{}],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 429 Too Many Requests

Items

Reference for listing, creating, updating, trashing, restoring, and permanently deleting items.

POST /v1/items

Create a new item by sending a JSON request body.

On this page

AuthenticationQuery ParametersExampleSuccess ResponseError Responses