Equipment

Equipment are the base object upon which emissions quantifications are performed.

https://api.validere.io/app

Search equipment

Search and list equipment

post

Query parameters

periodstringOptional

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Body

all ofOptional

and

and

Responses

200

successful operation

application/jsonapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Responseall of

post

HTTPcURLJavaScriptPython

POST /app/v1/equipment/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "page": 0,
  "page_size": 20,
  "sort_by": "facility_name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "facility.name": "WellSite1"
      }
    ],
    "custom_attributes.hint": "View schema for all supported fields",
    "custom_attributes.operator": {
      "$in": [
        "Bob",
        "Alice",
        "Eve"
      ]
    },
    "name": {
      "$like": "Compressor"
    }
  }
}

200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "created_at": "2025-08-19T00:23:34.581Z",
      "updated_at": "2025-08-19T00:23:34.581Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      },
      "effective_date": "2022-01-01",
      "facility": {
        "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
        "name": "Facility 1"
      },
      "id": "text",
      "latitude": 51,
      "longitude": -114,
      "name": "text",
      "status": "active",
      "type": {
        "id": "text",
        "name": "text"
      }
    }
  ]
}

Get an equipment

Get an Equipment by ID

get

Path parameters

equipment_idstring · uuidRequired

Id of equipment

Example: 748970de-fd1f-4494-ae3f-47cc21ff205f

Query parameters

periodstringOptional

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Responses

200

successful operation

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /app/v1/equipment/{equipment_id} HTTP/1.1
Host: api.validere.io
Accept: */*

200

successful operation

{
  "created_at": "2025-08-19T00:23:34.581Z",
  "updated_at": "2025-08-19T00:23:34.581Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000",
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "effective_date": "2022-01-01",
  "facility": {
    "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
    "name": "Facility 1"
  },
  "id": "text",
  "latitude": 51,
  "longitude": -114,
  "name": "text",
  "status": "active",
  "type": {
    "id": "text",
    "name": "text"
  }
}