GET /predefined_items/{predefined_item_id}

Get a specific predefined item

Returns one predefined item — a reusable product or service with its name, description, cost and price, used as a template for deal line items.

Path parameters

Name	Type	Description
`predefined_item_id` req	string	Predefined Item ID

Responses

200 OK

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object fields →
- predefined_itemobject
  A user-configured item which can aid in the creation of deal items
  object fields →
  idstringbson-id
  ID of the predefined item
  namestring
  Name of the predefined item
  descriptionstring
  Description text of the predefined item
  costnumberfloat
  Cost of the predefined item
  pricenumberfloat
  Price of the predefined item
  positionintegerint32
  Position of the predefined item in the items list
  item_group_idstringbson-id
  ID of the predefined item group (or empty if the item is not in a group)

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides

GET /predefined_items/{predefined_item_id}

curl "https://app.onepagecrm.com/api/v3/predefined_items/{predefined_item_id}" \
  -u $user_id:$api_key

200 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "predefined_item": {
      "id": "5c79510e9007ba3f7519e819",
      "name": "Solar panels",
      "description": "Photovoltaic solar panels (2019 model)",
      "cost": 95,
      "price": 149.99,
      "position": 1,
      "item_group_id": "5c9a53599007ba58f13c8119"
    }
  }
}