/api/libraries/{id}/entities

Path Parameters

id*string

Resource ID

Query Parameters

type*string

Entity type to list

limit?integer

Max results

Range0 < value

offset?|

Offset for pagination

Range0 <= value

sortBy?string

Field to sort by: name (alphabetical), addedAt, updatedAt

sortOrder?string

Sort direction

Value in"asc" | "desc"

ignoreArticles?string

When true, leading the/a/an is stripped from alphabetical sort

Value in"true" | "false"

numbersFirst?string

When true, names starting with digits sort before letters

Value in"true" | "false"

includeLetterOffsets?string

When true, returns letter→offset map for the alphabet jump bar (name sort only)

Value in"true" | "false"

Response Body

`application/json`

curl -X GET "https://example.com/api/libraries/string/entities?type=string"

{
  "entities": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "status": "pending",
      "sourcePluginId": "string",
      "searchTerms": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "assets": {
        "property1": "string",
        "property2": "string"
      },
      "assetAspects": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "total": 0,
  "letterOffsets": {
    "property1": 0,
    "property2": 0
  }
}

{
  "error": "string"
}

/api/libraries/{id}/entities

Path Parameters

Query Parameters

Response Body

200application/json

404application/json

`application/json`

`application/json`