Registration Data

You can access registration data of a guild and know which Discord user is linked to which Epic user.

POST

Get user links

https://yunite.xyz/api/v3/guild/{guildId}/registration/links

Request

Path Parameters

Name	Value type	Description
guildId	Guild ID Snowflake	The ID of the guild you want to access

Request Body

Schema

{
    "type": "object",
    "properties": {
        "type": {
            "type": "string",
            "value": "one of ['DISCORD', 'EPIC']"
        },
        "userIds": {
            "type": "array",
            "itemSchema": {
                "type": "string",
                "value": "DisordID / EpicID, depending on given type"
            }
        }
    }
}

Example

{
    "type": "DISCORD",
    "userIds": [
        "12345654321123432",
        "45678765456788432",
        "89098765678900234"
    ]
}

Response

Schema

{
    "type": "object",
    "properties": {
        "users": {
            "type": "array",
            "itemSchema": {
                "type": "object",
                "properties": {
                    "discord": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string",
                                "value": "Discord User ID"
                            },
                            "name": {
                                "type": "string",
                                "value": "Discord User Name"
                            },
                            "avatar": {
                                "type": "string",
                                "value": "Discord User Avatar URL"
                            }
                        }
                    },
                    "epic": {
                        "type": "object",
                        "properties": {
                            "epicID": {
                                "type": "string",
                                "value": "Hex Epic ID"
                            },
                            "epicName": {
                                "type": "string",
                                "value": "Epic Display Name"
                            }
                        }
                    },
                    "dateVerified": {
                        "type": "String",
                        "value": "ISO timestamp of verification datetime"
                    },
                    "chosenPlatform": {
                        "type": "String",
                        "value": "one of ['PC', 'PS4', 'XB1', 'SWITCH', 'MOBILE']. Note: PS4/XB1 may include next gen console players"
                    },
                    "chosenPeripheral": {
                        "type": "String",
                        "value": "one of ['KEYBOARD_MOUSE', 'CONTROLLER', 'TOUCH']"
                    }
                }
            }
        },
        "notLinked": {
            "type": "array",
            "itemSchema": {
                "type": "String",
                "value": "IDs that have been found but are not linked"
            }
        },
        "notFound": {
            "type": "array",
            "itemSchema": {
                "type": "String",
                "value": "IDs that have not been found. For Discord: User is not in the guild; For Epic: Epic ID not yet seen in Yunite"
            }
        }
    }
}

Example

{
    "users": [
        {
            "discord": {
                "id": "12345654321123432",
                "name": "FooBarUser#1234",
                "avatar": "https://cdn.discordapp.com/..."
            },
            "epic": {
                "epicID": "a1c2d3e4f5a1c2d3e4f5a1c2d3e4f5a1",
                "epicName": "FooBarEpicPlayer"
            },
            "dateVerified": "2020-12-15T16:58:05+0000",
            "chosenPlatform": "PC",
            "chosenPeripheral": "KEYBOARD_MOUSE"
        }
    ],
    "notLinked": [
        "45678765456788432"
    ],
    "notFound": [
        "89098765678900234"
    ]
}