For the complete documentation index, see llms.txt. This page is also available as Markdown.

Search

Search for events

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 100
offsetnumberOptionalDefault: 0
Responses
200

Successful response

application/json
totalnumberRequired
post/events/search
POST /api/events/events/search HTTP/1.1
Host: localhost:3000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1189

{
  "query": {
    "type": "and",
    "clauses": [
      {
        "id": "text",
        "eventType": "text",
        "status": {
          "type": "text",
          "terms": [
            "CREATED"
          ]
        },
        "createdAt": {
          "type": "text",
          "term": "2026-01-01"
        },
        "updatedAt": {
          "type": "text",
          "term": "2026-01-01"
        },
        "legalStatuses.DECLARED.createdAtLocation": {
          "type": "text",
          "location": "text"
        },
        "legalStatuses.DECLARED.createdByRole": {
          "type": "text",
          "terms": [
            "text"
          ]
        },
        "legalStatuses.REGISTERED.acceptedAt": {
          "type": "text",
          "term": "2026-01-01"
        },
        "legalStatuses.REGISTERED.createdAtLocation": {
          "type": "text",
          "location": "text"
        },
        "legalStatuses.REGISTERED.createdByRole": {
          "type": "text",
          "terms": [
            "text"
          ]
        },
        "legalStatuses.REGISTERED.registrationNumber": {
          "type": "text",
          "term": "text"
        },
        "createdAtLocation": {
          "type": "text",
          "location": "text"
        },
        "updatedAtLocation": {
          "type": "text",
          "location": "text"
        },
        "assignedTo": {
          "type": "text",
          "term": "text"
        },
        "createdByUserType": {
          "type": "text",
          "term": "user"
        },
        "updatedByUserRole": {
          "type": "text",
          "term": "text"
        },
        "createdBy": {
          "type": "text",
          "term": "text"
        },
        "updatedBy": {
          "type": "text",
          "term": "text"
        },
        "trackingId": {
          "type": "text",
          "term": "text"
        },
        "flags": {
          "anyOf": [
            "text"
          ],
          "noneOf": [
            "text"
          ]
        },
        "data": {
          "type": "text",
          "term": "text"
        }
      }
    ]
  },
  "limit": 100,
  "offset": 0,
  "sort": [
    {
      "field": "text",
      "direction": "asc"
    }
  ]
}
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "status": "CREATED",
      "legalStatuses": {
        "DECLARED": {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
          "createdByUserType": "user",
          "acceptedAt": "2026-01-01T00:00:00.000Z",
          "createdByRole": "text"
        },
        "REGISTERED": {
          "createdAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
          "createdByUserType": "user",
          "acceptedAt": "2026-01-01T00:00:00.000Z",
          "createdByRole": "text",
          "registrationNumber": "text"
        }
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "dateOfEvent": "2026-01-01",
      "placeOfEvent": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "text",
      "createdByUserType": "user",
      "updatedByUserRole": "text",
      "createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAtLocation": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "assignedTo": "text",
      "updatedBy": "text",
      "trackingId": "text",
      "potentialDuplicates": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "trackingId": "text"
        }
      ],
      "flags": [
        "text"
      ],
      "declaration": {
        "ANY_ADDITIONAL_PROPERTY": {
          "country": "text",
          "streetLevelDetails": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "addressType": "text",
          "administrativeArea": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  ],
  "total": 1
}

Last updated