Create Organizations
curl --request POST \
--url https://api.us.lexful.app/v1/organizations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-ID: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"is_primary": true,
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.us.lexful.app/v1/organizations"
payload = {
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"is_primary": True,
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
type: '<string>',
status: '<string>',
is_primary: true,
description: '<string>',
logo_url: '<string>',
website_url: '<string>',
notes: '<string>',
alert: '<string>',
parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.us.lexful.app/v1/organizations', 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.us.lexful.app/v1/organizations",
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>',
'slug' => '<string>',
'type' => '<string>',
'status' => '<string>',
'is_primary' => true,
'description' => '<string>',
'logo_url' => '<string>',
'website_url' => '<string>',
'notes' => '<string>',
'alert' => '<string>',
'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <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.us.lexful.app/v1/organizations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<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.us.lexful.app/v1/organizations")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.lexful.app/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_primary": true,
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"asset_management": "disabled",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}Organizations
Create Organizations
Create organization(s) - supports single or bulk creation (max 100)
POST
/
v1
/
organizations
Create Organizations
curl --request POST \
--url https://api.us.lexful.app/v1/organizations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-ID: <api-key>' \
--data '
{
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"is_primary": true,
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.us.lexful.app/v1/organizations"
payload = {
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"is_primary": True,
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Account-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
type: '<string>',
status: '<string>',
is_primary: true,
description: '<string>',
logo_url: '<string>',
website_url: '<string>',
notes: '<string>',
alert: '<string>',
parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.us.lexful.app/v1/organizations', 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.us.lexful.app/v1/organizations",
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>',
'slug' => '<string>',
'type' => '<string>',
'status' => '<string>',
'is_primary' => true,
'description' => '<string>',
'logo_url' => '<string>',
'website_url' => '<string>',
'notes' => '<string>',
'alert' => '<string>',
'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <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.us.lexful.app/v1/organizations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<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.us.lexful.app/v1/organizations")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.lexful.app/v1/organizations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"type\": \"<string>\",\n \"status\": \"<string>\",\n \"is_primary\": true,\n \"description\": \"<string>\",\n \"logo_url\": \"<string>\",\n \"website_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"alert\": \"<string>\",\n \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_primary": true,
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"status": "<string>",
"description": "<string>",
"logo_url": "<string>",
"website_url": "<string>",
"notes": "<string>",
"alert": "<string>",
"parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"asset_management": "disabled",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}Authorizations
Bearer token
Account ID
Body
application/json
- object
- object[]
Organization name
Required string length:
1 - 255Organization slug (lowercase alphanumeric, underscores, and hyphens only)
Required string length:
1 - 100Pattern:
^[a-z0-9_-]+$Organization type
Organization status
Whether this is the primary organization
Organization description
Organization logo URL
Organization website URL
Internal notes
Alert message
Parent organization ID
Asset management status - controls entity CRUD operations
Available options:
disabled, enabled, read_only Response
Default Response
- Option 1
- Option 2
Organization unique identifier
Whether this is the primary organization
Organization name
Organization slug (URL-friendly identifier)
Organization type
Organization status
Organization description
Organization logo URL
Organization website URL
Internal notes
Alert message for this organization
Parent organization ID
Asset management status - controls entity CRUD operations
Available options:
disabled, enabled, read_only Expanded tags (only present when expand=tags is used)
Show child attributes
Show child attributes
Creation timestamp
Last update timestamp
User ID who created the organization
User ID who last updated the organization
Deletion timestamp
Was this page helpful?