Companies
tier:standard

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

Request

  • Base URL: https://api.particle.pro
  • URL: https://api.particle.pro/v1/companies/{id}/products
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

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

Query parameters

statusstring[] nullable

Filter by lifecycle status (default: active), comma-separated for union. Case-insensitive.

[
  "active"
]

Response

OK

cursorstring

Pass to next request for more results

has_moreboolean required

Whether more results exist

Changes

No recorded changes to this operation across all 2 revisions of this API.