Accounts (API) | Accountmaker 文档

Account management for users and organizations

DELETE/api/accounts/{account_id}

Permanently delete an account and all associated data. Requires owner permissions. This action cannot be undone. More Applications

Responses

200application/json

schemaobject

dataAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/accounts/acc2ABC123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc2ABC123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc2ABC123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc2ABC123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc2ABC123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/accounts/acc2ABC123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/accounts/acc2ABC123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/accounts/acc2ABC123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc2ABC123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/accounts/acc2ABC123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/accounts/acc2ABC123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}

Retrieve an account by its ID. Returns the account’s status, billing info, and hierarchy position. More Applications

Responses

200application/json

schemaobject

dataAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/accounts/{account_id}

Update account properties using JSON Merge Patch (RFC 7396). Supports updating name, avatar, status, and billing dates. More Applications

Body application/json

namestring | null

avatar_urlstring · uri | null

Responses

200application/json

schemaobject

dataAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/accounts/acc2ABC123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/accounts/acc2ABC123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/accounts/acc2ABC123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/accounts/acc2ABC123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/accounts/acc2ABC123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/accounts/acc2ABC123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/accounts/acc2ABC123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/accounts/acc2ABC123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/accounts/acc2ABC123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/accounts/acc2ABC123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/accounts/acc2ABC123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/accounts

List child accounts under a parent account. Returns paginated results for nested account hierarchies. More Applications

Responses

200application/json

schemaobject

dataarrayrequired

itemAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/accounts

Create a new child account under a parent account. Used for nested account hierarchies where organizations manage sub-organizations. More Applications

Body application/json

namestring

avatar_urlstring · uri

Responses

200application/json

schemaobject

dataAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/accounts" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"name":"string","avatar_url":"string"}'

const payload = {"name":"string","avatar_url":"string"};
const url = "${BASE_URL}/api/accounts/acc123/accounts";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"name":"string","avatar_url":"string"};
const url = "${BASE_URL}/api/accounts/acc123/accounts";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"name":"string","avatar_url":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/accounts",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"name":"string","avatar_url":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/accounts",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"name":"string","avatar_url":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/accounts", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"name":"string","avatar_url":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/accounts", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"name":"string","avatar_url":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/accounts", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"name":"string","avatar_url":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/accounts", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"name":"string","avatar_url":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/accounts")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"name":"string","avatar_url":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/accounts", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/accounts");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"name\":\"string\",\"avatar_url\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/clients

List all OAuth client applications registered under an account. Returns client configurations including origins and redirect URIs. More OAuth

Responses

200application/json

schemaobject

dataarrayrequired

itemClientrequired

A client application that can authenticate users and request tokens. Clients define allowed origins, redirect URIs, and token configurations for OAuth flows.

idstringrequired

Unique identifier for a client application.

resource_idstringrequired

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

hostnamestring | nullrequired

Optional hostname that maps requests to this client when client_id is omitted.

issuerstringrequired

audiencestringrequired

allowed_originsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

allowed_scopestring | nullrequired

default_scopestringrequired

redirect_urisarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

seamless_sign_inbooleanrequired

login_enabledbooleanrequired

register_enabledbooleanrequired

csrf_requiredbooleanrequired

email_provider_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

access_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for access tokens issued by this client. Access tokens are short-lived and authorize API requests on behalf of the user.

refresh_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for refresh tokens issued by this client. Refresh tokens are long-lived and allow obtaining new access tokens without re-authentication.

id_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for ID tokens issued by this client. ID tokens are JWTs containing user claims like email and name for client-side personalization.

external_jwks_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

saml_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

rate_limit_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for rate limiting client requests. Higher limits may be useful for testing environments.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/clients

Body application/json

idstring

Unique identifier for a client application.

issuerstring

audiencestring

allowed_originsarray

itemstringrequired

allowed_scopestring | null

default_scopestring

redirect_urisarray

itemstringrequired

seamless_sign_inboolean

login_enabledboolean

register_enabledboolean

csrf_requiredboolean

email_provider_configobject | null

providerrequired

mock_inbox_idstringrequired

access_token_configobject | null

Configuration for access tokens issued by this client. Access tokens are short-lived and authorize API requests on behalf of the user.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

refresh_token_configobject | null

Configuration for refresh tokens issued by this client. Refresh tokens are long-lived and allow obtaining new access tokens without re-authentication.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

id_token_configobject | null

Configuration for ID tokens issued by this client. ID tokens are JWTs containing user claims like email and name for client-side personalization.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

external_jwks_configobject | null

jwks_urlstring

public_keysarray

itemstringrequired

saml_configobject | null

saml_metadata_urlstring

public_keysarray

itemstringrequired

expected_issuerstring

rate_limit_configobject | null

Configuration for rate limiting client requests. Higher limits may be useful for testing environments.

login_maxinteger

auth_maxinteger

unauth_maxinteger

hostnamestring | null

Optional hostname that maps requests to this client when client_id is omitted.

Responses

200application/json

schemaobject

dataallOfrequired

Variant

A client application that can authenticate users and request tokens. Clients define allowed origins, redirect URIs, and token configurations for OAuth flows.

ClientClient

A client application that can authenticate users and request tokens. Clients define allowed origins, redirect URIs, and token configurations for OAuth flows.

idstringrequired

Unique identifier for a client application.

resource_idstringrequired

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

hostnamestring | nullrequired

Optional hostname that maps requests to this client when client_id is omitted.

issuerstringrequired

audiencestringrequired

allowed_originsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

allowed_scopestring | nullrequired

default_scopestringrequired

redirect_urisarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

seamless_sign_inbooleanrequired

login_enabledbooleanrequired

register_enabledbooleanrequired

csrf_requiredbooleanrequired

email_provider_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

access_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for access tokens issued by this client. Access tokens are short-lived and authorize API requests on behalf of the user.

refresh_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for refresh tokens issued by this client. Refresh tokens are long-lived and allow obtaining new access tokens without re-authentication.

id_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for ID tokens issued by this client. ID tokens are JWTs containing user claims like email and name for client-side personalization.

external_jwks_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

saml_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

rate_limit_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for rate limiting client requests. Higher limits may be useful for testing environments.

Option 2object

secret_valuesarray

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/clients?secret_value=new" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"issuer":"my-admin-client"}'

const payload = {"issuer":"my-admin-client"};
const url = "${BASE_URL}/api/accounts/acc123/clients?secret_value=new";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"issuer":"my-admin-client"};
const url = "${BASE_URL}/api/accounts/acc123/clients?secret_value=new";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"issuer":"my-admin-client"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/clients?secret_value=new",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"issuer":"my-admin-client"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/clients?secret_value=new",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"issuer":"my-admin-client"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/clients?secret_value=new", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"issuer":"my-admin-client"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/clients?secret_value=new", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"issuer":"my-admin-client"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/clients?secret_value=new", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"issuer":"my-admin-client"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/clients?secret_value=new", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"issuer":"my-admin-client"}
uri = URI("${BASE_URL}/api/accounts/acc123/clients?secret_value=new")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"issuer":"my-admin-client"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/clients?secret_value=new", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/clients?secret_value=new");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"issuer\":\"my-admin-client\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/clients/search

Search OAuth clients registered under an account using Lucene syntax. More OAuth

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (id:, issuer:, audience:, hostname:, allowed_scope:, default_scope:), wildcards (*), and boolean operators (AND, OR).

limitinteger

offsetinteger

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemClientrequired

A client application that can authenticate users and request tokens. Clients define allowed origins, redirect URIs, and token configurations for OAuth flows.

idstringrequired

Unique identifier for a client application.

resource_idstringrequired

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

hostnamestring | nullrequired

Optional hostname that maps requests to this client when client_id is omitted.

issuerstringrequired

audiencestringrequired

allowed_originsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

allowed_scopestring | nullrequired

default_scopestringrequired

redirect_urisarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

