Retrieve a list of faces
Retrieve a list of face definitions, with optional filters for template type, language, limit, and pagination.
GET
Parameters
Query Parameters
Id
Filter resources by their unique identifier
Org_id
Filter resources by the organization they belong to
Name
Filter resources by their name or title
Autocomplete
Search term for autocomplete functionality
Limit
How many items to return at one time (max 100)
Next
Pagination token for retrieving the next page of results
Order
Sort order for the results (ascending or descending)
SortBy
Field name to sort the results by
When_created[$gt]
Filter faces created after this date and time
When_created[$lt]
Filter faces created before this date and time
When_created[$gte]
Filter faces created on or after this date and time
When_created[$lte]
Filter faces created on or before this date and time
| Status code | Description |
|---|---|
| 200 | A list of face objects along with the pagination token for the next set of results, if available. |
| 400 | Bad request error - the request contains invalid parameters or malformed data |
| 500 | Internal server error - an unexpected error occurred on the server |
cURL
curl -L \"https://blockv-labs.io/faces?id={id}&org_id={org_id}&name={name}&autocomplete={autocomplete}&limit={limit}&next={next}&order={order}&sortBy={sortBy}&when_created[$gt]={when_created[$gt]}&when_created[$lt]={when_created[$lt]}&when_created[$gte]={when_created[$gte]}&when_created[$lte]={when_created[$lte]}" \-H 'Accept: application/json'
Response
{"faces": [{"id": "string","name": "string","url": "string","content": "string","assets": [{"id": "string","name": "string","type": "string","url": "string","hash": "string","is_public": false,"when_created": "2024-01-01T00:00:00Z"}],"when_created": "2024-01-01T00:00:00Z","when_modified": "2024-01-01T00:00:00Z"}],"next": "string"}
json
{"type": "object","required": ["faces"],"properties": {"faces": {"type": "array","description": "Array of face objects.","items": {"type": "object","description": "Face entity representing a visual interface or template for smart objects","required": ["id","name","when_created","when_modified"],"properties": {"id": {"type": "string","description": "Unique identifier for the face","x-oapi-codegen-extra-tags": {"bson": "_id","json": "id"},"x-go-type": "id.ID","x-go-type-import": {"path": "github.com/vlabsio/smarttoken/pkg/types/id"},"x-go-type-skip-optional-pointer": true},"name": {"type": "string","description": "Name of the face.","x-oapi-codegen-extra-tags": {"bson": "name","validate": "required,max=255"}},"url": {"type": "string","description": "URL of the face, typically pointing to an image or resource.","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"content": {"type": "string","description": "Content of the face.","x-oapi-codegen-extra-tags": {"bson": "content,omitempty"}},"config": {"type": "object","description": "Optional configuration data for customizing the face.","additionalProperties": true,"x-oapi-codegen-extra-tags": {"bson": "config"}},"assets": {"type": "array","description": "List of resources required or utilized by the face.","items": {"type": "object","description": "Represents a file or media asset stored in the platform","required": ["id","url"],"properties": {"id": {"type": "string","description": "Unique identifier for the asset","x-oapi-codegen-extra-tags": {"bson": "id,omitempty"}},"name": {"type": "string","description": "Human-readable name of the asset","x-oapi-codegen-extra-tags": {"bson": "name,omitempty"}},"type": {"type": "string","description": "MIME type of the asset (e.g., image/jpeg, application/pdf)","x-oapi-codegen-extra-tags": {"bson": "type,omitempty"}},"url": {"type": "string","description": "Public URL where the asset can be accessed","x-oapi-codegen-extra-tags": {"bson": "url,omitempty"}},"hash": {"type": "string","description": "Cryptographic hash of the asset content for integrity verification","x-oapi-codegen-extra-tags": {"bson": "hash,omitempty"}},"is_public": {"type": "boolean","description": "Whether the asset is publicly accessible without authentication","x-oapi-codegen-extra-tags": {"bson": "is_public,omitempty"}},"when_created": {"type": "string","format": "date-time","description": "Timestamp when the asset was uploaded","x-oapi-codegen-extra-tags": {"bson": "when_created,omitempty"}}}},"x-oapi-codegen-extra-tags": {"bson": "assets"},"x-go-type-skip-optional-pointer": true},"when_created": {"type": "string","format": "date-time","description": "Timestamp of when the face was created.","x-oapi-codegen-extra-tags": {"bson": "when_created"}},"when_modified": {"type": "string","format": "date-time","description": "Timestamp of the last modification to the face.","x-oapi-codegen-extra-tags": {"bson": "when_modified"}}}}},"next": {"type": "string","description": "Pagination token for the next set of results, if any.","x-go-type-skip-optional-pointer": true}}}