kustomer-client
    Preparing search index...

    Function getBrands

    • Get brands Retrieves a paginated list of all brands belonging to your organization.

      Any one of the following roles is required for this endpoint:

      Legacy Role Equivalent Permission Set Role
      org.admin.brand.read org.permission.brand.read
      org.user.brand.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      createdAt: string;
                      default: boolean;
                      modifiedAt?: string;
                      name: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy?: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      modifiedBy?: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              }[];
              links: {
                  first: string;
                  next: null
                  | string;
                  prev: null | string;
                  self: string;
              };
              meta: { page: number; pageSize: number };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility