Applications (API) | Documentation Accountmaker

Operations related to Applications.

GET/api/accounts/{account_id}/applications

List applications under an account. Returns paginated results.

Responses

200application/json

schemaobject

dataarrayrequired

Represents an application that contains users, OAuth clients, and merchant configurations. Applications form a hierarchy with accounts where types alternate.

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application'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/applications?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/accounts/acc123/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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/applications?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}/applications

Create a new application under an account. Applications contain users, OAuth clients, and merchant configurations.

Body application/json

namestring

avatar_urlstring · uri

Responses

200application/json

schemaobject

dataApplicationrequired

Represents an application that contains users, OAuth clients, and merchant configurations. Applications form a hierarchy with accounts where types alternate.

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application'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/applications" \\
  -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/applications";
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/applications";
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/applications",
  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/applications",
  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/applications", {
  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/applications", \
    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/applications", \
        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/applications", 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/applications")
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/applications", [
  '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/applications");
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());

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

Search applications under an account using Lucene syntax.

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

itemApplicationrequired

Represents an application that contains users, OAuth clients, and merchant configurations. Applications form a hierarchy with accounts where types alternate.

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application'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/accounts/acc123/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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/applications/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());

DELETE/api/applications/{application_id}

Delete an application and all associated data including users, merchants, credentials, and child accounts. This is irreversible. More

Responses

204

Application deleted

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

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

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

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

const url = "${BASE_URL}/api/applications/string";
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/applications/string",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

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

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

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/applications/string", \
    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/applications/string", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/applications/string", 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/string")
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/applications/string", [
  '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/applications/string");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/applications/{application_id}

Get details of a specific application. Applications are the root container for users, credentials, and merchants. More

Responses

200application/json

schemaobject

dataApplicationrequired

Represents an application that contains users, OAuth clients, and merchant configurations. Applications form a hierarchy with accounts where types alternate.

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application's avatar image.

linksobjectrequired

selfstringrequired

URL of the current resource

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

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

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

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

const url = "${BASE_URL}/api/applications/app2ABC123";
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",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2ABC123", {
  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", \
    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", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app2ABC123", 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")
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", [
  '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");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/applications/{application_id}

Update application properties using JSON Merge Patch (RFC 7396). Supports updating name and avatar URL. More

Body application/json

namestring | null

avatar_urlstring · uri | null

Responses

200application/json

schemaobject

dataApplicationrequired

Represents an application that contains users, OAuth clients, and merchant configurations. Applications form a hierarchy with accounts where types alternate.

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application'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

404application/problem+jsonProblemDetails

Not Found

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

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

const payload = "value";
const url = "${BASE_URL}/api/applications/app2ABC123";
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/applications/app2ABC123";
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/applications/app2ABC123",
  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/applications/app2ABC123",
  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/applications/app2ABC123", {
  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/applications/app2ABC123", \
    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/applications/app2ABC123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

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

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/applications/app2ABC123", 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/applications/app2ABC123")
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/applications/app2ABC123", [
  '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/applications/app2ABC123");
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/applications/{application_id}/clients

List all OAuth client applications registered under an application. 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/applications/app123/clients?limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_id}/clients

Register a new OAuth client application for an application. Configure origins, redirect URIs, and token settings. More OAuth

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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_id}/clients/search

Search OAuth clients registered under an application 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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_id}/files

List file metadata for an application 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/applications/app123/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/{application_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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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/applications/app123/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());

GET/api/applications/{application_id}/waitlists

List waitlist rows for an application. More

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

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

const url = "${BASE_URL}/api/applications/app2ABC123/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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/waitlists?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}/waitlists

Create a waitlist row under an application. More

Body application/json

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app2ABC123/waitlists" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}'

const payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists";
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists";
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const { body } = await request("${BASE_URL}/api/applications/app2ABC123/waitlists", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app2ABC123/waitlists", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/applications/app2ABC123/waitlists", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

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

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app2ABC123/waitlists", 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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
uri = URI("${BASE_URL}/api/applications/app2ABC123/waitlists")
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app2ABC123/waitlists", [
  '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/waitlists");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"user_id\":\"uid456\",\"account_id\":\"acc2ABC123\",\"feature_key\":\"gmail_enabled\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/applications/{application_id}/waitlists/{waitlist_id}

Delete a waitlist row under an application. More

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

linksobjectrequired

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

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

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

const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123";
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/applications/app2ABC123/waitlists/wlt123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

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

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", \
    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/applications/app2ABC123/waitlists/wlt123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", 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/waitlists/wlt123")
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/applications/app2ABC123/waitlists/wlt123", [
  '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/applications/app2ABC123/waitlists/wlt123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/applications/{application_id}/waitlists/{waitlist_id}

Get a waitlist row by id under an application. More

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

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

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

const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123";
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/waitlists/wlt123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

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

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", {
  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/waitlists/wlt123", \
    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/waitlists/wlt123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", 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/waitlists/wlt123")
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/waitlists/wlt123", [
  '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/waitlists/wlt123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/applications/{application_id}/waitlists/{waitlist_id}

Patch a waitlist row under an application. More

Body application/json

user_idstring

Unique identifier for a user.

account_idstring

Unique identifier for an account.

feature_keystring

Feature key for the waitlist row.

Responses

200application/json

schemaobject

dataobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

linksobjectrequired

selfstringrequired

URL of the current resource

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}'

const payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123";
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123";
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
const { body } = await request("${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

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

import requests

payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

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

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", 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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"}
uri = URI("${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123")
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 = {"user_id":"uid456","account_id":"acc2ABC123","feature_key":"gmail_enabled"};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/applications/app2ABC123/waitlists/wlt123", [
  '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/applications/app2ABC123/waitlists/wlt123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"user_id\":\"uid456\",\"account_id\":\"acc2ABC123\",\"feature_key\":\"gmail_enabled\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

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

Search waitlist rows using Lucene syntax. More

Body application/json

querystringrequired

limitinteger

offsetinteger

Responses

200application/json

schemaobject

dataarrayrequired

itemobjectrequired

idstringrequired

Unique identifier for a waitlist row.

application_idstringrequired

Unique identifier for an application.

user_idstringrequired

Unique identifier for a user.

account_idstringrequired

Unique identifier for an account.

feature_keystringrequired

Feature key for the waitlist row.

created_atstringrequired

updated_atstringrequired

metaobjectrequired

querystringrequired

totalnumberrequired

limitnumberrequired

offsetnumberrequired

linksobjectrequired

selfstringrequired

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/applications/app2ABC123/waitlists/search" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"query":"string","limit":123,"offset":123}'

const payload = {"query":"string","limit":123,"offset":123};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/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};
const url = "${BASE_URL}/api/applications/app2ABC123/waitlists/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};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists/search",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"query":"string","limit":123,"offset":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/applications/app2ABC123/waitlists/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};
const { body } = await request("${BASE_URL}/api/applications/app2ABC123/waitlists/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}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/applications/app2ABC123/waitlists/search", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

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

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

req, err := http.NewRequest("POST", "${BASE_URL}/api/applications/app2ABC123/waitlists/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}
uri = URI("${BASE_URL}/api/applications/app2ABC123/waitlists/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};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/applications/app2ABC123/waitlists/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/app2ABC123/waitlists/search");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"query\":\"string\",\"limit\":123,\"offset\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Application

idstringrequired

Unique identifier for an application.

parent_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.

namestring | null

Display name for the application.

avatar_urlstring · uri | null

URL to the application'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

FileMultipartAbortResponse

upload_idstringrequired

keystringrequired

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

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Applications

Contents

List Applications

Create Application

Search Account Applications

Delete Application

Get Application

Update Application

List Application Clients

Create Application Client

Search Application Clients

List Application Files

Abort Application Multipart Upload

Complete Application Multipart Upload

Init Application Multipart Upload

Presign Application Multipart Part

Presign Application File Upload

Presign Application File Delete

List Application Waitlists

Create Application Waitlist

Delete Application Waitlist

Get Application Waitlist

Patch Application Waitlist

Search Application Waitlists

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types