Aplas API ReferenceList assets of a type
Cursor-paginated, narrowable by filter and search.
Unlike the studio, a filter term this API cannot express is REFUSED with a 400 rather than skipped. A dropped term would return the unfiltered set presented as filtered — more rows than you asked for, with nothing in the response saying a constraint was ignored.
search narrows the set but does NOT order it: rows come back in slug order so the cursor stays stable. Relevance is not a stable total order, so paging by it would skip or repeat rows.
Authorization
BearerAuth API authentication via Authorization: Bearer <your-api-key>. Obtain
your API key from Config → API in the Aplas web app.
In: header
Path Parameters
The workspace's slug.
The asset type's slug.
Query Parameters
Maximum number of resources to return in one page.
501 <= value <= 200Opaque cursor from a previous response's nextCursor. Omit to fetch the first page.
A JSON array of {field, op, value} terms, ANDed together. field is a column name (name, status, assetId, shortName, createdAt, updatedAt), fields.<fieldId> for a declared field, or relations.<slug> for a relationship. Ops: eq, neq, in, contains, gte, lte, isEmpty, notEmpty — legal ops depend on the field's type. Hidden fields are not filterable.
Full-text search across the asset's indexed content.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.au.aplas.com/api/v3/workspaces/string/asset-types/string/assets?filter=%5B%7B%22field%22%3A%22fields.vendor%22%2C%22op%22%3A%22eq%22%2C%22value%22%3A%22Acme%22%7D%5D"{
"nextCursor": "string",
"data": [
{
"id": "string",
"name": "string",
"shortName": "string",
"description": "string",
"status": 0,
"fields": {},
"sample": true,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"statusCode": 403,
"error": "Forbidden",
"message": "The permissions of your API key only allow read-only/GET calls."
}{
"statusCode": 403,
"error": "Forbidden",
"message": "The permissions of your API key only allow read-only/GET calls."
}{
"statusCode": 403,
"error": "Forbidden",
"message": "The permissions of your API key only allow read-only/GET calls."
}{
"statusCode": 403,
"error": "Forbidden",
"message": "The permissions of your API key only allow read-only/GET calls."
}