Users

Method	Endpoint	Description
GET	`/users`	List users
POST	`/users`	Create user
GET	`/users/{userId}`	Get user
PATCH	`/users/{userId}`	Update user profile
POST	`/users/{userId}/sessions`	Create session token

Parameters

Query

page integer

query

Page number (1-based)

Default: 1

page_size integer

query

Number of results per page

Default: 25

role string

query

Filter by role

Allowed: adminsupportmember

200 Paginated users

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

401 Authentication required

Content-Type: application/json

BASH

curl -X GET "https://api.example.com/users" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/users"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

response = requests.get(url, headers=headers)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users";

const options = {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

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

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('GET', $url, $options);

echo $response->getBody();

Request Body

requiredapplication/json

items array

Items:

items items object

page integer

total integer

201 User created

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

400 Validation failed

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

BASH

curl -X POST "https://api.example.com/users" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com",
  "password": "string",
  "display_name": "string",
  "roles": [
    "admin"
  ],
  "addresses": [
    {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string"
    }
  ]
}'

python

PYTHON

import requests

url = "https://api.example.com/users"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "email": "user@example.com",
    "password": "string",
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "addresses": [
        {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country": "string"
        }
    ]
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users";

const options = {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": "user@example.com",
    "password": "string",
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "addresses": [
        {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country": "string"
        }
    ]
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users"

	body := []byte(`{"email": "user@example.com", "password": "string", "display_name": "string", "roles": ["admin"], "addresses": [{"line1": "string", "line2": "string", "city": "string", "state": "string", "postal_code": "string", "country": "string"}]}`)
	req, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

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

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "email": "user@example.com",\n  "password": "string",\n  "display_name": "string",\n  "roles": [\n    "admin"\n  ],\n  "addresses": [\n    {\n      "line1": "string",\n      "line2": "string",\n      "city": "string",\n      "state": "string",\n      "postal_code": "string",\n      "country": "string"\n    }\n  ]\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['email' => 'user@example.com', 'password' => 'string', 'display_name' => 'string', 'roles' => ['admin'], 'addresses' => [['line1' => 'string', 'line2' => 'string', 'city' => 'string', 'state' => 'string', 'postal_code' => 'string', 'country' => 'string']]],
];

$response = $client->request('POST', $url, $options);

echo $response->getBody();

Parameters

Path

userId string

requiredpath

200 User details

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

404 Resource not found

Content-Type: application/json

BASH

curl -X GET "https://api.example.com/users/id_123" \
  -H "Authorization: Bearer $API_KEY"

python

PYTHON

import requests

url = "https://api.example.com/users/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
}

response = requests.get(url, headers=headers)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users/id_123";

const options = {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
  },
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users/id_123"

	req, err := http.NewRequest("GET", url, nil)
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))

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

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
    ],
];

$response = $client->request('GET', $url, $options);

echo $response->getBody();

Parameters

Path

userId string

requiredpath

Request Body

requiredapplication/json

items array

Items:

items items object

page integer

total integer

200 Updated user

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

400 Validation failed

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

404 Resource not found

Content-Type: application/json

BASH

curl -X PATCH "https://api.example.com/users/id_123" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "string",
  "roles": [
    "admin"
  ],
  "preferences": {}
}'

python

PYTHON

import requests

url = "https://api.example.com/users/id_123"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "preferences": {}
}

response = requests.patch(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users/id_123";

const options = {
  method: "PATCH",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "display_name": "string",
    "roles": [
        "admin"
    ],
    "preferences": {}
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users/id_123"

	body := []byte(`{"display_name": "string", "roles": ["admin"], "preferences": {}}`)
	req, err := http.NewRequest("PATCH", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

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

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users/id_123")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "display_name": "string",\n  "roles": [\n    "admin"\n  ],\n  "preferences": {}\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users/id_123";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['display_name' => 'string', 'roles' => ['admin'], 'preferences' => []],
];

$response = $client->request('PATCH', $url, $options);

echo $response->getBody();

Parameters

Path

userId string

requiredpath

Request Body

requiredapplication/json

items array

Items:

items items object

page integer

total integer

201 Session token issued

Content-Type: application/json

items array

Items:

items items object

page integer

total integer

401 Authentication required

Content-Type: application/json

BASH

curl -X POST "https://api.example.com/users/id_123/sessions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "string",
  "mfa_code": "string"
}'

python

PYTHON

import requests

url = "https://api.example.com/users/id_123/sessions"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "password": "string",
    "mfa_code": "string"
}

response = requests.post(url, headers=headers, json=payload)

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/users/id_123/sessions";

const options = {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "password": "string",
    "mfa_code": "string"
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

go

GO

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	url := "https://api.example.com/users/id_123/sessions"

	body := []byte(`{"password": "string", "mfa_code": "string"}`)
	req, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

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

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/users/id_123/sessions")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "password": "string",\n  "mfa_code": "string"\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/users/id_123/sessions";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['password' => 'string', 'mfa_code' => 'string'],
];

$response = $client->request('POST', $url, $options);

echo $response->getBody();

Endpoints

List users

Parameters

Query

Responses

Create user

Request Body

Responses

Get user

Parameters

Path

Responses

Update user profile

Parameters

Path

Request Body

Responses

Create session token

Parameters

Path

Request Body

Responses

Endpoints

Parameters

Filter Query

Parameters

Link Path

Parameters

Link Path

Parameters

Link Path

Query

Path

Path

Path