SYsysadminsmedia
Entities

Query All Entities

Changed on
get/v1/entities

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

qstring

search string; matches names, descriptions, serial/model numbers, manufacturers, notes, purchase sources, tag names, and custom field values. Use #<assetId> to look up by asset ID and double quotes for exact phrases

pageinteger

page number

pageSizeinteger

items per page

tagsstring[]

tags Ids

matchAllTagsboolean

require all selected tags to match (AND) instead of any (OR)

parentIdsstring[]

parent Ids

entityTypeIdsstring[]

entity type IDs; when provided this filter takes precedence over isLocation

orderBystring

field to order by; valid values: name, createdAt, updatedAt, assetId

orderDirectionstring

order direction; valid values: asc, desc. Defaults to desc for createdAt and updatedAt, asc otherwise

Response

OK

pageinteger
pageSizeinteger
totalinteger
totalPricenumber

Example response

{
  "items": [
    {
      "assetId": "0"
    }
  ]
}

Changes

  • 17e339c37e8bRevision changes
    • info

      added the new optional query request parameter entityTypeIds

    • info

      added the new optional query request parameter orderBy

    • info

      added the new optional query request parameter orderDirection

  • d3cf7c4fc223Revision changes
    • info

      added the new optional query request parameter matchAllTags