seamless_sign_inbooleanrequired

login_enabledbooleanrequired

register_enabledbooleanrequired

csrf_requiredbooleanrequired

email_provider_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

access_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for access tokens issued by this client. Access tokens are short-lived and authorize API requests on behalf of the user.

refresh_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for refresh tokens issued by this client. Refresh tokens are long-lived and allow obtaining new access tokens without re-authentication.

id_token_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for ID tokens issued by this client. ID tokens are JWTs containing user claims like email and name for client-side personalization.

external_jwks_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

saml_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

rate_limit_configobject | nullrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Configuration for rate limiting client requests. Higher limits may be useful for testing environments.

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/clients/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/clients/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/accounts/acc123/clients/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/clients/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/clients/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/clients/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/clients/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/clients/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/clients/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/accounts/acc123/clients/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/clients/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/clients/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/files

List file metadata for an account by prefix.

Responses

200application/json

schemaobject

dataarrayrequired

itemS3FileMetadatarequired

Metadata for a file stored in object storage.

keystringrequired

pathstringrequired

size_bytesnumberrequired

etagstring | nullrequired

last_modifiedstring · date-timerequired

storage_classstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/multipart/abort

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

Responses

200application/json

schemaobject

dataFileMultipartAbortResponserequired

Multipart upload abort response.

upload_idstringrequired

keystringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/multipart/abort" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string"}'

const payload = {"path":"string","upload_id":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/abort";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/abort";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/abort",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/abort",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/multipart/abort", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/multipart/abort", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/multipart/abort", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/abort", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/files/multipart/abort")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/abort", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/multipart/abort");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/multipart/complete

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

partsarrayrequired

itemobjectrequired

part_numberintegerrequired

etagstringrequired

Responses

200application/json

schemaobject

dataS3FileMultipartCompleteResponserequired

Multipart upload completion response.

upload_idstringrequired

keystringrequired

etagstring

locationstring

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/multipart/complete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}'

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/complete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/complete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/complete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/complete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/multipart/complete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/multipart/complete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/multipart/complete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/complete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
uri = URI("${BASE_URL}/api/accounts/acc123/files/multipart/complete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/complete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/multipart/complete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\",\"parts\":[{\"part_number\":123,\"etag\":\"string\"}]}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/multipart/init

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

content_typestring

Responses

200application/json

schemaobject

dataS3FileMultipartInitResponserequired

Multipart upload initialization response.

upload_idstringrequired

keystringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/multipart/init" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","content_type":"string"}'

const payload = {"path":"string","content_type":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/init";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","content_type":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/init";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","content_type":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/init",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","content_type":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/init",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","content_type":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/multipart/init", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","content_type":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/multipart/init", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","content_type":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/multipart/init", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","content_type":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/init", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","content_type":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/files/multipart/init")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","content_type":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/init", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/multipart/init");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"content_type\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/multipart/part

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

part_numberintegerrequired

content_lengthintegerrequired

content_typestring

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/multipart/part" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}'

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/part";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/multipart/part";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/part",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/multipart/part",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/multipart/part", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/multipart/part", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/multipart/part", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/part", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/files/multipart/part")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/multipart/part", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/multipart/part");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\",\"part_number\":123,\"content_length\":123,\"content_type\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/presign

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

content_typestringrequired

content_lengthintegerrequired

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/presign" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","content_type":"string","content_length":123}'

const payload = {"path":"string","content_type":"string","content_length":123};
const url = "${BASE_URL}/api/accounts/acc123/files/presign";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","content_type":"string","content_length":123};
const url = "${BASE_URL}/api/accounts/acc123/files/presign";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","content_type":"string","content_length":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/presign",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","content_type":"string","content_length":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/presign",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","content_type":"string","content_length":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/presign", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","content_type":"string","content_length":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/presign", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","content_type":"string","content_length":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/presign", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","content_type":"string","content_length":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/presign", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","content_type":"string","content_length":123}
uri = URI("${BASE_URL}/api/accounts/acc123/files/presign")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","content_type":"string","content_length":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/presign", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/presign");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"content_type\":\"string\",\"content_length\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/files/presign/delete

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/files/presign/delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string"}'

const payload = {"path":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/presign/delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string"};
const url = "${BASE_URL}/api/accounts/acc123/files/presign/delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/presign/delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/files/presign/delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/files/presign/delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/files/presign/delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/files/presign/delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/files/presign/delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/files/presign/delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/files/presign/delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/files/presign/delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/invite

Send an invitation to join an existing account.

Creates a pending invitation
Send email via system
Supports role-based access (admin/member/viewer)

Invitations eventually expire. Users accept via email link or manually entered URL.

Body application/json

csrf_tokenstring

emailEmailAddressrequired

A valid, normalized email address.

rolerequired

Responses

200application/json

schemaobject

dataobjectrequired

invite_tokenstringrequired

expires_innumberrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc2ABC123/invite" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"csrf_token":"string","email":"value","role":"owner"}'

const payload = {"csrf_token":"string","email":"value","role":"owner"};
const url = "${BASE_URL}/api/accounts/acc2ABC123/invite";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"csrf_token":"string","email":"value","role":"owner"};
const url = "${BASE_URL}/api/accounts/acc2ABC123/invite";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"csrf_token":"string","email":"value","role":"owner"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc2ABC123/invite",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"csrf_token":"string","email":"value","role":"owner"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc2ABC123/invite",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"csrf_token":"string","email":"value","role":"owner"};
const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/invite", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"csrf_token":"string","email":"value","role":"owner"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc2ABC123/invite", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"csrf_token":"string","email":"value","role":"owner"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc2ABC123/invite", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"csrf_token":"string","email":"value","role":"owner"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc2ABC123/invite", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"csrf_token":"string","email":"value","role":"owner"}
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/invite")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"csrf_token":"string","email":"value","role":"owner"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc2ABC123/invite", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc2ABC123/invite");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"csrf_token\":\"string\",\"email\":\"value\",\"role\":\"owner\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/invoices

List all invoices within an account. Returns invoice history including amounts, status, and external references. Subscriptions

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

idstringrequired

Unique identifier for an invoice.

account_idstringrequired

Unique identifier for an account.

statusrequired

currencystringrequired

subtotal_centsintegerrequired

tax_centsintegerrequired

total_centsintegerrequired

period_startstring | nullrequired

period_endstring | nullrequired

issued_atstringrequired

due_atstring | nullrequired

paid_atstring | nullrequired

closed_atstring | nullrequired

external_idstring | nullrequired

external_customer_idstring | nullrequired

external_datarequired

hosted_invoice_urlstring | nullrequired

pdf_urlstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc2ABC123/invoices?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/invoices/search-delete

Delete invoices matching a Lucene-style query. Use dry_run=true to preview what would be deleted.

Supported fields:

external_id: - Search provider invoice ID (e.g., Stripe invoice)
external_customer_id: - Search provider customer ID
status: - Filter by status (draft, open, paid, void, uncollectible)
currency: - Filter by currency (e.g., usd)

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., external_id:in_*)

Safety:

Use dry_run: true first to verify the query matches expected invoices
The limit parameter caps deletions (default 100)

Subscriptions

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (external_id:, external_customer_id:, status:, currency:), wildcards (*), and boolean operators (AND, OR). Example: 'external_id:in_* AND status:paid'

dry_runboolean

If true, returns count of invoices that would be deleted without actually deleting

limitinteger

Maximum number of invoices to delete (default: 100, max: 10000). Use with caution.

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countnumberrequired

deleted_idsarrayrequired

itemstringrequired

Unique identifier for an invoice.

dry_runbooleanrequired

metaobjectrequired

querystringrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/invoices/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"limit":123}'

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/invoices/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/invoices/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/invoices/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"limit":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/invoices/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"limit":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/invoices/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"limit":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/invoices/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"limit":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/invoices/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"limit":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/invoices/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"limit":123}
uri = URI("${BASE_URL}/api/accounts/acc123/invoices/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"limit":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/invoices/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/invoices/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"limit\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/members

List all users who are members of an account with their roles. Returns paginated results including user profiles and email credentials. More Applications

Responses

200application/json

schemaobject

dataarrayrequired

itemallOfrequired

Variant

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

MembershipMembership

Nested fields truncated. Expand to continue inline, or use the model link.

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc123/members?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/members

Add an existing user as a member of an account with a specified role. Use for granting access to shared accounts. More Applications

Body application/json

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

Responses

200application/json

schemaobject

dataMembershiprequired

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/members" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"account_id":"acc2ABC123","user_id":"uid456","role":"owner"}'

const payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
const url = "${BASE_URL}/api/accounts/acc123/members";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
const url = "${BASE_URL}/api/accounts/acc123/members";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/members",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/members",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/members", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/members", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/members", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"account_id":"acc2ABC123","user_id":"uid456","role":"owner"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/members", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"}
uri = URI("${BASE_URL}/api/accounts/acc123/members")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"account_id":"acc2ABC123","user_id":"uid456","role":"owner"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/members", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/members");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"account_id\":\"acc2ABC123\",\"user_id\":\"uid456\",\"role\":\"owner\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/accounts/{account_id}/members/{member_id}

Remove a user’s membership from an account. The user remains in the system but loses access to this account. More Applications

Responses

200application/json

schemaobject

dataMembershiprequired

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

linksobjectrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/members/{member_id}

Retrieve a specific member’s details within an account, including their role and profile. More Applications

Responses

200application/json

schemaobject

dataMembershiprequired

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/accounts/{account_id}/members/{member_id}

Update a member’s role within an account. Roles control access levels: owner, member, or viewer. More Applications

Body application/json

rolerequired

Responses

200application/json

schemaobject

dataobjectrequired

rolerequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"role":"owner"}'

const payload = {"role":"owner"};
const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"role":"owner"};
const url = "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"role":"owner"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"role":"owner"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"role":"owner"};
const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"role":"owner"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"role":"owner"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"role":"owner"}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"role":"owner"}
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/members/mbr123")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"role":"owner"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/accounts/acc2ABC123/members/mbr123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"role\":\"owner\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/accounts/{account_id}/payments

List all payments within an account. Returns payment history including amounts, statuses, and associated metadata. More Subscriptions

Responses

200application/json

schemaobject

dataarrayrequired

itemPaymentrequired

A payment record tracking a monetary transaction for an account. Includes amount, currency, status, and external payment provider references.

idstringrequired

Unique identifier for a payment.

account_idstringrequired

Unique identifier for an account.

amount_centsnumberrequired

currencystringrequired

statusrequired

paid_atstring | nullrequired

payment_methodstring | nullrequired

external_idstring | nullrequired

external_customer_idstring | nullrequired

external_datarequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/accounts/acc2ABC123/payments?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/payments

Create a new payment record for an account. Used for manual payment tracking or integrations with external payment systems. More Subscriptions

Body application/json

bodyobject

Responses

200application/json

schemaobject

dataPaymentrequired

A payment record tracking a monetary transaction for an account. Includes amount, currency, status, and external payment provider references.

idstringrequired

Unique identifier for a payment.

account_idstringrequired

Unique identifier for an account.

amount_centsnumberrequired

currencystringrequired

statusrequired

paid_atstring | nullrequired

payment_methodstring | nullrequired

external_idstring | nullrequired

external_customer_idstring | nullrequired

external_datarequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/payments" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{}'

const payload = {};
const url = "${BASE_URL}/api/accounts/acc123/payments";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {};
const url = "${BASE_URL}/api/accounts/acc123/payments";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/payments",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/payments",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {};
const { body } = await request("${BASE_URL}/api/accounts/acc123/payments", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/payments", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/payments", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/payments", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {}
uri = URI("${BASE_URL}/api/accounts/acc123/payments")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/payments", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/payments");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/payments/search-delete

