DB Sync: Get Character Links - Sonoran Software Documentation

This API endpoint requires the plus version of Sonoran CAD or higher. For more information, see our pricing page.

Get Character Links

POST https://api.sonorancad.com/civilian/get_character_links This endpoint allows you to get a user’s currently linked DB sync character IDs in the CAD.

Request Body

Name	Type	Description
id	string	Your community’s ID
key	string	Your community’s API Key
type	string	GET_CHARACTERS
data	array	Array of character objects

200 A successful call will be met with the following response:
400 The following 400 errors may be sent in response:
404

// Array of character sync IDs
[]

INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY

API ID NOT LINKED TO AN ACCOUNT IN THIS COMMUNITY

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "GET_CHARACTER_LINKS",
    "data": [
        {
            "apiId": "STEAM:1234" // API ID, Typically, this is their STEAM Hex
    ]
}

Sync ID

The syncId parameter is the unique identifier for your DB sync character. This will match the values found in the Character Mapping Column in your DB sync config.