Get Characters

Retrieve characters for a community user, linked Roblox user, linked Discord user, or account.

GET https://api.sonorancad.com/v2/civilian/characters

Rate limit: 10 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Retrieve characters for a Sonoran CAD account using communityUserId by default, or roblox, discord, or accountUuid as alternatives.

Query Parameters

Name

Type

Default

Description

communityUserId

string

Optional

Default target option for the in-game community user ID. Provide exactly one identifier.

roblox

integer

Optional

Target the account linked to a Roblox user ID. Provide exactly one identifier.

discord

string

Optional

Target the account linked to a Discord user ID. Provide exactly one identifier.

accountUuid

string (uuid)

Optional

Target account UUID. Provide exactly one identifier.

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:getCharactersV2({
    accountUuid = '00000000-0000-0000-0000-000000000000',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to call getCharactersV2 directly.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local response = exports["sonorancad"]:getCharactersV2({
    accountUuid = '00000000-0000-0000-0000-000000000000',
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Sonoran.js

const response = exports["sonorancad"].getCharactersV2({
  accountUuid: "00000000-0000-0000-0000-000000000000",
});

console.log(response.success);

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = communityId,
    apiKey = apiKey,
    defaultServerId = serverId
});

After getting the C# client:

var response = await sonoran.Cad.getCharactersV2(new GetCharactersV2Query
{
    CommunityUserId = "player-1234"
});

Console.WriteLine(response.success);

For other Sonoran.lua CAD v2 helpers that do not have a direct resource export, get the ready CAD client first:

local cad = exports["sonorancad"]:getCadClient()

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.getCharactersV2({
    accountUuid: '00000000-0000-0000-0000-000000000000',
  });
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.getCharactersV2({
    "accountUuid": '00000000-0000-0000-0000-000000000000',
  })

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.getCharactersV2(new GetCharactersV2Query
{
    CommunityUserId = "player-1234"
});

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Get Characters"
  version: "1.0.0"
  description: "Retrieve characters for a community user, linked Roblox user, linked Discord user, or account."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/civilian/characters:
    get:
      summary: "Get Characters"
      operationId: "getCharacters"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                recordTypeId: 7
                id: 2451
                syncId: "citizen:1234"
                name: "John Doe"
                type: 7
                sections:
                  category: 0
                  label: "Civilian Info"
                  fields:
                    label: "First Name"
                    value: "John"
                    uid: "first_name"
      parameters:
        -
          description: "Default target option for the in-game community user ID. Provide exactly one identifier."
          name: "communityUserId"
          in: "query"
          schema:
            type: "string"
          required: false
        -
          description: "Target the account linked to a Roblox user ID. Provide exactly one identifier."
          name: "roblox"
          in: "query"
          schema:
            type: "integer"
          required: false
        -
          description: "Target the account linked to a Discord user ID. Provide exactly one identifier."
          name: "discord"
          in: "query"
          schema:
            type: "string"
          required: false
        -
          description: "Target account UUID. Provide exactly one identifier."
          name: "accountUuid"
          in: "query"
          schema:
            type: "string"
          required: false
      security:
        -
          bearerAuth:
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request GET \
  --url "https://api.sonorancad.com/v2/civilian/characters?communityUserId=player-1234" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Response

Successful requests return application/json.

[
  {
    "recordTypeId": 7,
    "id": 2451,
    "syncId": "citizen:1234",
    "name": "John Doe",
    "type": 7,
    "sections": [
      {
        "category": 0,
        "label": "Civilian Info",
        "fields": [
          {
            "label": "First Name",
            "value": "John",
            "uid": "first_name"
          }
        ]
      }
    ]
  }
]

PreviousCivilian NextDelete Character

Last updated 19 days ago

Was this helpful?