GET /api/v1/{context_id}/entities

Changed on

List entities (optionally filtered by type), ordered by type then name. Paginated: limit defaults to 100 and is capped at 500; follow page.nextCursor to walk the Context.

Request

Path parameters

context_idstring required

Spectron context id

Query parameters

typestring

Filter by entity type

limitinteger

Max entities to return (default 100, max 500)

cursorstring

Continuation token from the previous page's page.nextCursor

countboolean

Also return page.totalSize (costs a full count of the filtered set)

offsetinteger

Deprecated: rows to skip. Use cursor.

Response

Changes

    • info

      added the new optional query request parameter count

    • info

      added the new optional query request parameter cursor

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset