Get the current client
GET/v2/me/client
Get information about the current client
Request
Header Parameters
User-Agent stringrequired
Custom User-Agent for your application, see user-agent.dev for implementation examples. Alternatively you can also use the 'MineSkin-User-Agent' header.
Example: ExampleApp/v1.0
Authorization string
API key from account.mineskin.org
Example: Bearer da84de82e960d6c0510088279878c79365ad5118d350d619f20324a5494f156b
Responses
- 200
- 403
- 404
Client Info
- application/json
- Schema
- Example (from schema)
Schema
client
object
required
Client information
agent string
Client User-Agent
Example:
PostmanRuntime
key string
ID of the API key used for this request
Example:
21702ac21ab744d32b004fe0
user string
User ID
Example:
ef4c52b01fea4715982d8e67fd93ef2d
ip string
Client IP address
Example:
12.34.56.789
billable boolean
Whether the client is billable (i.e. has a paid plan)
Example:
false
{
"client": {
"agent": "PostmanRuntime",
"key": "21702ac21ab744d32b004fe0",
"user": "ef4c52b01fea4715982d8e67fd93ef2d",
"ip": "12.34.56.789",
"billable": false
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
success booleanrequired
Example:
false
errors
object[]
code string
message string
warnings
object[]
code string
message string
messages
object[]
code string
message string
links
object
Links to related resources
self string
{
"success": false,
"errors": [
{
"code": "generic_error",
"message": "Something went wrong"
}
],
"warnings": [
{
"code": "string",
"message": "string"
}
],
"messages": [
{
"code": "string",
"message": "string"
}
],
"links": {
"self": "string"
}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
success booleanrequired
Example:
false
errors
object[]
code string
message string
warnings
object[]
code string
message string
messages
object[]
code string
message string
links
object
Links to related resources
self string
{
"success": false,
"errors": [
{
"code": "generic_error",
"message": "Something went wrong"
}
],
"warnings": [
{
"code": "string",
"message": "string"
}
],
"messages": [
{
"code": "string",
"message": "string"
}
],
"links": {
"self": "string"
}
}
Loading...