Objects

List objects in a collection

Changed on

Returns a paginated list of objects from the specified collection. Optionally includes preference data for the objects.

get/v1/objects/{collection}

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/objects/{collection}
  • Auth: HTTP bearer

Path parameters

collectionstring required

The collection this object belongs to.

Query parameters

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

includestring[]

Includes preferences of the objects in the response.

Response

OK

Example response

{
  "entries": [
    {
      "__typename": "Object",
      "collection": "assets",
      "created_at": null,
      "id": "specimen_25",
      "properties": {
        "classification": "Theropod",
        "config": {
          "biz": "baz",
          "foo": "bar"
        },
        "name": "Velociraptor",
        "status": "contained"
      },
      "updated_at": "2024-05-22T12:00:00Z"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

  • de4604427056Revision changes
    • warning

      deleted the query request parameter include[]

    • info

      added the new optional query request parameter include

  • 923618cb1489Revision changes
    • info

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