v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
organizations

List organizations

Lists all Organizations for a User. Unauthorized requests will return an empty list.

You can use the returned slug attribute to form a link to the desired Organization like so:

https://brandfolder.com/organizations/{slug}
get/organizations

Query parameters

fields'asset_count'

Set it to asset_count to return each organization's asset count as part of each organization's attributes in the response.

WARNING: This parameter can slow response times.

includestring

Set it to a comma-separated list (no spaces) of any of the following record names to return those records related to the organizations you're fetching. Related records are returned in an included array in the response.

Allowed values:

  • brandfolders
  • brandguides
  • collections
  • portals

WARNING: This parameter can slow response times.

Response

All the user's organizations.

Example response

{
  "data": [
    {
      "id": "oqgkkd-fr5iv4-cocc75",
      "attributes": {
        "name": "Brandfolder's Organization",
        "tagline": "An example tagline for the Organization",
        "slug": "brandfolder-organization"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}