List company products

Returns the product hierarchy for a company as a nested tree. Segments contain product lines, which contain individual products. Identify the company by slug (e.g., ‘apple’), domain, or ID. Defaults to active products only.

GET /v1/companies/{id}/products

cURL

cURL

curl -H "X-API-Key: $PARTICLE_API_KEY" \
  "https://api.particle.pro/v1/companies/{id}/products"

200

{
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Authorizations

ApiKeyHeaderBearerAuth

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), comma-separated for union.

Example:

["active"]

Response

200

application/json

OK

data · object[] | null · required

List of results

Show child attributes

has_more · boolean · required

Whether more results exist

cursor · string

Pass to next request for more results