Get results

cURL

curl --request GET \
  --url https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "page": 123,
  "page_size": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "EMAIL",
      "status": "NOT_READY",
      "priority": "LOW",
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assigned_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "note_content": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "not_found",
  "message": "<string>"
}

{
  "status": "results_not_ready",
  "message": "<string>"
}

{
  "status": "results_expired",
  "message": "<string>"
}

{
  "status": "results_page_too_large",
  "message": "<string>"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

GET

tasks

query-jobs

{job_id}

results

cURL

curl --request GET \
  --url https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.unifygtm.com/tasks/v1/tasks/query-jobs/{job_id}/results")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "total": 123,
  "page": 123,
  "page_size": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "EMAIL",
      "status": "NOT_READY",
      "priority": "LOW",
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assigned_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "due_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "note_content": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "status": "bad_request",
  "errors": [
    {
      "code": "<string>",
      "path": [
        "<string>"
      ],
      "object_api_name": "<string>",
      "attribute_api_name": "<string>"
    }
  ],
  "message": "<string>"
}

{
  "status": "unauthorized",
  "message": "<string>"
}

{
  "status": "not_found",
  "message": "<string>"
}

{
  "status": "results_not_ready",
  "message": "<string>"
}

{
  "status": "results_expired",
  "message": "<string>"
}

{
  "status": "results_page_too_large",
  "message": "<string>"
}

{
  "status": "rate_limited",
  "message": "<string>"
}

{
  "status": "error",
  "message": "<string>"
}

Overview

Retrieve a finished task query job one page at a time. Check the job’s status before requesting results and download all pages before expires_at.

Examples

Set UNIFY_API_KEY to your API key.

Read a page of tasks

Replace the example job ID with your finished query job:

curl --request GET \
  --url "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/e5a1aab2-3d0c-4a47-9a0d-11a7ac6d3a34/results?page=1&page_size=1000" \
  --header "X-Api-Key: $UNIFY_API_KEY"

The JSON response contains data, total, page, and page_size. Increment page until you’ve retrieved all total rows. JSON pages support up to 2,000 rows. If a page exceeds the payload limit, request fewer rows or use NDJSON.

Stream a larger page

Add Accept: application/x-ndjson to receive one task per line. NDJSON supports up to 10,000 rows per page and returns pagination metadata in the x-total, x-page, and x-page-size response headers.

curl --no-buffer \
  --url "https://api.unifygtm.com/tasks/v1/tasks/query-jobs/e5a1aab2-3d0c-4a47-9a0d-11a7ac6d3a34/results?page=1&page_size=10000" \
  --header "X-Api-Key: $UNIFY_API_KEY" \
  --header "Accept: application/x-ndjson"

A 409 response means the job has no available results. Inspect the job status to distinguish an in-progress job from a failed or canceled job. A 410 response means the results expired and you need to create a new job.

Authorizations

x-api-key

string

header

required

Path Parameters

job_id

string

required

Query Parameters

page

integer

Required range: x >= 1

page_size

integer

Maximum is 2,000 for JSON responses and 10,000 when Accept is application/x-ndjson.

Required range: 1 <= x <= 10000

Response

Successful response returned when fetching completed query job results.

total

integer

required

page

integer

required

page_size

integer

required

data

object[]

required

Show child attributes

⌘I

Unify platform

MCP

Developer guides

API reference

SDKs

Overview

Examples

Authorizations

Path Parameters

Query Parameters

Response

​Overview

​Examples

Authorizations

Path Parameters

Query Parameters

Response

Overview

Examples