List a Subreddit's Post Flair Templates

A subreddit's post (link) flair templates: the flairs a post in that community can carry. Pass a template's id as flair_id to POST /api/reddit/submit, and, when the template is editable, your own flair_text with it. Many subreddits remove a post that has no flair, so read this before posting there.

Who reads it

Reddit serves this list only to signed-in accounts, so the call always reads it as a session, never anonymously. It uses the first of these that applies:

1. your session headers, x-reddit-session and x-reddit-loid, when you send them (Authenticated reads);
2. otherwise your stored Reddit session, if one is connected.

With neither, the call answers 503 with code: "SESSION_REQUIRED" before Reddit is asked, and is not charged. Connecting a stored session once is the simplest way to make sure it always answers.

When the list is read as a session (yours or your stored one), a moderator of the subreddit gets every template, mod-only ones included. Any other account gets the templates Reddit offers it on its own submit page, which is exactly the set it can post with; those are listed with mod_only: false, and fields Reddit does not send for them (max_emojis, allowable_content, and sometimes the colours) are null.

Path Parameters

Optional Headers

Example

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.redditapis.com/api/reddit/sub/SaaS/flairs"

const response = await fetch(
  "https://api.redditapis.com/api/reddit/sub/SaaS/flairs",
  { headers: { Authorization: "Bearer TOKEN" } }
);
const { flairs } = await response.json();
// Post with the first template that is not mod-only:
const flair = flairs.find((f) => !f.mod_only);

import requests

response = requests.get(
    "https://api.redditapis.com/api/reddit/sub/SaaS/flairs",
    headers={"Authorization": "Bearer TOKEN"},
)
flairs = response.json()["flairs"]

Response Shape

{
  "subreddit": "SaaS",
  "flairs": [
    {
      "id": "a1b2c3d4-0000-11ee-8000-000000000001",
      "text": "Question",
      "editable": false,
      "type": "text",
      "background_color": "#0079d3",
      "text_color": "light",
      "css_class": "q",
      "mod_only": false,
      "max_emojis": 10,
      "allowable_content": "all",
      "richtext": []
    }
  ],
  "count": 1
}

Response Fields

A subreddit with no post flairs returns flairs: [], which is billed like any answer. A template Reddit sends without an id is left out, because it cannot be posted with.

Errors