Delete payments matching a Lucene-style query. Use dry_run=true to preview what would be deleted.

Supported fields:

external_id: - Search provider payment ID (e.g., Stripe charge/payment intent)
external_customer_id: - Search provider customer ID
status: - Filter by status (pending, succeeded, failed, canceled, refunded)
currency: - Filter by currency (e.g., usd)
payment_method: - Filter by payment method (card, ach, etc.)

Operators:

AND - Both conditions must match
OR - Either condition must match
* - Wildcard (e.g., external_id:ch_*)

Safety:

Use dry_run: true first to verify the query matches expected payments
The limit parameter caps deletions (default 100)

More Subscriptions

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (external_id:, external_customer_id:, status:, currency:, payment_method:), wildcards (*), and boolean operators (AND, OR). Example: 'external_id:ch_* AND status:failed'

dry_runboolean

If true, returns count of payments that would be deleted without actually deleting

limitinteger

Maximum number of payments to delete (default: 100, max: 10000). Use with caution.

Responses

200application/json

schemaobject

dataobjectrequired

deleted_countnumberrequired

deleted_idsarrayrequired

itemstringrequired

Unique identifier for a payment.

dry_runbooleanrequired

metaobjectrequired

querystringrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/payments/search-delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","dry_run":true,"limit":123}'

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/payments/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const url = "${BASE_URL}/api/accounts/acc123/payments/search-delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","dry_run":true,"limit":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/payments/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","dry_run":true,"limit":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/payments/search-delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","dry_run":true,"limit":123};
const { body } = await request("${BASE_URL}/api/accounts/acc123/payments/search-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","dry_run":true,"limit":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/payments/search-delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","dry_run":true,"limit":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/payments/search-delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","dry_run":true,"limit":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/payments/search-delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","dry_run":true,"limit":123}
uri = URI("${BASE_URL}/api/accounts/acc123/payments/search-delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","dry_run":true,"limit":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/payments/search-delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/payments/search-delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"dry_run\":true,\"limit\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/accounts/{account_id}/token

Issue an access_token that is scoped to a single account.

Most services in a system should not know about tenants, subaccounts, or membership graphs. Those services only need a simple token with a user id (uid) and an account id (acc) so that local authorization logic can run.

Use this endpoint after login to derive an access token for one specific account that the current user belongs to. The returned access_token:

sets acc to the requested account_id
sets role to the user’s role in that account (for example: owner or member)
keeps or overrides aud and scope based on the request body

Downstream services (email, file storage, billing, etc.) can then:

validate the token using the client’s public keys at /.well-known/jwks.json?client_id={client_id}, and
apply local rules based only on uid, acc, role, aud, and scope.

This endpoint does not return or set any cookies, and does not issue a refresh_token. The original login access_token and refresh_token should be kept and used to call this endpoint again whenever a new account-scoped access_token is needed.

Body application/json

scopestring

audiencestring

Responses

200application/json

schemaobject

access_tokenstringrequired

token_typerequired

expires_innumberrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/accounts/acc123/token" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"scope":"string","audience":"string"}'

const payload = {"scope":"string","audience":"string"};
const url = "${BASE_URL}/api/accounts/acc123/token";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"scope":"string","audience":"string"};
const url = "${BASE_URL}/api/accounts/acc123/token";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"scope":"string","audience":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/token",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"scope":"string","audience":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/accounts/acc123/token",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"scope":"string","audience":"string"};
const { body } = await request("${BASE_URL}/api/accounts/acc123/token", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"scope":"string","audience":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/accounts/acc123/token", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"scope":"string","audience":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/accounts/acc123/token", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"scope":"string","audience":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/accounts/acc123/token", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"scope":"string","audience":"string"}
uri = URI("${BASE_URL}/api/accounts/acc123/token")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"scope":"string","audience":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/accounts/acc123/token", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/accounts/acc123/token");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"scope\":\"string\",\"audience\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/applications/{application_id}/accounts

