Skip to Content

list_products

Lists this organization’s products (WordPress plugins and themes): id, slug, name, type, free or pro, current version, active or archived. Use the id or slug with the other tools. With analytics:read each product also has its active installation count. Paginated: pass next_cursor back as cursor.

  • Server: Organization server
  • Scope: products:read
  • Read-only: yes

Input

{ "properties": { "search": { "description": "Part of a product name or slug.", "type": "string" }, "status": { "description": "Only active or only archived products.", "enum": [ "active", "archived" ], "type": "string" }, "cursor": { "description": "next_cursor from the previous page.", "type": "string" }, "limit": { "description": "Page size, default 25, max 100.", "minimum": 1, "maximum": 100, "type": "integer" } }, "type": "object" }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" }, "products": { "items": { "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "product_type": { "type": "string" }, "pricing_type": { "type": "string" }, "current_version": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "created_at": { "type": "string" }, "active_installations_count": { "type": [ "integer", "null" ] } }, "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object", "required": [ "as_of", "products", "next_cursor" ] }