Products

Products represent items or services that can be associated with deals in your CRM pipeline. Each product has a name, optional code, price, and currency.

The Product Object

  • Name
    id
    Type
    uuid
    Description

    Unique identifier for the product.

  • Name
    workspace_id
    Type
    uuid
    Description

    The workspace this product belongs to.

  • Name
    user_id
    Type
    uuid
    Description

    ID of the user who created the product.

  • Name
    owner_id
    Type
    uuid
    Description

    ID of the product owner.

  • Name
    name
    Type
    string
    Description

    Product name (max 255 characters).

  • Name
    code
    Type
    string
    Description

    Optional product code or SKU (max 255 characters).

  • Name
    price
    Type
    number
    Description

    Product price as a decimal number.

  • Name
    currency_id
    Type
    uuid
    Description

    Currency ID for the product price.

  • Name
    price_formatted
    Type
    string
    Description

    Formatted price with currency symbol (e.g., $99.00, €89.00).

  • Name
    created_at
    Type
    datetime
    Description

    Timestamp when the product was created.

  • Name
    updated_at
    Type
    datetime
    Description

    Timestamp when the product was last updated.

  • Name
    deleted_at
    Type
    datetime
    Description

    Timestamp when the product was soft deleted (if applicable).

GET/app/products

List Products

Retrieve all products in your workspace.

Request

GET
/app/products
curl https://api.pipeback.com/app/products \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "data": [
    {
      "id": "9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "user_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
      "owner_id": null,
      "name": "Professional Plan",
      "code": "PLAN-PRO",
      "price": 99.00,
      "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d",
      "price_formatted": "$99.00",
      "created_at": "2025-01-15T10:00:00.000000Z",
      "updated_at": "2025-01-15T10:00:00.000000Z",
      "deleted_at": null
    },
    {
      "id": "9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1b",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "user_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
      "owner_id": null,
      "name": "Enterprise Plan",
      "code": "PLAN-ENT",
      "price": 299.00,
      "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d",
      "price_formatted": "$299.00",
      "created_at": "2025-01-15T10:05:00.000000Z",
      "updated_at": "2025-01-15T10:05:00.000000Z",
      "deleted_at": null
    }
  ]
}
POST/app/products

Create a Product

Create a new product in your workspace.

Required Attributes

  • Name
    name
    Type
    string
    Required
    *
    Description

    Product name (max 255 characters).

  • Name
    price
    Type
    number
    Required
    *
    Description

    Product price as a decimal number.

  • Name
    currency_id
    Type
    uuid
    Required
    *
    Description

    Currency ID for the product price. You can get available currencies from the /app/currencies endpoint.

Optional Attributes

  • Name
    code
    Type
    string
    Description

    Product code or SKU (max 255 characters).

Request

POST
/app/products
curl -X POST https://api.pipeback.com/app/products \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Starter Plan",
    "code": "PLAN-START",
    "price": 49.00,
    "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d"
  }'

Response

{
  "id": "9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1c",
  "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
  "user_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
  "owner_id": null,
  "name": "Starter Plan",
  "code": "PLAN-START",
  "price": 49.00,
  "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d",
  "price_formatted": "$49.00",
  "created_at": "2025-10-26T16:00:00.000000Z",
  "updated_at": "2025-10-26T16:00:00.000000Z",
  "deleted_at": null
}
GET/app/products/{id}

Retrieve a Product

Retrieve details about a specific product.

Request

GET
/app/products/{id}
curl https://api.pipeback.com/app/products/9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "id": "9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a",
  "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
  "user_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
  "owner_id": null,
  "name": "Professional Plan",
  "code": "PLAN-PRO",
  "price": 99.00,
  "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d",
  "price_formatted": "$99.00",
  "created_at": "2025-01-15T10:00:00.000000Z",
  "updated_at": "2025-01-15T10:00:00.000000Z",
  "deleted_at": null
}
PUT/app/products/{id}

Update a Product

Update an existing product's information.

Required Attributes

  • Name
    name
    Type
    string
    Required
    *
    Description

    Product name (max 255 characters).

  • Name
    price
    Type
    number
    Required
    *
    Description

    Product price as a decimal number.

  • Name
    currency_id
    Type
    uuid
    Required
    *
    Description

    Currency ID for the product price.

Optional Attributes

  • Name
    code
    Type
    string
    Description

    Product code or SKU (max 255 characters).

Request

PUT
/app/products/{id}
curl -X PUT https://api.pipeback.com/app/products/9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Professional Plan - Annual",
    "code": "PLAN-PRO-ANNUAL",
    "price": 999.00,
    "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d"
  }'

Response

{
  "id": "9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a",
  "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
  "user_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
  "owner_id": null,
  "name": "Professional Plan - Annual",
  "code": "PLAN-PRO-ANNUAL",
  "price": 999.00,
  "currency_id": "9d5f3d04-3c71-5e2b-9b4f-2c3d4e5f6g7d",
  "price_formatted": "$999.00",
  "created_at": "2025-01-15T10:00:00.000000Z",
  "updated_at": "2025-10-26T16:15:00.000000Z",
  "deleted_at": null
}
DELETE/app/products/{id}

Delete a Product

Delete a product from your workspace. This performs a soft delete, preserving the product data but marking it as deleted.

Soft deleted products can still be retrieved through the API if needed, but will not appear in standard product lists.

Request

DELETE
/app/products/{id}
curl -X DELETE https://api.pipeback.com/app/products/9d5f3d04-7g14-9i6f-3f8j-6g7h8i9j0k1a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
}

Price Formatting

Product prices are stored as decimal numbers and automatically formatted based on the associated currency:

  • USD: 99.00 → $99.00
  • EUR: 89.00 → €89.00
  • BRL: 450.00 → R$450.00
  • GBP: 79.99 → £79.99

The price_formatted field provides a human-readable version with the appropriate currency symbol and decimal places based on the currency settings.

Something wrong with this page?