List accounts created under an application. Returns paginated results. More Applications

Responses

200application/json

schemaobject

dataarrayrequired

itemAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/applications/app2ABC123/accounts?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/accounts/search

Search accounts created under an application using Lucene syntax. More

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (id:, name:), wildcards (*), and boolean operators (AND, OR).

limitinteger

offsetinteger

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemAccountrequired

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app123/accounts/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/accounts/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/accounts/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/accounts/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/accounts/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/applications/app123/accounts/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app123/accounts/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app123/accounts/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app123/accounts/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/applications/app123/accounts/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app123/accounts/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app123/accounts/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/register

Create a new account under an application, with an initial owner user.

This endpoint is used to:

Register a new paid account (e.g., a customer, tenant, or organization)
Automatically create its first admin user with email/password

Use cases:

SaaS platforms onboarding new customers
Agencies creating client accounts
Multi-tenant systems provisioning tenants

If no password is provided, the user must set one later (e.g., via magic link).

Body application/json

csrf_tokenstring

emailEmailAddressrequired

A valid, normalized email address.

passwordstring

preferred_languagestring

localestring

timezonestring

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

credentialsarrayrequired

itemEmailCredentialrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.

membershipsarrayrequired

itemallOfrequired

Variant

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

MembershipMembership

Nested fields truncated. Expand to continue inline, or use the model link.

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app2ABC123/register" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"}'

const payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
const url = "${BASE_URL}/api/applications/app2ABC123/register";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
const url = "${BASE_URL}/api/applications/app2ABC123/register";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/register",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/register",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
const { body } = await request("${BASE_URL}/api/applications/app2ABC123/register", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app2ABC123/register", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app2ABC123/register", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app2ABC123/register", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"}
uri = URI("${BASE_URL}/api/applications/app2ABC123/register")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"csrf_token":"string","email":"value","password":"string","preferred_language":"string","locale":"string","timezone":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app2ABC123/register", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app2ABC123/register");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"csrf_token\":\"string\",\"email\":\"value\",\"password\":\"string\",\"preferred_language\":\"string\",\"locale\":\"string\",\"timezone\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/applications/{application_id}/users

List all users belonging to an application. Returns paginated results with user profiles. More Applications

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

identityUserIdentity | nullUserIdentityrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

credentialsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/applications/app2ABC123/users?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/users

Create a new user within an application. Used for backend provisioning of users without self-registration. More Applications

Body application/json

avatar_urlstring · uri

external_idstring

status

given_namestring

family_namestring

display_namestring

preferred_languagestring

localestring

timezonestring

preferred_account_idstring | null

Unique identifier for an account.

Responses

200application/json

schemaobject

dataUserrequired

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app2ABC123/users" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"}'

const payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
const url = "${BASE_URL}/api/applications/app2ABC123/users";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
const url = "${BASE_URL}/api/applications/app2ABC123/users";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/users",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/users",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
const { body } = await request("${BASE_URL}/api/applications/app2ABC123/users", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app2ABC123/users", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app2ABC123/users", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app2ABC123/users", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"}
uri = URI("${BASE_URL}/api/applications/app2ABC123/users")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"avatar_url":"string","external_id":"string","status":"active","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string","preferred_account_id":"value"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app2ABC123/users", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app2ABC123/users");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"avatar_url\":\"string\",\"external_id\":\"string\",\"status\":\"active\",\"given_name\":\"string\",\"family_name\":\"string\",\"display_name\":\"string\",\"preferred_language\":\"string\",\"locale\":\"string\",\"timezone\":\"string\",\"preferred_account_id\":\"value\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/applications/{application_id}/users/search

Search users under an application using Lucene syntax. More

Body application/json

querystringrequired

Lucene-style search query. Supports field:value syntax (id:, status:, external_id:, given_name:, family_name:, display_name:), wildcards (*), and boolean operators (AND, OR).

limitinteger

offsetinteger

sort

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

identityUserIdentity | nullUserIdentityrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

credentialsarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

sortrequired

