Skip to content

List guidelines

GET/v1/guidelinesKey scope read

Lists the project's guidelines in their order (position), enabled and disabled alike. The list is not paginated.

Needs a key with the read scope. Authentication

curl https://api.useinfrared.com/v1/guidelines \
  -H "Authorization: Bearer $INFRARED_KEY"
200 OKResponse
{
  "object": "list",
  "data": [
    {
      "object": "guideline",
      "id": "gl_4R8CeEbylEzY7fCtrNNQPR",
      "project_id": "prj_0TBAgHGtdMketrbltGFHuk",
      "slug": "no-off-site-deals",
      "policy": "guideline/no-off-site-deals",
      "title": "No off-site deals",
      "instructions": "Sellers must not ask buyers to pay or to arrange the deal outside the platform: bank transfers, payment links, crypto, or a move to email, phone or a messaging app. Flag any attempt.",
      "examples": {
        "compliant": [
          "Collection in person or tracked delivery, payment through the site."
        ],
        "violating": [
          "Pay me by bank transfer and I will knock 10% off.",
          "Message me on my number, it is easier than the chat here."
        ]
      },
      "enabled": true,
      "position": 0,
      "created_at": "2026-10-08T08:44:27.742Z",
      "updated_at": "2026-10-08T08:44:27.742Z"
    },
    {
      "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"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Returns

A list object that holds every guideline. has_more is always false.

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.