GET /processes

Description

Get a list of all the processes a player can play/join.

All public and protected processes created by any player in the game will be listed.

Any processes which were bootstrapped will be created and listed here when the player joins the game for the first time.

Resource URL

https://api.playlyfe.com/processes

Method

GET

Scopes

player, game, debug

Parameters

LocationParameter NameDefault ValueDescription
Queryskip0Number of processes to skip
Querylimit10Maximum number of processes to return
QuerystateACTIVEComma seperated list of process states to filter by.

Example

Request
GET https://api.playlyfe.com/processes?state=ACTIVE,COMPLETED
Response
{
  "data": [
    {
      "id": "neo/5312096a8e1ebb4550a6a6f6",
      "name": "Real Life",
      "definition": "boring_stuff",
      "version": "ab4f01025698574f4b71d77fff3e1b74",
      "access": "PRIVATE",
      "created": "2014-03-01T16:23:06.500Z",
      "owner": {
        "id": "neo",
        "alias": "Neo"
      },
      "state": "ACTIVE",
      "performers": [
        {
          "id": "neo",
          "alias": "Neo"
        }
      ],
      "collaborators": []
    },
    {
      "access": "PRIVATE",
      "collaborators": [],
      "created": "2014-03-01T16:23:06.501Z",
      "definition": "destroy_evil",
      "id": "neo/5312096a8e1ebb4550a6a6f8",
      "name": "The Matrix",
      "owner": {
        "id": "neo",
        "alias": "Neo"
      },
      "performers": [
        {
          "id": "neo",
          "alias": "Neo"
        },
        {
          "id": "morpheus",
          "alias": "Morpheus"
        }
      ],
      "state": "ACTIVE",
      "version": "ab4f01025698574f4b71d77fff3e1b74"
    }
  ],
  "total": 2
}