Company
Create company view
Create a company view. The view is public and owned by the workspace member identified by creatorEmail.
POST
/
v1
/
companies
/
views
cURL
curl --request POST \
--url https://api.claap.io/v1/companies/views \
--header 'Content-Type: application/json' \
--header 'X-Claap-Key: <api-key>' \
--data '
{
"name": "<string>",
"creatorEmail": "jsmith@example.com",
"columns": [
{
"isHidden": false,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": true
},
"icon": "<string>",
"sort": [
{}
],
"visibility": "Public"
}
'import requests
url = "https://api.claap.io/v1/companies/views"
payload = {
"name": "<string>",
"creatorEmail": "jsmith@example.com",
"columns": [
{
"isHidden": False,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": True
},
"icon": "<string>",
"sort": [{}],
"visibility": "Public"
}
headers = {
"X-Claap-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
creatorEmail: 'jsmith@example.com',
columns: [{isHidden: false, type: 'Default', width: 123}],
filters: {
contactIdIn: [],
contactIdNotIn: [],
dealIdIn: [],
dealIdNotIn: [],
dealStatusIn: [],
dealStatusNotIn: [],
hasInteraction: true
},
icon: '<string>',
sort: [{}],
visibility: 'Public'
})
};
fetch('https://api.claap.io/v1/companies/views', 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.claap.io/v1/companies/views",
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([
'name' => '<string>',
'creatorEmail' => 'jsmith@example.com',
'columns' => [
[
'isHidden' => false,
'type' => 'Default',
'width' => 123
]
],
'filters' => [
'contactIdIn' => [
],
'contactIdNotIn' => [
],
'dealIdIn' => [
],
'dealIdNotIn' => [
],
'dealStatusIn' => [
],
'dealStatusNotIn' => [
],
'hasInteraction' => true
],
'icon' => '<string>',
'sort' => [
[
]
],
'visibility' => 'Public'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Claap-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.claap.io/v1/companies/views"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Claap-Key", "<api-key>")
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.claap.io/v1/companies/views")
.header("X-Claap-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.claap.io/v1/companies/views")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"viewId": "<string>",
"name": "<string>",
"ownerId": "<string>",
"columns": [
{
"columnId": "<string>",
"isHidden": false,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": true
},
"sort": [
{}
],
"icon": "<string>"
}
}Creates a company view.
creatorEmail must belong to an active workspace member, who becomes the view owner. Only public views can be created through the API.Authorizations
Body
application/json
The view name.
Email address of the view creator. It must belong to an active workspace member, who becomes the view owner.
The columns of the companies table. When omitted, the default columns are used.
Show child attributes
Show child attributes
The filters applied by the view. When omitted, the view matches all companies.
Show child attributes
Show child attributes
The view icon.
The sort order of the companies table. When omitted, the default sort order is used.
Show child attributes
Show child attributes
The view visibility. Only Public views can be created through the API.
Available options:
Public Response
200 - application/json
Company view was successfully created
A saved view of the companies table.
Show child attributes
Show child attributes
Previous
Update company viewUpdate a company view. The update is partial: omitted attributes keep their current values.
Next
⌘I
cURL
curl --request POST \
--url https://api.claap.io/v1/companies/views \
--header 'Content-Type: application/json' \
--header 'X-Claap-Key: <api-key>' \
--data '
{
"name": "<string>",
"creatorEmail": "jsmith@example.com",
"columns": [
{
"isHidden": false,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": true
},
"icon": "<string>",
"sort": [
{}
],
"visibility": "Public"
}
'import requests
url = "https://api.claap.io/v1/companies/views"
payload = {
"name": "<string>",
"creatorEmail": "jsmith@example.com",
"columns": [
{
"isHidden": False,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": True
},
"icon": "<string>",
"sort": [{}],
"visibility": "Public"
}
headers = {
"X-Claap-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Claap-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
creatorEmail: 'jsmith@example.com',
columns: [{isHidden: false, type: 'Default', width: 123}],
filters: {
contactIdIn: [],
contactIdNotIn: [],
dealIdIn: [],
dealIdNotIn: [],
dealStatusIn: [],
dealStatusNotIn: [],
hasInteraction: true
},
icon: '<string>',
sort: [{}],
visibility: 'Public'
})
};
fetch('https://api.claap.io/v1/companies/views', 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.claap.io/v1/companies/views",
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([
'name' => '<string>',
'creatorEmail' => 'jsmith@example.com',
'columns' => [
[
'isHidden' => false,
'type' => 'Default',
'width' => 123
]
],
'filters' => [
'contactIdIn' => [
],
'contactIdNotIn' => [
],
'dealIdIn' => [
],
'dealIdNotIn' => [
],
'dealStatusIn' => [
],
'dealStatusNotIn' => [
],
'hasInteraction' => true
],
'icon' => '<string>',
'sort' => [
[
]
],
'visibility' => 'Public'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Claap-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.claap.io/v1/companies/views"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Claap-Key", "<api-key>")
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.claap.io/v1/companies/views")
.header("X-Claap-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.claap.io/v1/companies/views")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Claap-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"creatorEmail\": \"jsmith@example.com\",\n \"columns\": [\n {\n \"isHidden\": false,\n \"type\": \"Default\",\n \"width\": 123\n }\n ],\n \"filters\": {\n \"contactIdIn\": [],\n \"contactIdNotIn\": [],\n \"dealIdIn\": [],\n \"dealIdNotIn\": [],\n \"dealStatusIn\": [],\n \"dealStatusNotIn\": [],\n \"hasInteraction\": true\n },\n \"icon\": \"<string>\",\n \"sort\": [\n {}\n ],\n \"visibility\": \"Public\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"viewId": "<string>",
"name": "<string>",
"ownerId": "<string>",
"columns": [
{
"columnId": "<string>",
"isHidden": false,
"type": "Default",
"width": 123
}
],
"filters": {
"contactIdIn": [],
"contactIdNotIn": [],
"dealIdIn": [],
"dealIdNotIn": [],
"dealStatusIn": [],
"dealStatusNotIn": [],
"hasInteraction": true
},
"sort": [
{}
],
"icon": "<string>"
}
}