Omniplex Docs

Staff

Staff-only Omniplex endpoints. Only usable from staff panel using panelapi credentials

Get Staff Permissions

GET
/staff/meta/permissions

Lists every permission that can be attached to a staff role, grouped by category.

Response Body

Success

application/json
  1. response
perms?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/meta/permissions'
Example Response
{  "perms": [    {      "category": "string",      "dangerous": true,      "desc": "string",      "id": "string",      "name": "string"    }  ]}
GET
/staff/apps

Gets all applications returning a list of apps.

Query Parameters

user_id?string

The ID of the user to get the applications for. If not specified, all applications will be returned.

Response Body

Success

application/json
  1. response
apps?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/apps'
Example Response
{  "apps": [    {      "answers": {        "property1": "string",        "property2": "string"      },      "app_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "in_main_server": true,      "position": "string",      "questions": [        {          "flag": [            "string"          ],          "id": "string",          "max_length": 0,          "min_length": 0,          "optional": true,          "options": [            "string"          ],          "paragraph": "string",          "placeholder": "string",          "question": "string",          "short": true,          "show_if": {            "question_id": "string",            "values": [              "string"            ]          },          "type": "string"        }      ],      "review_feedback": "string",      "state": "string",      "user": {        "avatar": "string",        "bot": true,        "display_name": "string",        "extra_data": {          "property1": null,          "property2": null        },        "flags": [          "string"        ],        "id": "string",        "status": "string",        "username": "string"      },      "user_id": "string"    }  ]}

Staff: Get Activity Log

GET
/staff/audit-events

Lists activity log events, newest first. Needs view_audit_logs.

Query Parameters

before?string

Only events with a smaller ID, from next_before

source?string

api, panel, system, stripe or paypal

actor_id?string

Only events by this user, bot, server or team

target_id?string

Only events on this target

action?string

Only actions starting with this text, such as payment. or panel.UpdatePromoCodes

failed?boolean

true for only events with a status of 400 or more

limit?string

Events per page, 1 to 200. Default 50

Response Body

Success

application/json
  1. response
events?array<>

Newest first

next_before?string

Pass as before to get the next page. Null on the last page

Example Request
curl -X GET 'https://spider.omniplex.gg/staff/audit-events'
Example Response
{  "events": [    {      "action": "string",      "actor_avatar": "string",      "actor_id": "string",      "actor_name": "string",      "actor_type": "string",      "created_at": "2019-08-24T14:15:22Z",      "data": {        "property1": null,        "property2": null      },      "id": 0,      "ip": "string",      "source": "string",      "status": 0,      "target_id": "string",      "target_name": "string",      "target_type": "string"    }  ],  "next_before": "string"}
GET
/staff/auto-vote

Lists every Auto-vote subscription and saved listing with its status. Needs view_payments.

Response Body

Success

application/json
  1. response
entries?array<>

Every user with a subscription or saved Auto-vote listings, newest subscription first

Example Request
curl -X GET 'https://spider.omniplex.gg/staff/auto-vote'
Example Response
{  "entries": [    {      "active": true,      "auto_votes_30d": 0,      "billing_interval": "string",      "cancel_at_period_end": true,      "current_period_end": "2019-08-24T14:15:22Z",      "extra_slots": 0,      "status": "string",      "stripe_customer_id": "string",      "stripe_subscription_id": "string",      "subscribed_at": "2019-08-24T14:15:22Z",      "targets": [        {          "avatar": "string",          "cooldown_until": "2019-08-24T14:15:22Z",          "days": [            0          ],          "end_minute": 0,          "in_schedule": true,          "last_skip_reason": "string",          "last_voted_at": "2019-08-24T14:15:22Z",          "name": "string",          "paused": true,          "start_minute": 0,          "target_id": "string",          "target_type": "string",          "timezone": "string",          "votes_24h": 0,          "votes_7d": 0        }      ],      "user_id": "string"    }  ]}
GET
/staff/payments

Lists recent premium purchases. Needs view_payments.

Query Parameters

user_id?string

Only purchases by this user, or for this bot or server

revoked?boolean

true for only refunded or disputed purchases

limit?string

1 to 200. Default 100

Response Body

Success

application/json
  1. response
payments?array<>

Newest first

Example Request
curl -X GET 'https://spider.omniplex.gg/staff/payments'
Example Response
{  "payments": [    {      "credit_discount_cents": 0,      "credit_state": "string",      "credits_used": 0,      "external_id": "string",      "for_id": "string",      "for_type": "string",      "fulfilled_at": "2019-08-24T14:15:22Z",      "premium_hours": 0,      "product_id": "string",      "promo_code": "string",      "provider": "string",      "revoke_reason": "string",      "revoked_at": "2019-08-24T14:15:22Z",      "user_id": "string"    }  ]}
GET
/staff/shop-purchases

Gets the most recent shop purchases across every entity.

Response Body

Success

application/json
  1. response
items?array<>
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/shop-purchases'
Example Response
{  "items": [    {      "cents": 0.1,      "created_at": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "item_id": "string",      "target_id": "string",      "target_type": "string"    }  ]}
PATCH
/staff/apps/{app_id}

Approves or denies an application. On success, staff_note describes anything staff need to follow up on by hand, such as a Discord role that couldn't be given.

Path Parameters

app_id*string

The App ID

Request Body

application/json
  1. body
approved?boolean
reason?string

Response Body

Success

application/json
  1. response
staff_note?string

Something staff need to follow up on by hand, such as a Discord role that couldn't be given

Example Request
curl -X PATCH 'https://spider.omniplex.gg/staff/apps/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "staff_note": "string"}

Get Public Team

GET
/staff/team

Returns the public staff roster: who's on staff and what position(s) they hold.

Response Body

Success

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://spider.omniplex.gg/staff/team'
Example Response
[  {    "avatar": "string",    "display_name": "string",    "positions": [      {        "icon": "string",        "index": 0,        "name": "string"      }    ],    "user_id": "string",    "username": "string"  }]