ListOwnerships

ListOwnerships

curl --request GET \
  --url https://developer.synq.io/api/owners/v1/{owner_id}/ownerships \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/owners/v1/{owner_id}/ownerships"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/owners/v1/{owner_id}/ownerships', 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://developer.synq.io/api/owners/v1/{owner_id}/ownerships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://developer.synq.io/api/owners/v1/{owner_id}/ownerships"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://developer.synq.io/api/owners/v1/{owner_id}/ownerships")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "ownerships": [
    {
      "id": "<string>",
      "ownerId": "<string>",
      "selection": {
        "dataproductId": "<string>"
      },
      "alert": {
        "severities": [],
        "notifyUpstream": true,
        "ongoing": {
          "disabled": {}
        },
        "allowSqlTestAuditLink": true,
        "isDisabled": true
      },
      "etag": "<string>",
      "createdBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "updatedBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

GET

api

owners

{owner_id}

ownerships

ListOwnerships

curl --request GET \
  --url https://developer.synq.io/api/owners/v1/{owner_id}/ownerships \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/owners/v1/{owner_id}/ownerships"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/owners/v1/{owner_id}/ownerships', 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://developer.synq.io/api/owners/v1/{owner_id}/ownerships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://developer.synq.io/api/owners/v1/{owner_id}/ownerships"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://developer.synq.io/api/owners/v1/{owner_id}/ownerships")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "ownerships": [
    {
      "id": "<string>",
      "ownerId": "<string>",
      "selection": {
        "dataproductId": "<string>"
      },
      "alert": {
        "severities": [],
        "notifyUpstream": true,
        "ongoing": {
          "disabled": {}
        },
        "allowSqlTestAuditLink": true,
        "isDisabled": true
      },
      "etag": "<string>",
      "createdBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "updatedBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

owner_id

string

required

Id of the owner whose ownerships to list. Accepts the bare UUID or the owner-<uuid> entity_id form (the prefix is stripped server-side).

Pattern: ^(owner-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

pagination.cursor

string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize

integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

includeDeleted

boolean

Include soft-deleted ownerships.

Response

200 - application/json

Success

ownerships

Ownership · object[]

The owner's ownerships.

Show child attributes

pageInfo

PageInfo · object

Pagination cursor for the next page.

Show child attributes

DeleteOwnership UpsertOwnership

Get Started

Alerts

Monitors

Monitors Types

Reconciliations

Data Products

Scout AI

Ownership

Incidents

Analytics

Lineage

BI Integrations

Data Warehouse Integrations

Transactional databases

Code Integrations

dbt Integrations

SQLMesh Integrations

Coalesce Integrations

Orchestration Tool Integrations

Alerting Integrations

Catalogs

Google Cloud Integrations

Admin

Security

Support

Developer API

Authorizations

Path Parameters

Query Parameters

Response