Organizations API

Create a partner organization

Requires the organizations:create scope (or an administrator token) and the CreateOrganizations entitlement. Creates an Auth0 organization and emails the recipient an invitation to join it as admin. Parenting records attribution and grants no access.

Each call creates a new organization, including retries after a partial failure. A partner may create a limited number of organizations per rolling 24 hours (500 by default) and receives 429 beyond that. An optional API offer is recorded at signup and the trial starts on the first code connection. Retired or repriced offers fall back to the standard trial at activation.

POST

external

organizations

Create a partner organization

curl --request POST \
  --url https://api.gitar.ai/v1/external/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "offer_code": "<string>"
}
'

import requests

url = "https://api.gitar.ai/v1/external/organizations"

payload = {
    "email": "<string>",
    "offer_code": "<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({email: '<string>', offer_code: '<string>'})
};

fetch('https://api.gitar.ai/v1/external/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.gitar.ai/v1/external/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([
    'email' => '<string>',
    'offer_code' => '<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.gitar.ai/v1/external/organizations"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"offer_code\": \"<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.gitar.ai/v1/external/organizations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"offer_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gitar.ai/v1/external/organizations")

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  \"email\": \"<string>\",\n  \"offer_code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "organization_id": "<string>",
  "organization_name": "<string>",
  "organization_slug": "<string>",
  "parent_organization_id": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

Prerequisites

The creating organization needs the CreateOrganizations entitlement. The API token needs organizations:create or admin scope. API token management also requires GitarAPI access. See Creating an API Token. Use the offer code supplied for the partner integration, or omit offer_code for the standard trial. The trial starts when the new organization connects its first code host. Public signup offer codes are not accepted by this endpoint.

Repeated requests

Each successful request creates a separate organization, even when the email already belongs to a user. Retrying after a timeout or partial failure can create another organization. The recipient receives an email invitation to join the new organization as an administrator. The invitation expires after 30 days. The parent relationship records who created it and grants no access to the creating partner.

Rate limit

A partner can create 500 organizations per rolling 24 hours by default. Further requests return 429 and create nothing. Contact Gitar to raise the limit.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

string

required

offer_code

string | null

Partner API offer code. Omit for the standard trial.

Response

Organization created

organization_id

string

required

organization_name

string

required

organization_slug

string

required

parent_organization_id

string

required

Create a partner organization

curl --request POST \
  --url https://api.gitar.ai/v1/external/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "offer_code": "<string>"
}
'

import requests

url = "https://api.gitar.ai/v1/external/organizations"

payload = {
    "email": "<string>",
    "offer_code": "<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({email: '<string>', offer_code: '<string>'})
};

fetch('https://api.gitar.ai/v1/external/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.gitar.ai/v1/external/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([
    'email' => '<string>',
    'offer_code' => '<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.gitar.ai/v1/external/organizations"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"offer_code\": \"<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.gitar.ai/v1/external/organizations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"offer_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gitar.ai/v1/external/organizations")

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  \"email\": \"<string>\",\n  \"offer_code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "organization_id": "<string>",
  "organization_name": "<string>",
  "organization_slug": "<string>",
  "parent_organization_id": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

{
  "message": "<string>",
  "error_code": "<string>"
}

API Reference

Organizations API

GitLab API

Installation API

Create a partner organization

Prerequisites

Repeated requests

Rate limit

Authorizations

Body

Response

​Prerequisites

​Signup offers

​Repeated requests

​Rate limit

Authorizations

Body

Response

Prerequisites

Signup offers

Repeated requests

Rate limit