The Husqy premium subscription is now live! Please head over to our Discord store page to get started!
We are verified! Husqy is a verified bot in Discord making us visible in the app discovery and enabling bigger trust to users!
Want to help us translate the Husqy responses? We can't do it without you! Please visit our translations repo!
Skip to main content
API docs by Redocly

Husqy.general (2.0.0)

Download OpenAPI specification:Download

Authentication

Operations for authentication and API keys

Authorize An Access Token

Endpoint to validate an access token or api key.

Request Body schema: application/json
required
access_token
required
string (Access Token)

Responses

Request samples

Content type
application/json
{
  • "access_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Validate A User Has Access To The Server

Endpoint to validate if a user is allowed to interact with Husqy in a guild.

Request Body schema: application/json
required
required
Guild Id (string) or Guild Id (integer) (Guild Id)
target
required
string (Target)

Responses

Request samples

Content type
application/json
{
  • "guild_id": "string",
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get All Api Keys In A Server

Endpoint to get api keys for a server.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create A New Api Key In The Server

Endpoint to create a new api key for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete An Api Key From A Server

Endpoint to get api keys for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
api_key
required
string (Api Key)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "api_key": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Helpers

Operations for utilities used by Husqy

Get The Current Supported Languages

Get the languages Husqy supports.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Current Supported Timezones

Get the timezones Husqy supports.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Current Supported Unit Systems

Get the unit systems Husqy supports.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Servers Where The User Is In

Get the servers where Husqy is in for the authenticated user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Roles In A Server

Get the roles in a server.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Users In A Server

Get the users in a server.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Channels In A Server

Get the channels in a server.

query Parameters
guild_id
required
integer (Guild Id)
Array of Types (strings) or Types (null) (Types)
Default: ""

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Custom Emojis In A Server

Get the roles in a server.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Replace Husqy Variables In A Text

Replace variables inside content.

query Parameters
content
required
string (Content)
language
required
string (Language)
timezone
required
string (Timezone)
Guild Id (string) or Guild Id (null) (Guild Id)
User Id (string) or User Id (null) (User Id)
Channel Id (string) or Channel Id (null) (Channel Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Settings

Operations for Husqy general settings

Get The General Setting Of Husqy In A Server

Get the settings for Husqy for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Edit The General Husqy Settings Of A Server

Change the settings for Husqy for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Language (string) or Language (null) (Language)
Gmt (string) or Gmt (null) (Gmt)
Unit System (string) or Unit System (null) (Unit System)
Auto Delete (integer) or Auto Delete (null) (Auto Delete)
Max Warns (integer) or Max Warns (null) (Max Warns)
Auto Kick Enabled (boolean) or Auto Kick Enabled (null) (Auto Kick Enabled)
Auto Kick Role Id (integer) or Auto Kick Role Id (null) (Auto Kick Role Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "language": "string",
  • "gmt": "string",
  • "unit_system": "string",
  • "auto_delete": 0,
  • "max_warns": 0,
  • "auto_kick_enabled": true,
  • "auto_kick_role_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Privacy

Operations for a users Privacy data

Get The Privacy Data Of A User For The Husqy.General Microservice

Get user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Privacy Data Of A User For The Husqy.General Microservice

Delete user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Home Endpoint For The Husqy.General Microservice

Home endpoint for the Husqy.general microservice.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}