Get Profile

Read a single profile by its UUID, or read the default profile using the alias “default”.

GET /profiles/{profile_id}

Get Profile

cURL

curl --request GET \
  --url https://api.paxos.com/v2/profiles/{profile_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paxos.com/v2/profiles/{profile_id}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/profiles/{profile_id}', 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.paxos.com/v2/profiles/{profile_id}",
  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: Bearer <token>"
  ],
]);

$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.paxos.com/v2/profiles/{profile_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.paxos.com/v2/profiles/{profile_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/profiles/{profile_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "id": "b7b77d82-e6a7-4ae9-9904-36231aedf985",
  "nickname": "MyProfileName",
  "type": "NORMAL"
}

OAuth Scope

funding:read_profile

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

profile_id · string · required

The UUID of the profile, or "default" for the default profile.

Query Parameters

include_deactivated · boolean

Used to include deactivated profiles in the response.

Response

200 - application/json

A successful response.

id · string · required

nickname · string · required

type · enum<string> · required

The profile type.

• NORMAL: A client-created profile. All Profiles created using the CreateProfile endpoint are of this type.
• DEFAULT: A system-generated profile.

Available options: NORMAL, DEFAULT

description · string

account_id · string