Skip to main content
GET
/
v1
/
companies
/
{id}
/
products
List company products
curl --request GET \
  --url https://api.particle.pro/v1/companies/{id}/products \
  --header 'X-API-Key: <api-key>'
[
  {
    "company_id": "<string>",
    "id": "<string>",
    "level": "<string>",
    "name": "<string>",
    "status": "<string>",
    "children": "<array>",
    "description": "<string>",
    "product_url": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Path Parameters

​
id
string
required

Company slug (e.g., 'apple'), domain (e.g., 'apple.com'), or ID

Query Parameters

​
status
string[] | null

Filter by lifecycle status (default: active). Pass multiple for union.

Example:
["active"]

Response

object[] | null

OK

​
company_id
string
required

Parent company identifier (domain, slug, or encoded ID)

​
id
string
required

Unique identifier

​
level
string
required

Hierarchy position: segment, product_line, or product

​
name
string
required

Product name

​
status
string
required

Lifecycle status: active, announced, discontinued, or rumored

​
children
array | null

Child products in the hierarchy

​
description
string

Product description

​
product_url
string

Canonical product page URL

​
updated_at
string<date-time>

Last updated timestamp