Get Brands

Retrieves a list of all available brands for your organization

GET /organizations/brands

Try it

cURL

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/organizations/brands \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "brands": [
    {
      "id": 0,
      "name": "Name"
    }
  ]
}

Retrieves a list of all available brands for your organization. This endpoint returns basic brand information including brand IDs and names that can be used for filtering and organization purposes.

Request Parameters

This endpoint does not require any specific parameters, but standard authentication is required.

Parameter	Type	Description	Required
None	-	This endpoint does not accept additional parameters	-

Request Example

curl -X GET "https://api.growi.io/api/public/v1/organizations/brands" \
     -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" \
     -H "Content-Type: application/json"

Response Example

{
  "success": true,
  "brands": [
    {
      "id": 0,
      "name": "Name"
    },
    {
      "id": 1,
      "name": "Name 2"
    }
  ]
}

Response Fields

Field	Type	Description
success	Boolean	Indicates whether the request was successful
brands	Array	Array of brand objects
brands[].id	Integer	Unique identifier for the brand
brands[].name	String	Display name of the brand

Use Cases

• Brand Filtering: Use brand IDs to filter data in other API endpoints
• Brand Management: Retrieve available brands for management interfaces
• Organization Setup: Get brand information for initial application setup
• Reporting: Include brand names in reports and analytics dashboards

Error Responses

{
  "error": "Not Authenticated"
}

Common error scenarios:

• 401 Unauthorized: Invalid or missing Bearer token
• 403 Forbidden: API key doesn’t have permission to access brands
• 500 Internal Server Error: Server-side error occurred

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Get your brands information

success · boolean

Example:

true

brands · object[]

Show child attributes

brands. id · integer

Unique identifier for the brand

Example:

0

brands. name · string

Display name of the brand

Example:

"Name"