GET /v1/users/:userId/characters/:characterId

Use this endpoint to retrieve a single in-game character by its unique ID. The response includes all biographical fields, visual asset hashes, and the current ID card approval status. You can optionally request the character’s avatar signature data by passing signature=true.

You can fetch your own characters at any time. Staff members with the appropriate permissions can also fetch characters belonging to other users.

Endpoint

GET https://api.cacolombia.com/v1/users/:userId/characters/:characterId

Path Parameters

string

required

The Snowflake ID of the user who owns the character.

string

required

The Snowflake ID of the character to retrieve.

Query Parameters

string

Pass true to include the character’s signatureData field in the response. Omit or pass any other value to exclude it.

Response

string

The character’s unique Snowflake ID.

string

The Snowflake ID of the user who owns this character.

string

The character’s first name(s).

string

The character’s last name(s).

number

The character’s age in years.

number

The character’s height in centimetres.

string

The character’s gender. Either Masculino or Femenino.

string

The character’s blood type. One of O+, O-, A+, A-, B+, B-, AB+, AB-.

object

An object describing the character’s nationality.

Show nationality fields

string

The full nationality name (e.g. Colombiano).

string

The abbreviated nationality code (e.g. COL).

string

The country or region associated with the nationality (e.g. Colombia).

string

The character’s date of birth in DD/MM/YYYY format.

string | null

Hash identifier for the character’s avatar image, or null if not yet uploaded.

string | null

Hash identifier for the character’s generated ID card image, or null if not yet created.

string | null

Hash identifier for the character’s full-body reference image, or null if not yet uploaded.

string | null

Hash identifier for the character’s 3D GLB avatar model, or null if not yet uploaded.

object | null

Camera metadata for the 3D avatar, or null if not set.

object | null

Axis-aligned bounding box metadata for the 3D avatar, or null if not set.

string

The character’s ID card approval status. One of draft, pending_approval, or approved.

object | null

The character’s in-game wallet object, or null if no wallet exists.

string

The character’s avatar signature data. Only present when signature=true is passed.

string

ISO 8601 timestamp of when the character was created.

string

ISO 8601 timestamp of when the character was last updated.

Example Request

curl -X GET "https://api.cacolombia.com/v1/users/112233445566778899/characters/998877665544332211" \
  -H "Authorization: Bearer <your_token>"

Example Response

{
  "characterId": "998877665544332211",
  "userId": "112233445566778899",
  "firstNames": "Carlos Alberto",
  "lastNames": "Reyes Gómez",
  "age": 28,
  "height": 175,
  "gender": "Masculino",
  "bloodType": "O+",
  "nationality": {
    "nombre": "Colombiano",
    "abrev": "COL",
    "lugar": "Colombia"
  },
  "dob": "15/04/1996",
  "avatarHash": "abc123def456",
  "idCardHash": "xyz789uvw012",
  "fullBodyHash": null,
  "avatar3dHash": null,
  "avatar3dCamera": null,
  "avatar3dAABB": null,
  "idStatus": "approved",
  "wallet": null,
  "createdAt": "2024-01-10T14:30:00.000Z",
  "updatedAt": "2024-06-01T09:15:00.000Z"
}

Error Responses

Status	Error	Description
`401`	`Unauthorized`	No valid authentication token was provided.
`403`	`Unauthorized`	The authenticated user does not match the `userId` in the path and does not have staff permissions.
`404`	`Unknown User`	No user was found with the given `userId`.
`404`	`Unknown Character`	No character was found with the given `characterId` belonging to this user.

Overview

Auth & OAuth

Users

Characters

Economy

Banking

Staff

Utilities

GET /v1/users/:userId/characters/:characterId — Get

Endpoint

Path Parameters

Query Parameters

Response

Example Request

Example Response

Error Responses

​Endpoint

​Path Parameters

​Query Parameters

​Response

​Example Request

​Example Response

​Error Responses

Endpoint

Path Parameters

Query Parameters

Response

Example Request

Example Response

Error Responses