# Get Brands Gets data on the User's Organization's own Brands and their Contact Organization's Brands. Every **Email Address** in TonicDM belongs to a Brand, defined by the domain of the email address matching a domain assigned to the Brand). Brands are created automatically when an EmailAddress is added to TonicDM with a domain that is not already assigned to a Brand (contingent upon the special case of Shared Domains). Brands without domains can be manually created only in the User's own Organization, and these can be assigned only to Projects (not Persons). NOT YET IMPLEMENTED Endpoint: POST /core/brands/select Version: 0.0.5 Security: OAuth2 ## Request fields (application/json): - `searchQuery` (string) A JSON-encoded string containing the query options. - `filterIds` (array) Returns data for the specified UUIDs. If this filter is specifed, all other filters will be ignored. - `filterStatuses` (array) Provide the values in an array. If more than one value is given, they will be combined with OR. If no value is supplied, `active` is assumed. - `filterDisciplineIds` (array) provide the UUIDs of one or more disciplines separated by comma (no spaces). If more than one filter is given, they will be combined with AND. - `dataQuantity` (string) If caching data on the client side, the `dataQuantity=idOnly|basic|complete` option can be passed to manage the completeness of the data received and therefore rate limiting. Enum: "idOnly", "basic", "complete" - `pageSize` (integer) The number of results to return per page - `pageNumber` (integer) Which page of the results to return - `sortByOrganization` (string) The field by which to sort the results Enum: "nameLong", "nameShort", "nameInitials" - `sortDirection` (string) The sort direction for the results Enum: "asc", "desc" ## Response 200 fields (application/json): - `status` (string, required) Enum: "success" - `data` (array, required) - `data.id` (string) Example: 8e8aa42241794371ae9d0ed7b67a8c86 - `data.datetimeCreated` (string) The date and time this Brand was created. - `data.datetimeUpdated` (string) The date and time this Brand was last updated. - `data.status` (string) Whether the item is active or inactive in TonicDM. Potentially the item could be (soft) deleted. Enum: "active", "inactive", "deleted" - `data.domains` (array) Currently one and only one domain must be present. # Zero or more domains that belong to this organization and represent the Brand, eg. `firm.com`, `firm.co.us`. In the case of a shared domain contact, the "domain" of their Brand is their full email address, eg. `steven.novosel@gmail.com`. - `data.brandNameLegal` (string) The full official name of the Brand (used on transmittals). - `data.brandNameKnownAs` (string) The friendly name of the Brand (used within the TonicDM app). - `data.brandInitials` (string) The initials of the Brand (used in very small spaces) - `data.brandColor` (string) Brand color for the Brand. - `data.disciplines` (array) limits the disciplines that can be chosen for any person in this Brand to help consistency. - `data.certifications` (array) Zero or more certifications that this Brand has obtained, or previously obtained, for example Women Owned Business. REQUIRES the TonicDM AdvancedContacts license. REQUIRES the TonicDM AdvancedContacts license. - `data.isPrime` (boolean) Indicates that this Brand is the primary Brand for this organization. When displaying an organization, the Prime Brand info will be used for their Name, etc. REQUIRES the TonicDM AdvancedContacts license. - `data.customerDataWarehouseId` (string) The ID of the Person in the Customer's Data Warehouse. FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license. - `data.customerErpId` (string) The ID of the Person in the Customer's ERP system (eg. Deltek Vantagepoint). FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license. - `data.customerCrmId` (string) The ID of the Person in the Customer's CRM system (eg. Deltek Salesforce). FOR USE BY CUSTOMER. NOT YET IMPLEMENTED. REQUIRES the TonicDM AdvancedMetrics license. - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 400 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 401 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 403 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 404 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 429 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required) ## Response 500 fields (application/json): - `status` (string, required) Enum: "fail", "error" - `error` (object, required) - `error.code` (string, required) Example: VALIDATION_ERROR - `error.message` (string, required) Example: Invalid input - `metadata` (object, required) Present on every JSON response. For non-paginated operations, `page` will be 1, `total_pages` will be 1, and `total_records` equal to the number of elements in `data`. - `metadata.timestamp` (string, required) - `metadata.correlation_id` (string, required) - `metadata.page` (integer, required) - `metadata.total_pages` (integer, required) - `metadata.total_records` (integer, required)