Institution

List institution elements

Changed on
get/api/v2/institution

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/institution
  • Auth: one of:
    • API key in header API-Key
    • API key in header API-Key and API key in header API-Pin

Query parameters

limitinteger

Page size; clamped to 1-1000 (/changes refuses over 1000 instead). A non-integer is a 422.

cursorstring

Opaque: the next_cursor of the previous page.

expandstring[]

Comma-separated link fields whose ids are replaced by ElementStub objects (one level deep). A field that is not a link is a 422.

fieldsstring[]

Comma-separated sparse fieldset: only these keys are returned, so type never and id only when named. Accepts: id, name, description, supertype, subtype, image_url, doctrine, status, founding_date, parent_institution, zones, objects, creatures, allies, adversaries, constructs, created_at, updated_at, change_seq, created_by, changed_by, changed_via, or any extension field name. Anything else is a 422. With expand, a link is expanded only if it is also named here.

namestring

Exact match on name.

name__icontainsstring

Case-insensitive substring match on name.

supertypestring

Exact match.

subtypestring

Exact match.

asstring

View as (the owner's keys only: a key with no member): read as another reader would. A membership id of this world (a person, an agent seat or a player seat) reads as that member's own key, its own creations included; a Character id reads as a guest of that Character with no membership (what it knows, the roster, nothing counted as its own); public reads everything that is not hidden. A hidden element is the plain 404, never a 410. An unknown value is a 422 (param as); a member key sending it is a 403 view_as_owner_only. Writes, /changes, /members, /me, the world and the files routes do not take it (422).

Response

A page, oldest change first (by change_seq, then id). With ?fields= the body holds only the named keys (not this schema's required set); with ?expand= each named link holds ElementStub objects instead of ids.

has_moreboolean required
next_cursorstring nullable required

Pass back as cursor for the next page; null on the last.

Changes

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • info

      added the optional property // to the response with the status