Skip to main content

Search entities

Accepts an array of criteria (max 10) where each criterion is an object whose fields are AND'd. String values are capped at 200 characters. limit is capped at 500.

Request​

Method: POST
Path: /api/entities/search

Authentication: Not required

Request Body​

Content Type: application/json

Schema: See component schemas below

Responses​

200 - Matching entities​

400 - Invalid criteria​

404 - Tenant not found​

Examples​

cURL​

curl -X POST \
  -H "Content-Type: application/json" \
  http://localhost:3000/api/entities/search \
  -d '{"example": "data"}'

JavaScript​

const response = await fetch('http://localhost:3000/api/entities/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    // Request data
  }),
});

const data = await response.json();
console.log(data);

This documentation is automatically generated from the OpenAPI specification.