GET
/
v1
/
catalogs
/
{catalog_id}
/
entities
curl --request GET \
  --url 'https://api.rootly.com/v1/catalogs/%7Bcatalog_id%7D/entities?include=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE&filter%5Bslug%5D=SOME_STRING_VALUE&filter%5Bname%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Bgt%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Bgte%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Blt%5D=SOME_STRING_VALUE&filter%5Bcreated_at%5D%5Blte%5D=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "data": [
    {
      "id": "<string>",
      "type": "catalog_entities",
      "attributes": {
        "name": "<string>",
        "description": "<string>",
        "position": 123,
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
catalog_id
string
required

Query Parameters

​
include
enum<string>

comma separated if needed. eg: catalog,properties

Available options:
catalog,
properties
​
sort
enum<string>

comma separated if needed. eg: created_at,updated_at

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
position,
-position
​
page[number]
integer
​
page[size]
integer
​
filter[slug]
string
​
filter[name]
string
​
filter[created_at][gt]
string
​
filter[created_at][gte]
string
​
filter[created_at][lt]
string
​
filter[created_at][lte]
string

Response

200 - application/vnd.api+json
success
​
data
object[]
required
​
links
object
required

Was this page helpful?

Previous
Creates a catalog_entity
Next