Skip to content
Explore Class APIs/Audit Partner/Business

Brand list

Request

List all Brands in the specified Business

Security
Class_oAuth(Required scopes: business.fund.list)
Path
businessCodestringrequired

The unique identifier code for the Class business.

Example:demo-business
curl -i -X GET \
  https://api.class-pie.com.au/api/1.0/b/demo-business/business-data/brand-list \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success (Ok)

Bodyapplication/json
ErrorCodesArray of stringsrequired

A collection of error code strings returned by the API operation.

ErrorsArray of objectsrequired

A collection of detailed error response objects.

CreatedUristringrequired

The URI pointing to the newly created resource, if applicable.

IsCreatedResponsebooleanrequired

Indicates whether the API call successfully created a new resource.

Dataobjectrequired

The primary data payload containing brand information.

Response
{
  "Data": {
    "BrandSummaries": [
      {
        "Code": "sample-brand-1",
        "Name": "Sample Brand Alpha",
        "CanWrite": true
      },
      {
        "Code": "sample-brand-2",
        "Name": "Sample Brand Beta",
        "CanWrite": false
      }
    ]
  },
  "Errors": []
}