Search for objects in a schema

https://api.socialidnow.com/v1

POST

/marketing/datastore/schemas/{schema_name}/objects/search

Searches for Objects in the Schema.

The datastore schema search is powered by a limited version of the MongoDB Aggregation Pipeline.

Some operators and stages are not allowed in the datastore searches. The set of allowed operators is:

- Comparison operators: $gt $gte $lt $lte $ne $in $nin
- Boolean operators: $or $and $not $nor
- Element operators: $exists
- Array operators: $all $elemMatch $size
- Group accumulator operators: $sum $avg $first $last $max $min $push $addToSet
- Date operators: $dayOfYear $dayOfMonth $dayOfWeek $year $month $week $hour $minute $second $millisecond
- String operators: $concat $substr $toLower $toUpper $strcasecmp $regex $options
- Arithmetic operators: $add $subtract $multiply $divide $mod
- Set operators: $setEquals $setIntersection $setUnion $setDifference $setIsSubset $anyElementTrue $allElementsTrue

And the available stages are: match, group, project, sort, limit, skip.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The search was performed successfully.

Body

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas//objects/search' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "match": {
        "email": {
            "$exists": true
        }
    }
}'

Response Example

200 - Sucesso

{
    "total": 2,
    "count": 2,
    "offset": 0,
    "results": [
        {
            "object_id": "54481188e5cb7cffe4000003",
            "user_id": 340,
            "created_at": "2014-10-24T14:48:00Z",
            "updated_at": "2014-10-24T14:48:00Z",
            "email": "john@example.com",
            "second_field": 123
        }
    ]
}

Modified at 2025-08-19 19:12:30

Create a new object

Get a specific object