Retrieve a character | Sample

1 parameter

character_idstringrequired

The identifier of the character to retrieve.

1 status code

200Returns the character with its `id`, `name`, and Unix creation timestamp in `created_at`.

idstringrequired

Identifier for the character creation cameo.

namestringrequired

Display name for the character.

created_atintegerrequired

Unix timestamp (in seconds) when the character was created.

Error handling

character_id must identify the character you want to retrieve. Provide the identifier as a string.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.characters.get({ characterId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "created_at": 1
}

Request

Response

Errors