RIrivet-dev
actors::list

Lists actors by IDs, by name and key, or by name. Only a listing by name is paginated.

Changed on
get/actors

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/actors
  • Auth
    • HTTP bearer
    • or API key in header x-rivet-token

Query parameters

namespacestring

Name of the namespace to operate in. Defaults to default.

namestring

Actor name. Required unless actor_ids or actor_id is set. Without key, lists every actor with this name, newest first.

keystring

Actor key in slash-separated form. Requires name. Returns at most one actor.

actor_idsstring

Comma-separated actor IDs to look up. Takes precedence over actor_id, name and key. IDs of missing actors or of actors in another namespace are skipped.

actor_idstring

Same as actor_ids, used when actor_ids is absent.

include_destroyedboolean

Include destroyed actors. Must be exactly true or false.

limitinteger

Maximum number of actors to return for a listing by name, from 1 to 100. Defaults to 100. A page can hold fewer actors even when more remain.

cursorstring

Opaque cursor from the previous response's pagination.cursor. Only used for a listing by name.

Response

The matching actors.

Example response

{
  "actors": [
    {
      "actor_id": "d97pbq1nyqxw1w5qdwz0iirbqiblh2"
    }
  ]
}

Changes

  • aa8d1a8a5d14Revision changes
    • breaking

      for the query request parameter include_destroyed, default value false was added

    • breaking

      for the query request parameter limit, default value 100 was added

    • breaking

      for the query request parameter limit, the min was increased from 0.00 to 1.00

    • breaking

      added the pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ to the query request parameter namespace

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      for the query request parameter namespace, the maxLength was set to 63

    • warning

      for the query request parameter limit, the max was set to 100.00

    • warning

      removed the optional property // from the response with the status

    • info

      the endpoint scheme security rivet_token_header was added to the API

    • info

      the query request parameter namespace became optional

    • info

      for the query request parameter actor_id, the type was generalized from array to string

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property / became required for the status

    • info

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

    • info

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

  • b4575371d0d8Revision changes
    • info

      the endpoint scheme security bearer_auth was added to the API