create-external-app
curl --request POST \
--url https://api.getmembrane.com/external-apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": [
"<string>"
],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": true,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
}
'import requests
url = "https://api.getmembrane.com/external-apps"
payload = {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": ["<string>"],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": True,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<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({
key: '<string>',
name: '<string>',
appUri: '<string>',
logoUri: '<string>',
categories: ['<string>'],
defaultConnectorId: '<string>',
basePackageId: '<string>',
hasFreeTestAccount: true,
freeTestAccountGuide: '<string>',
freeTestAccountGuideVerifiedAt: '2023-11-07T05:31:56Z',
tenantId: '<string>'
})
};
fetch('https://api.getmembrane.com/external-apps', 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.getmembrane.com/external-apps",
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([
'key' => '<string>',
'name' => '<string>',
'appUri' => '<string>',
'logoUri' => '<string>',
'categories' => [
'<string>'
],
'defaultConnectorId' => '<string>',
'basePackageId' => '<string>',
'hasFreeTestAccount' => true,
'freeTestAccountGuide' => '<string>',
'freeTestAccountGuideVerifiedAt' => '2023-11-07T05:31:56Z',
'tenantId' => '<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.getmembrane.com/external-apps"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<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.getmembrane.com/external-apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/external-apps")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"uuid": "<string>",
"isReadOnly": true,
"isPublic": true
}Apps
create-external-app
Create a new private app. Only use this if list-external-apps found no matching public app.
POST
/
external-apps
create-external-app
curl --request POST \
--url https://api.getmembrane.com/external-apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": [
"<string>"
],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": true,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>"
}
'import requests
url = "https://api.getmembrane.com/external-apps"
payload = {
"key": "<string>",
"name": "<string>",
"appUri": "<string>",
"logoUri": "<string>",
"categories": ["<string>"],
"defaultConnectorId": "<string>",
"basePackageId": "<string>",
"hasFreeTestAccount": True,
"freeTestAccountGuide": "<string>",
"freeTestAccountGuideVerifiedAt": "2023-11-07T05:31:56Z",
"tenantId": "<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({
key: '<string>',
name: '<string>',
appUri: '<string>',
logoUri: '<string>',
categories: ['<string>'],
defaultConnectorId: '<string>',
basePackageId: '<string>',
hasFreeTestAccount: true,
freeTestAccountGuide: '<string>',
freeTestAccountGuideVerifiedAt: '2023-11-07T05:31:56Z',
tenantId: '<string>'
})
};
fetch('https://api.getmembrane.com/external-apps', 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.getmembrane.com/external-apps",
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([
'key' => '<string>',
'name' => '<string>',
'appUri' => '<string>',
'logoUri' => '<string>',
'categories' => [
'<string>'
],
'defaultConnectorId' => '<string>',
'basePackageId' => '<string>',
'hasFreeTestAccount' => true,
'freeTestAccountGuide' => '<string>',
'freeTestAccountGuideVerifiedAt' => '2023-11-07T05:31:56Z',
'tenantId' => '<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.getmembrane.com/external-apps"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<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.getmembrane.com/external-apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmembrane.com/external-apps")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"appUri\": \"<string>\",\n \"logoUri\": \"<string>\",\n \"categories\": [\n \"<string>\"\n ],\n \"defaultConnectorId\": \"<string>\",\n \"basePackageId\": \"<string>\",\n \"hasFreeTestAccount\": true,\n \"freeTestAccountGuide\": \"<string>\",\n \"freeTestAccountGuideVerifiedAt\": \"2023-11-07T05:31:56Z\",\n \"tenantId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"name": "<string>",
"uuid": "<string>",
"isReadOnly": true,
"isPublic": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Machine key (e.g., "attio"). Unique per workspace.
Minimum string length:
1Human-readable app name (e.g., "Attio").
Minimum string length:
1App's main URL (e.g., "https://attio.com").
[INTERNAL] Categorization tags used by the Universe catalog.
[INTERNAL] Connector ID surfaced as the default for this app in the Universe catalog.
[INTERNAL] Base package ID this app is derived from.
[INTERNAL] Whether the app has a free test account.
[INTERNAL] Guide for obtaining a free test account.
[INTERNAL] When the free test account guide was last verified.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$⌘I