curl --request GET \
--url https://public-api.frictio.ai/v2/objects/{object}/records \
--header 'X-Api-Key: <api-key>' \
--header 'X-Workspace-Id: <x-workspace-id>'import requests
url = "https://public-api.frictio.ai/v2/objects/{object}/records"
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Id': '<x-workspace-id>', 'X-Api-Key': '<api-key>'}
};
fetch('https://public-api.frictio.ai/v2/objects/{object}/records', 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://public-api.frictio.ai/v2/objects/{object}/records",
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>",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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://public-api.frictio.ai/v2/objects/{object}/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
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))
}HttpResponse<String> response = Unirest.get("https://public-api.frictio.ai/v2/objects/{object}/records")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.frictio.ai/v2/objects/{object}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"object": "deal",
"visibility": "workspace",
"fields": {
"name": "Acme",
"pipeline_id": "pipe-1",
"amount": "1200.50",
"my_note": "hello"
},
"created_at": "<string>",
"updated_at": "<string>",
"created_by": {
"kind": "member",
"name": "<string>"
},
"updated_by": {
"kind": "member",
"name": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true
}
}List CRM object records
特定の CRM オブジェクトのレコード一覧を取得します。
ワークスペースに公開されているレコードのみ返します。
クエリパラメータは limit / cursor / ids / related_id のみ受け付けます(未知のパラメータは 400)。
ids / related_id で絞り込んだ場合も、limit / cursor のページング規則は通常どおり適用されます。
ids と related_id を同時に指定した場合は AND(両方を満たすレコードだけ)になります。
curl --request GET \
--url https://public-api.frictio.ai/v2/objects/{object}/records \
--header 'X-Api-Key: <api-key>' \
--header 'X-Workspace-Id: <x-workspace-id>'import requests
url = "https://public-api.frictio.ai/v2/objects/{object}/records"
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Id': '<x-workspace-id>', 'X-Api-Key': '<api-key>'}
};
fetch('https://public-api.frictio.ai/v2/objects/{object}/records', 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://public-api.frictio.ai/v2/objects/{object}/records",
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>",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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://public-api.frictio.ai/v2/objects/{object}/records"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
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))
}HttpResponse<String> response = Unirest.get("https://public-api.frictio.ai/v2/objects/{object}/records")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.frictio.ai/v2/objects/{object}/records")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"object": "deal",
"visibility": "workspace",
"fields": {
"name": "Acme",
"pipeline_id": "pipe-1",
"amount": "1200.50",
"my_note": "hello"
},
"created_at": "<string>",
"updated_at": "<string>",
"created_by": {
"kind": "member",
"name": "<string>"
},
"updated_by": {
"kind": "member",
"name": "<string>"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true
}
}Authorizations
Headers
ワークスペースID
Path Parameters
GET /v2/objects のレスポンスに含まれる data[].name を指定します。
利用できるオブジェクトはワークスペースごとに異なるため、指定できる値はその応答で確認してください。
Query Parameters
1–100(デフォルト30)
1 <= x <= 100次ページ取得用カーソル
取得するレコードの id をカンマ区切りで指定します(最大100件)。各要素は UUID 形式である
必要があり、形式が違う場合は 400 になります。
1リクエストで返る件数は limit(既定 30)に従うため、100件をまとめて取得する場合は
limit も指定してください。指定しない場合は 30 件ずつのページングになります。
id の大文字・小文字は区別しません(小文字として扱います)。
公開範囲外・別ワークスペース・削除済みの id は結果から除かれます(エラーにはなりません)。
ids=(空)は 400 になります。
^[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}(,[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}){0,99}$関連で絞り込むときの参照元レコードの id です。オブジェクト名は指定しません
(一覧対象のオブジェクトから参照経路が決まります)。次の関連を辿ります。
companyの一覧: 指定した Contact または Deal に紐づく Companycontactの一覧: 指定した Company または Deal に紐づく Contactdealの一覧: 指定した Company または Contact に紐づく Deal
UUID 形式である必要があり、形式が違う場合は 400 になります。
id の大文字・小文字は区別しません(小文字として扱います)。
公開範囲外・別ワークスペース・削除済み・関連していないレコードの id を指した場合と、
関連を解除したレコードは、いずれも空の data を返します(404 にはなりません)。
関連を持たないオブジェクト(pipeline / stage)の一覧で指定した場合は 400 です。
ただしそのオブジェクトがワークスペースで利用できない場合は 404 になります。
^[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}$