Entities

List characters, props and places

Every entity you own, ordered by kind then name, each with its reference set and how many photos it is tagged on.

No kind means every kind. (The app's own screen defaults to characters; the API does not, because an agent asking for entities is asking for all of them.) Looks come back with every kind, each with its parent_id; one character's looks are ?kind=look&parent=<id>.

Light on purpose: sheets, looks and links are on GET /v1/entities/{id} only.

get/v1/entities

Request

  • Base URL: https://nanostudiopro.com/api
  • URL: https://nanostudiopro.com/api/v1/entities
  • Auth: HTTP bearer

Query parameters

kind'character' | 'prop' | 'location' | 'look' | 'skin'

Narrow to one kind. Omit for every kind.

parentstring

With kind=look only: the character whose looks to list. An id that is not yours lists nothing.

Response

Every matching entity — the whole set, not a page.

totalinteger

Example response

{
  "items": [
    {
      "id": "cmod4q3op00011dod8a0omywd",
      "name": "Pancho",
      "slug": "pancho",
      "photo_count": 12,
      "bio": {
        "born": "1983"
      },
      "specs": {
        "fields": [
          {
            "key": "top_speed",
            "label": "Top speed",
            "value": "250 km/h"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.