curl --request GET \
--url https://api.assembly.com/v1/companies/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/companies/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/companies/{id}', 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.assembly.com/v1/companies/{id}",
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.assembly.com/v1/companies/{id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.assembly.com/v1/companies/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/companies/{id}")
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{
"createdAt": "2024-01-15T09:30:00Z",
"customFields": {},
"deleted": true,
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://portal.example.com/icons/acme.png",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isPlaceholder": false,
"name": "Acme Inc",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Retrieve a company
Retrieves a single company by its ID.
curl --request GET \
--url https://api.assembly.com/v1/companies/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/companies/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/companies/{id}', 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.assembly.com/v1/companies/{id}",
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.assembly.com/v1/companies/{id}"
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))
}HttpResponse<String> response = Unirest.get("https://api.assembly.com/v1/companies/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/companies/{id}")
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{
"createdAt": "2024-01-15T09:30:00Z",
"customFields": {},
"deleted": true,
"fallbackColor": "#4F46E5",
"iconImageUrl": "https://portal.example.com/icons/acme.png",
"id": "550e8400-e29b-41d4-a716-446655440000",
"isPlaceholder": false,
"name": "Acme Inc",
"object": "client",
"updatedAt": "2024-02-20T14:05:00Z"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Path Parameters
Company ID
Response
OK
Created is the RFC 3339 timestamp at which the object was created.
"2024-01-15T09:30:00Z"
CustomFields holds custom field values for the company, keyed by custom field key.
Show child attributes
Show child attributes
Deleted is true when the object has been deleted; present only on delete responses.
true
FallbackColor is the hex color (e.g. "#4F46E5") used as the background when no icon image is set. The native pattern documents intent; the constraint is re-applied to the spec by the enrich-openapi post-processing step.
^#[0-9a-fA-F]{6}$"#4F46E5"
AvatarImageURL is the URL of the company's icon image.
"https://portal.example.com/icons/acme.png"
ID is the unique identifier of the object.
"550e8400-e29b-41d4-a716-446655440000"
IsPlaceholder is true when the company was auto-created as a placeholder. Read-only.
false
Name is the company's display name. Required on create.
"Acme Inc"
Object is the type of the object (e.g. "client", "company").
client, internalUser, company, customField, customFieldOption, file, fileChannel, folder, messageChannel, message, notification Updated is the RFC 3339 timestamp at which the object was last updated.
"2024-02-20T14:05:00Z"