linksobjectrequired

selfstringrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app123/users/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}'

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/users/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const url = "${BASE_URL}/api/applications/app123/users/search";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/users/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app123/users/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
const { body } = await request("${BASE_URL}/api/applications/app123/users/search", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app123/users/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app123/users/search", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app123/users/search", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"}
uri = URI("${BASE_URL}/api/applications/app123/users/search")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"query":"string","limit":123,"offset":123,"sort":"created_at:desc,id:asc"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app123/users/search", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/applications/app123/users/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123,\"sort\":\"created_at:desc,id:asc\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Account

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

Client

idstringrequired

Unique identifier for a client application.

resource_idstringrequired

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

hostnamestring | nullrequired

Optional hostname that maps requests to this client when client_id is omitted.

issuerstringrequired

audiencestringrequired

allowed_originsarrayrequired

itemstringrequired

allowed_scopestring | nullrequired

default_scopestringrequired

redirect_urisarrayrequired

itemstringrequired

seamless_sign_inbooleanrequired

login_enabledbooleanrequired

register_enabledbooleanrequired

csrf_requiredbooleanrequired

email_provider_configobject | nullrequired

providerrequired

mock_inbox_idstringrequired

access_token_configobject | nullrequired

Configuration for access tokens issued by this client. Access tokens are short-lived and authorize API requests on behalf of the user.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

refresh_token_configobject | nullrequired

Configuration for refresh tokens issued by this client. Refresh tokens are long-lived and allow obtaining new access tokens without re-authentication.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

id_token_configobject | nullrequired

Configuration for ID tokens issued by this client. ID tokens are JWTs containing user claims like email and name for client-side personalization.

expires_innumber

cookie_optionsobject

namestringrequired

http_onlyboolean

secureboolean

same_site

max_ageintegerrequired

pathstring

external_jwks_configobject | nullrequired

jwks_urlstring

public_keysarray

itemstringrequired

saml_configobject | nullrequired

saml_metadata_urlstring

public_keysarray

itemstringrequired

expected_issuerstring

rate_limit_configobject | nullrequired

Configuration for rate limiting client requests. Higher limits may be useful for testing environments.

login_maxinteger

auth_maxinteger

unauth_maxinteger

EmailAddress

string · email

A valid, normalized email address.

EmailCredential

idstringrequired

user_idstringrequired

Unique identifier for a user.

emailEmailAddress | nullEmailAddress

A valid, normalized email address.

hashed_emailstring | null

email_verified_atstring | null

FileMultipartAbortResponse

upload_idstringrequired

keystringrequired

Membership

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

Payment

idstringrequired

Unique identifier for a payment.

account_idstringrequired

Unique identifier for an account.

amount_centsnumberrequired

currencystringrequired

statusrequired

paid_atstring | nullrequired

payment_methodstring | nullrequired

external_idstring | nullrequired

external_customer_idstring | nullrequired

external_datarequired

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

S3FileMetadata

keystringrequired

pathstringrequired

size_bytesnumberrequired

etagstring | nullrequired

last_modifiedstring · date-timerequired

storage_classstring | nullrequired

S3FileMultipartCompleteResponse

upload_idstringrequired

keystringrequired

etagstring

locationstring

S3FileMultipartInitResponse

upload_idstringrequired

keystringrequired

S3FilePresignResponse

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

User

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

UserIdentity

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Accounts

Contents

Delete Account

Get Account

Update Account

List Accounts

Create Account

List Account Clients

Create Account Client

Search Account Clients

List Account Files

Abort Account Multipart Upload

Complete Account Multipart Upload

Init Account Multipart Upload

Presign Account Multipart Part

Presign Account File Upload

Presign Account File Delete

Invite

List Account Invoices

Search and Delete Invoices

List Account Members

Add Account Member

Remove Member

Get Member

Update Member

List Account Payments

Create Account Payment

Search and Delete Payments

Token

List Application Accounts

Search Application Accounts

Register

List Application Users

Create Application User

Search Application Users

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types