Skip to main content
JavaScript
import ModerationAPI from '@moderation-api/sdk';

const client = new ModerationAPI({
  secretKey: process.env['MODAPI_SECRET_KEY'], // This is the default and can be omitted
});

const actions = await client.actions.list();

console.log(actions);
[
  {
    "id": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "builtIn": false,
    "queueBehaviour": "NO_CHANGE",
    "filterInQueueIds": [],
    "position": "ALL_QUEUES",
    "possibleValues": [],
    "valueRequired": false,
    "freeText": false,
    "key": "<string>",
    "description": "<string>",
    "type": "AUTHOR_BLOCK"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.moderationapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
queueId
string

Response

Successful response

​
id
string
required

The ID of the action.

​
createdAt
string
required

The date the action was created.

​
name
string
required

The name of the action.

​
builtIn
boolean | null
default:false
required

Whether the action is a built-in action or a custom one.

​
queueBehaviour
enum<string>
default:NO_CHANGE
required

Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status.

Available options:
REMOVE,
ADD,
NO_CHANGE
​
filterInQueueIds
string[]
required

The IDs of the queues the action is available in.

​
position
enum<string>
default:ALL_QUEUES
required

Show the action in all queues, selected queues or no queues (to use via API only).

Available options:
ALL_QUEUES,
SOME_QUEUES,
HIDDEN
​
possibleValues
object[]
required

The possible values of the action. The user will be prompted to select one of these values when executing the action.

​
valueRequired
boolean
default:false
required

Whether the action requires a value to be executed.

​
freeText
boolean
default:false
required

Whether the action allows any text to be entered as a value or if it must be one of the possible values.

​
key
string | null

User defined key of the action.

​
description
string | null

The description of the action.

​
type
enum<string> | null

The type of the action.

Available options:
AUTHOR_BLOCK,
AUTHOR_BLOCK_TEMP,
AUTHOR_UNBLOCK,
AUTHOR_DELETE,
AUTHOR_REPORT,
AUTHOR_WARN,
AUTHOR_CUSTOM,
ITEM_REJECT,
ITEM_ALLOW,
ITEM_CUSTOM