Skip to main content
GET
/
v1
/
npc
/
{instance}
/
{identifier}
Retrieve an NPC
curl --request GET \
  --url https://api.pixocracy.io/v1/npc/{instance}/{identifier} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "instance": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "application": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "description": "<string>",
      "instances": [
        {}
      ],
      "twitchUsername": "<string>",
      "featuredInstance": {}
    },
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "taxRate": 123,
    "collectedTaxes": 123,
    "npcs": [],
    "agentNpcs": []
  }
}
Retrieve information about a specific NPC in your instance using its ID or UUID. This endpoint returns details about the NPC including its name and association with the instance. Use this endpoint to track and manage your NPCs, ensuring they are properly registered and maintained in your game world.

Authorizations

​
Authorization
string
header
required

Your Application's JWT token

Path Parameters

​
instance
string
required
​
identifier
string
required

The ID or UUID of the NPC

Response

The NPC

​
id
string<uuid>
required

Unique identifier

​
createdAt
string<date-time>
required

Date of creation

​
updatedAt
string<date-time>
required

Date of last update

​
name
string
required

The name of the NPC.

​
uuid
string<uuid>
required

The UUID of the NPC.

​
deletedAt
string<date-time> | null

Date of deletion

​
instance
object

The instance that the NPC is a part of.