Skip to content
Sitemark Developer Documentation

Operations

List Operations

Section titled “List Operations”

Retrieves a paginated list of operations.

Endpoint: GET /operations

Authentication: Required (API Key)

Query Parameters

Section titled “Query Parameters”
Parameter Type Required Description
id integer[] No Filter operations by one or more operation IDs.
site_id integer[] No Filter operations by one or more site IDs.
status string[] No Filter by one or more statuses. Valid values: DRAFT, ORDERED, ASSIGNED, PLANNED, FLOWN, UPLOADED, PROCESSING, IN_REVIEW, COMPLETED, CANCELLED.
data_product_id integer[] No Filter operations by one or more data product IDs.
_page integer No Page number (positive integer, defaults to 1)
_pageSize integer No Number of items per page (positive integer, max varies by configuration)
_sortBy string No Sort order. Format: +field for ascending or -field for descending.

Response Format

Section titled “Response Format”

Returns a paginated response with the following structure:

{
    "data": [
        {
            "id": "integer",
            "site_id": "integer",
            "date_captured": "date | null",
            "status": "string",
            "data_product_id": "integer",
            "data_product_name": "string | null",
            "description": "string | null",
            "date_start": "timestamp | null",
            "date_end": "timestamp | null",
            "contact_name": "string | null",
            "contact_phone": "string | null",
            "contact_mail": "string | null"
        }
    ],
    "pagination": {
        "page": "integer",
        "pageSize": "integer",
        "rowCount": "integer",
        "pageCount": "integer"
    }
}

Response Fields

Section titled “Response Fields”
  • id: Integer ID of the operation
  • site_id: Integer ID of the site this operation belongs to
  • date_captured: ISO 8601 date when the operation data was captured (can be null)
  • status: Current operation status (e.g. ASSIGNED, PLANNED, COMPLETED)
  • data_product_id: Integer ID of the data product associated with this operation
  • data_product_name: Name of the data product (can be null)
  • description: Operation description (can be null)
  • date_start: ISO 8601 timestamp for the start of the capture window (can be null)
  • date_end: ISO 8601 timestamp for the end of the capture window / deadline (can be null)
  • contact_name: Operation contact name (can be null)
  • contact_phone: Operation contact phone number (can be null)
  • contact_mail: Operation contact email address (can be null)

Example Requests

Section titled “Example Requests”

List all operations:

Terminal window
curl -X GET "https://api.sitemark.com/operations?_page=1&_pageSize=25" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by single site ID:

Terminal window
curl -X GET "https://api.sitemark.com/operations?site_id=5678&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by multiple site IDs (without brackets):

Terminal window
curl -X GET "https://api.sitemark.com/operations?site_id=5678&site_id=5679&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by multiple site IDs (with brackets):

Terminal window
curl -X GET "https://api.sitemark.com/operations?site_id[]=5678&site_id[]=5679&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by single operation ID:

Terminal window
curl -X GET "https://api.sitemark.com/operations?id=1234&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by multiple operation IDs (without brackets):

Terminal window
curl -X GET "https://api.sitemark.com/operations?id=1234&id=1235&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by multiple operation IDs (with brackets):

Terminal window
curl -X GET "https://api.sitemark.com/operations?id[]=1234&id[]=1235&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by status:

Terminal window
curl -X GET "https://api.sitemark.com/operations?status[]=ASSIGNED&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Filter by data product ID:

Terminal window
curl -X GET "https://api.sitemark.com/operations?data_product_id[]=5&_page=1&_pageSize=50" \
  -H "Authorization: ApiKey your-api-key-here"

Example Response

Section titled “Example Response”
{
    "data": [
        {
            "id": 35495,
            "site_id": 123,
            "date_captured": null,
            "status": "ASSIGNED",
            "data_product_id": 5,
            "data_product_name": "Solar thermography 3cm",
            "description": "Solar thermography 3cm",
            "date_start": "2026-06-10T00:00:00Z",
            "date_end": "2026-06-20T00:00:00Z",
            "contact_name": "Jonathan Schlicher",
            "contact_phone": "+15551234567",
            "contact_mail": "jschlicher@example.com"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 25,
        "rowCount": 1,
        "pageCount": 1
    }
}

Error Responses

Section titled “Error Responses”
Status Code Description
401 Unauthorized - Invalid or missing API key
400 Bad Request - Invalid query parameters
500 Internal Server Error