Get a session
curl --request GET \
--url https://api-staging.pixwel.com/api/session \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-staging.pixwel.com/api/session"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-staging.pixwel.com/api/session', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/session"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.pixwel.com/api/session")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"emailNormal": "user@example.com",
"invite": "https://example.com/path/to/object",
"name": "<string>",
"password": "<string>",
"preferences": {
"blacklist": {
"projects": "<unknown>"
},
"mail": {
"enabled": true,
"projects": 123,
"assets": 123,
"files": 123,
"work_requests": 123,
"shares": 123,
"ingest": 123,
"offline_comments": 123,
"others": 123,
"work_request_comments": 123,
"workflow": 123,
"work_request_graphics_materials": 123,
"work_request_graphics_materials_comments": 123
},
"ingest": {
"skipScratchPreview": true,
"maxUploads": 123
},
"contactLists": "<unknown>",
"reports": {
"workRequests": {
"presets": [
{
"name": "<string>",
"columns": [
"<string>"
],
"active": true
}
]
}
}
},
"queue": "<unknown>",
"status": {
"invited": true,
"approved": true,
"registered": true,
"confirmed": true
},
"territory": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"code": "<string>",
"standard": "<string>",
"countries": [
{
"name": "<string>",
"code": "<string>"
}
],
"languages": [
{
"name": "<string>",
"code": "<string>",
"dcpCode": "<string>"
}
],
"assignedLanguages": [
"507f1f77bcf86cd799439011"
]
},
"username": "user@example.com",
"orderQueue": "<unknown>",
"shareQueue": [
"507f1f77bcf86cd799439011"
],
"id": "507f1f77bcf86cd799439011",
"flags": "<unknown>",
"twofactorVerified": true,
"permissions": "<unknown>",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"addresses": [
{
"name": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
],
"name": "<string>",
"studios": "<unknown>",
"type": "<string>",
"users": [
"507f1f77bcf86cd799439011"
]
}
],
"roles": [
"<string>"
],
"studios": "<unknown>",
"$links": {
"self": "//example.com/path/to/object"
},
"hasEnforced2fa": true
}Session
Get a session
GET
/
session
Get a session
curl --request GET \
--url https://api-staging.pixwel.com/api/session \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-staging.pixwel.com/api/session"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-staging.pixwel.com/api/session', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.pixwel.com/api/session",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-staging.pixwel.com/api/session"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-staging.pixwel.com/api/session")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"_id": "507f1f77bcf86cd799439011",
"emailNormal": "user@example.com",
"invite": "https://example.com/path/to/object",
"name": "<string>",
"password": "<string>",
"preferences": {
"blacklist": {
"projects": "<unknown>"
},
"mail": {
"enabled": true,
"projects": 123,
"assets": 123,
"files": 123,
"work_requests": 123,
"shares": 123,
"ingest": 123,
"offline_comments": 123,
"others": 123,
"work_request_comments": 123,
"workflow": 123,
"work_request_graphics_materials": 123,
"work_request_graphics_materials_comments": 123
},
"ingest": {
"skipScratchPreview": true,
"maxUploads": 123
},
"contactLists": "<unknown>",
"reports": {
"workRequests": {
"presets": [
{
"name": "<string>",
"columns": [
"<string>"
],
"active": true
}
]
}
}
},
"queue": "<unknown>",
"status": {
"invited": true,
"approved": true,
"registered": true,
"confirmed": true
},
"territory": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"code": "<string>",
"standard": "<string>",
"countries": [
{
"name": "<string>",
"code": "<string>"
}
],
"languages": [
{
"name": "<string>",
"code": "<string>",
"dcpCode": "<string>"
}
],
"assignedLanguages": [
"507f1f77bcf86cd799439011"
]
},
"username": "user@example.com",
"orderQueue": "<unknown>",
"shareQueue": [
"507f1f77bcf86cd799439011"
],
"id": "507f1f77bcf86cd799439011",
"flags": "<unknown>",
"twofactorVerified": true,
"permissions": "<unknown>",
"groups": [
{
"_id": "507f1f77bcf86cd799439011",
"addresses": [
{
"name": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
}
],
"name": "<string>",
"studios": "<unknown>",
"type": "<string>",
"users": [
"507f1f77bcf86cd799439011"
]
}
],
"roles": [
"<string>"
],
"studios": "<unknown>",
"$links": {
"self": "//example.com/path/to/object"
},
"hasEnforced2fa": true
}Authorizations
BasicAuthBearerAuth
Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.
Response
OK
Example:
"507f1f77bcf86cd799439011"
Example:
"user@example.com"
Example:
"https://example.com/path/to/object"
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"user@example.com"
Shape not inferred — the sampled response had no entries
Example:
"507f1f77bcf86cd799439011"
Shape not inferred — the sampled response had no entries
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
⌘I