List products created by your organization within a specific company

GET 
/api/company/:company_id/product

List products created by your organization within a specific company

Request

Path Parameters

company_id uuidrequired

The id of the company

Query Parameters

query string

Query string for product name

page integer

Possible values: >= 1

Page number

per_page integer

Possible values: >= 1 and <= 100

Number of items per page

Responses

200

List of Products

application/json

Schema

Schema

items object[]required
An array of products.
Array [
id uuidrequired
The unique identifier of the product.
name stringrequired
The name of the product.
company_id uuidrequired
The unique identifier of the company.
description stringrequired
The description of the product. Can be null.
images object[]required
An array of image URLs associated with the product.
Array [
id uuidrequired
The unique identifier of the product image.
company_id uuidrequired
The unique identifier of the company.
url urlrequired
The URL of the product image.
]
]
total integerrequired

The total number of products.

Example (from schema)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "description": "string",
      "images": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "url": "string"
        }
      ]
    }
  ],
  "total": 0
}

404

Company not found

default

Unexpected error

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...