| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

Call this API to retrieve details for all the Brands you are partnered with via Button. The fields returned are as follows:

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Button Organization ID for the Brand; this value will never change for a given Brand |
| `name` | string | Brand's name |
| `is_live_ready` | bool | The partnership has been fully configured by Button and is eligible to receive traffic from end users |
| `description` | string | Brand's description |
| `urls.homepage` | string | Brand's Homepage URL |
| `icon_url` | string | Brand's icon URL |
| `apps` | array | An array of all apps supported by the Brand with `os` and `scheme` keys. |
| `supported_hostnames` | array | An array of all hostnames associated with the Brand that are optimized by Button. |
| `subdomain` | string | The `.bttn.io` subdomain that the Brand uses for links, or `null` if not used. |
| `terms_and_conditions.reporting_window_days` | int | Brand's order reporting delay, in days |
| `terms_and_conditions.finalization_window_minutes` | int | Brand's expected order adjustment period, in minutes. |
| `terms_and_conditions.coupons_allowed` | bool | Whether the Brand will commission if a coupon is present on the order |
| `terms_and_conditions.gift_cards_allowed` | bool | Whether the Brand will commission on the purchase of gift cards |
| `terms_and_conditions.exclusion_details` | string | Brand's list of items exclusions (i.e. will not generate a commission) |
| `terms_and_conditions.other_terms` | string | Other program terms |

### FAQs  
Q: When should Publishers use this API? Ad-hoc? As part of their Brand onboarding flow?

A: Either/or - this API is meant to deliver static Brand details, and thus can be called ad-hoc when a Publisher needs to retrieve static Brand details (e.g. when onboarding a Brand).

Q: Can Publishers use this API as part of their flow of routing a user to a Brand?

A: No - this API _should not_ be in the critical path of routing a user to a Brand. In other words, the purpose of this API is for Publishers to fetch Brand metadata that does not change frequently, and should not require calling it in real-time.

# ``200      200

# ``400      400

# ``401      401

# ``404      404

Updated about 1 year ago

* * *

Shell:

```
xxxxxxxxxx

# without optional arguments

curl https://api.usebutton.com/v1/brands \

-X GET \

-u YOUR_API_KEY:

# with optional arguments

curl https://api.usebutton.com/v1/brands/org-xxx \

-X GET \

-u YOUR_API_KEY:
```

Click `Try It!` to start a request and see the response here! Or choose an example:

application/json

``200 - Result``
``400 - Result``
``401 - Result``
``404 - Result

Updated about 1 year ago

* * *