Retrieve a guideline

GET/v1/guidelines/{id}Key scope read

Returns one guideline by id.

Needs a key with the read scope. Authentication

curl https://api.useinfrared.com/v1/guidelines/gl_1LEog5dec7KKCgP7InZcWk \
  -H "Authorization: Bearer $INFRARED_KEY"

const response = await fetch("https://api.useinfrared.com/v1/guidelines/gl_1LEog5dec7KKCgP7InZcWk", {
  headers: { Authorization: `Bearer ${process.env.INFRARED_KEY}` },
});

const data = await response.json();

import os
import requests

response = requests.get(
    "https://api.useinfrared.com/v1/guidelines/gl_1LEog5dec7KKCgP7InZcWk",
    headers={"Authorization": f"Bearer {os.environ['INFRARED_KEY']}"},
)

data = response.json()

200 OKResponse

{
  "object": "guideline",
  "id": "gl_1LEog5dec7KKCgP7InZcWk",
  "project_id": "prj_0TBAgHGtdMketrbltGFHuk",
  "slug": "no-replica-goods",
  "policy": "guideline/no-replica-goods",
  "title": "No replica goods",
  "instructions": "Listings must not offer replicas, counterfeits or unauthorised copies of branded goods. Flag wording such as replica, 1:1 copy or mirror quality.",
  "examples": {
    "compliant": [],
    "violating": []
  },
  "enabled": true,
  "position": 1,
  "created_at": "2026-10-08T09:29:23.856Z",
  "updated_at": "2026-10-08T09:29:23.856Z"
}

Path parameters

idstringRequired: Id of the guideline: gl_ plus 22 base62 characters.

Returns

The guideline.

200 OKA guideline object

Errors

404: not_found
The key's project has no guideline with this id, or the id is malformed.

Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors

Something missing or unclear on this page? Write to support@useinfrared.com.