cURL
curl --request POST \
--url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objectApiName": "<string>",
"objectId": "<string>",
"pageToken": "<string>",
"sortBy": "<string>",
"sortDirection": "<string>"
}
'import requests
url = "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords"
payload = {
"objectApiName": "<string>",
"objectId": "<string>",
"pageToken": "<string>",
"sortBy": "<string>",
"sortDirection": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
objectApiName: '<string>',
objectId: '<string>',
pageToken: '<string>',
sortBy: '<string>',
sortDirection: '<string>'
})
};
fetch('https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords', 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.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'objectApiName' => '<string>',
'objectId' => '<string>',
'pageToken' => '<string>',
'sortBy' => '<string>',
'sortDirection' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords"
payload := strings.NewReader("{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"nextPageToken": "<string>",
"records": [
{
"archived": true,
"createTime": {},
"createdBy": {
"apiKeyId": "<string>",
"builtinIntegration": [
"BUILTIN_INTEGRATION_UNSPECIFIED",
"BUILTIN_INTEGRATION_GMAIL_V1",
"BUILTIN_INTEGRATION_OUTLOOK_V1",
"BUILTIN_INTEGRATION_LINKEDIN_V1"
],
"userId": "<string>"
},
"deleted": true,
"fields": {},
"formulaErrors": {},
"id": "<string>",
"objectApiName": "<string>",
"objectId": "<string>"
}
]
}{
"code": "CodeNotFound",
"detail": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Records
List
POST
/
okapicrm.v1.OkapiCRMService
/
ListRecords
cURL
curl --request POST \
--url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objectApiName": "<string>",
"objectId": "<string>",
"pageToken": "<string>",
"sortBy": "<string>",
"sortDirection": "<string>"
}
'import requests
url = "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords"
payload = {
"objectApiName": "<string>",
"objectId": "<string>",
"pageToken": "<string>",
"sortBy": "<string>",
"sortDirection": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
objectApiName: '<string>',
objectId: '<string>',
pageToken: '<string>',
sortBy: '<string>',
sortDirection: '<string>'
})
};
fetch('https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords', 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.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'objectApiName' => '<string>',
'objectId' => '<string>',
'pageToken' => '<string>',
'sortBy' => '<string>',
'sortDirection' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords"
payload := strings.NewReader("{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/ListRecords")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"objectApiName\": \"<string>\",\n \"objectId\": \"<string>\",\n \"pageToken\": \"<string>\",\n \"sortBy\": \"<string>\",\n \"sortDirection\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"nextPageToken": "<string>",
"records": [
{
"archived": true,
"createTime": {},
"createdBy": {
"apiKeyId": "<string>",
"builtinIntegration": [
"BUILTIN_INTEGRATION_UNSPECIFIED",
"BUILTIN_INTEGRATION_GMAIL_V1",
"BUILTIN_INTEGRATION_OUTLOOK_V1",
"BUILTIN_INTEGRATION_LINKEDIN_V1"
],
"userId": "<string>"
},
"deleted": true,
"fields": {},
"formulaErrors": {},
"id": "<string>",
"objectApiName": "<string>",
"objectId": "<string>"
}
]
}{
"code": "CodeNotFound",
"detail": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonapplication/proto