Get All Profiles

Get a paginated array of profiles belonging to your account

curl --request GET \
  --url https://vanguard.profilebehavior.com/api/v4/profiles \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://vanguard.profilebehavior.com/api/v4/profiles"

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

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

print(response.text)

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

fetch('https://vanguard.profilebehavior.com/api/v4/profiles', 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://vanguard.profilebehavior.com/api/v4/profiles",
  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://vanguard.profilebehavior.com/api/v4/profiles"

	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://vanguard.profilebehavior.com/api/v4/profiles")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vanguard.profilebehavior.com/api/v4/profiles")

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

{
  "code": 200,
  "profiles": [
    {
      "id": "60e9ca73c500a9001534ad84",
      "createdAt": "2025-09-26T13:49:53.256Z",
      "updatedAt": "2025-09-26T14:37:29.157Z",
      "email": "hello@profilebehavior.com",
      "firstName": "John",
      "lastName": "Doe",
      "disc": {
        "style": "CS",
        "d": 34.66185580566288,
        "i": 19.018670835970415,
        "s": 66.40729193181404,
        "c": 84.98081737824077
      },
      "core": {
        "first": "freedom",
        "second": "wealth",
        "third": "wisdom",
        "fourth": "familyHappiness",
        "fifth": "achievement"
      },
      "focus": {
        "flexibility": {
          "score": 88,
          "level": "veryHigh",
          "facets": {
            "creativity": {
              "score": 100,
              "level": "veryHigh"
            },
            "aestheticAppreciation": {
              "score": 87,
              "level": "veryHigh"
            },
            "emotionalAwareness": {
              "score": 68,
              "level": "high"
            },
            "innovativeness": {
              "score": 75,
              "level": "high"
            },
            "intellectualCuriosity": {
              "score": 100,
              "level": "veryHigh"
            },
            "openMindedness": {
              "score": 100,
              "level": "veryHigh"
            }
          }
        },
        "organization": {
          "score": 78,
          "level": "high",
          "facets": {
            "selfBelief": {
              "score": 87,
              "level": "veryHigh"
            },
            "systemization": {
              "score": 75,
              "level": "high"
            },
            "responsibility": {
              "score": 68,
              "level": "high"
            },
            "goalOriented": {
              "score": 87,
              "level": "veryHigh"
            },
            "discipline": {
              "score": 50,
              "level": "baseline"
            },
            "prudence": {
              "score": 100,
              "level": "veryHigh"
            }
          }
        },
        "communication": {
          "score": 23,
          "level": "low",
          "facets": {
            "friendliness": {
              "score": 6,
              "level": "veryLow"
            },
            "sociability": {
              "score": 0,
              "level": "veryLow"
            },
            "leadership": {
              "score": 37,
              "level": "low"
            },
            "vigor": {
              "score": 37,
              "level": "low"
            },
            "adventureSeeking": {
              "score": 12,
              "level": "veryLow"
            },
            "cheerfulness": {
              "score": 50,
              "level": "baseline"
            }
          }
        },
        "understanding": {
          "score": 46,
          "level": "baseline",
          "facets": {
            "trust": {
              "score": 37,
              "level": "low"
            },
            "integrity": {
              "score": 50,
              "level": "baseline"
            },
            "generosity": {
              "score": 75,
              "level": "high"
            },
            "teamwork": {
              "score": 25,
              "level": "low"
            },
            "humility": {
              "score": 56,
              "level": "baseline"
            },
            "compassion": {
              "score": 37,
              "level": "low"
            }
          }
        },
        "stability": {
          "score": 81,
          "level": "veryHigh",
          "facets": {
            "composure": {
              "score": 68,
              "level": "high"
            },
            "temperance": {
              "score": 93,
              "level": "veryHigh"
            },
            "optimism": {
              "score": 81,
              "level": "veryHigh"
            },
            "confidence": {
              "score": 56,
              "level": "baseline"
            },
            "selfControl": {
              "score": 93,
              "level": "veryHigh"
            },
            "resilience": {
              "score": 93,
              "level": "veryHigh"
            }
          }
        }
      },
      "availableAssessments": [
        "64b935448d1d9b54cb9cb5d5",
        "6047fca80001b34e77245e71",
        "6047fcba0001b34e77245e73"
      ],
      "completedAssessments": [
        "64b935448d1d9b54cb9cb5d5",
        "6047fca80001b34e77245e71",
        "6047fcba0001b34e77245e73"
      ],
      "isCompleted": true,
      "dateStarted": "2025-09-26T13:49:53.255Z",
      "timers": [
        {
          "assessment": "64b935448d1d9b54cb9cb5d5",
          "isCompleted": true,
          "activeSeconds": 522,
          "inactiveSeconds": 49,
          "dateStarted": "2025-09-26T14:18:01.343Z",
          "dateCompleted": "2025-09-26T14:27:25.489Z",
          "lastUpdated": "2025-09-26T14:27:01.890Z"
        },
        {
          "assessment": "6047fca80001b34e77245e71",
          "isCompleted": true,
          "activeSeconds": 318,
          "inactiveSeconds": 43,
          "dateStarted": "2025-09-26T14:27:28.496Z",
          "dateCompleted": "2025-09-26T14:33:27.569Z",
          "lastUpdated": "2025-09-26T14:32:59.021Z"
        },
        {
          "assessment": "6047fcba0001b34e77245e73",
          "isCompleted": true,
          "activeSeconds": 210,
          "inactiveSeconds": 0,
          "dateStarted": "2025-09-26T14:33:30.446Z",
          "dateCompleted": "2025-09-26T14:37:27.650Z",
          "lastUpdated": "2025-09-26T14:37:00.940Z"
        }
      ],
      "dateCompleted": "2025-09-26T14:37:29.157Z"
    }
  ]
}

{
  "code": 400,
  "error": {
    "message": "Invalid request body",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

{
  "code": 401,
  "error": {
    "message": "Invalid token",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

{
  "code": 404,
  "error": {
    "message": "(resource) not found",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

GET

profiles

Get a paginated array of profiles belonging to your account

curl --request GET \
  --url https://vanguard.profilebehavior.com/api/v4/profiles \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://vanguard.profilebehavior.com/api/v4/profiles"

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

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

print(response.text)

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

fetch('https://vanguard.profilebehavior.com/api/v4/profiles', 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://vanguard.profilebehavior.com/api/v4/profiles",
  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://vanguard.profilebehavior.com/api/v4/profiles"

	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://vanguard.profilebehavior.com/api/v4/profiles")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vanguard.profilebehavior.com/api/v4/profiles")

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

{
  "code": 200,
  "profiles": [
    {
      "id": "60e9ca73c500a9001534ad84",
      "createdAt": "2025-09-26T13:49:53.256Z",
      "updatedAt": "2025-09-26T14:37:29.157Z",
      "email": "hello@profilebehavior.com",
      "firstName": "John",
      "lastName": "Doe",
      "disc": {
        "style": "CS",
        "d": 34.66185580566288,
        "i": 19.018670835970415,
        "s": 66.40729193181404,
        "c": 84.98081737824077
      },
      "core": {
        "first": "freedom",
        "second": "wealth",
        "third": "wisdom",
        "fourth": "familyHappiness",
        "fifth": "achievement"
      },
      "focus": {
        "flexibility": {
          "score": 88,
          "level": "veryHigh",
          "facets": {
            "creativity": {
              "score": 100,
              "level": "veryHigh"
            },
            "aestheticAppreciation": {
              "score": 87,
              "level": "veryHigh"
            },
            "emotionalAwareness": {
              "score": 68,
              "level": "high"
            },
            "innovativeness": {
              "score": 75,
              "level": "high"
            },
            "intellectualCuriosity": {
              "score": 100,
              "level": "veryHigh"
            },
            "openMindedness": {
              "score": 100,
              "level": "veryHigh"
            }
          }
        },
        "organization": {
          "score": 78,
          "level": "high",
          "facets": {
            "selfBelief": {
              "score": 87,
              "level": "veryHigh"
            },
            "systemization": {
              "score": 75,
              "level": "high"
            },
            "responsibility": {
              "score": 68,
              "level": "high"
            },
            "goalOriented": {
              "score": 87,
              "level": "veryHigh"
            },
            "discipline": {
              "score": 50,
              "level": "baseline"
            },
            "prudence": {
              "score": 100,
              "level": "veryHigh"
            }
          }
        },
        "communication": {
          "score": 23,
          "level": "low",
          "facets": {
            "friendliness": {
              "score": 6,
              "level": "veryLow"
            },
            "sociability": {
              "score": 0,
              "level": "veryLow"
            },
            "leadership": {
              "score": 37,
              "level": "low"
            },
            "vigor": {
              "score": 37,
              "level": "low"
            },
            "adventureSeeking": {
              "score": 12,
              "level": "veryLow"
            },
            "cheerfulness": {
              "score": 50,
              "level": "baseline"
            }
          }
        },
        "understanding": {
          "score": 46,
          "level": "baseline",
          "facets": {
            "trust": {
              "score": 37,
              "level": "low"
            },
            "integrity": {
              "score": 50,
              "level": "baseline"
            },
            "generosity": {
              "score": 75,
              "level": "high"
            },
            "teamwork": {
              "score": 25,
              "level": "low"
            },
            "humility": {
              "score": 56,
              "level": "baseline"
            },
            "compassion": {
              "score": 37,
              "level": "low"
            }
          }
        },
        "stability": {
          "score": 81,
          "level": "veryHigh",
          "facets": {
            "composure": {
              "score": 68,
              "level": "high"
            },
            "temperance": {
              "score": 93,
              "level": "veryHigh"
            },
            "optimism": {
              "score": 81,
              "level": "veryHigh"
            },
            "confidence": {
              "score": 56,
              "level": "baseline"
            },
            "selfControl": {
              "score": 93,
              "level": "veryHigh"
            },
            "resilience": {
              "score": 93,
              "level": "veryHigh"
            }
          }
        }
      },
      "availableAssessments": [
        "64b935448d1d9b54cb9cb5d5",
        "6047fca80001b34e77245e71",
        "6047fcba0001b34e77245e73"
      ],
      "completedAssessments": [
        "64b935448d1d9b54cb9cb5d5",
        "6047fca80001b34e77245e71",
        "6047fcba0001b34e77245e73"
      ],
      "isCompleted": true,
      "dateStarted": "2025-09-26T13:49:53.255Z",
      "timers": [
        {
          "assessment": "64b935448d1d9b54cb9cb5d5",
          "isCompleted": true,
          "activeSeconds": 522,
          "inactiveSeconds": 49,
          "dateStarted": "2025-09-26T14:18:01.343Z",
          "dateCompleted": "2025-09-26T14:27:25.489Z",
          "lastUpdated": "2025-09-26T14:27:01.890Z"
        },
        {
          "assessment": "6047fca80001b34e77245e71",
          "isCompleted": true,
          "activeSeconds": 318,
          "inactiveSeconds": 43,
          "dateStarted": "2025-09-26T14:27:28.496Z",
          "dateCompleted": "2025-09-26T14:33:27.569Z",
          "lastUpdated": "2025-09-26T14:32:59.021Z"
        },
        {
          "assessment": "6047fcba0001b34e77245e73",
          "isCompleted": true,
          "activeSeconds": 210,
          "inactiveSeconds": 0,
          "dateStarted": "2025-09-26T14:33:30.446Z",
          "dateCompleted": "2025-09-26T14:37:27.650Z",
          "lastUpdated": "2025-09-26T14:37:00.940Z"
        }
      ],
      "dateCompleted": "2025-09-26T14:37:29.157Z"
    }
  ]
}

{
  "code": 400,
  "error": {
    "message": "Invalid request body",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

{
  "code": 401,
  "error": {
    "message": "Invalid token",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

{
  "code": 404,
  "error": {
    "message": "(resource) not found",
    "timestamp": "2025-01-01T09:42:52.329056-05:00"
  },
  "status": "error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

integer

default:10

required

The number of profiles to retrieve per paginated request.

page

integer

default:1

required

The current page of results you are requesting. This indicates how many documents to skip based on the provided limit.

sortProp

enum<string>

default:createdAt

The property to sort profiles by in ascending or descending order

Available options:

createdAt,

name,

_id

sortOrder

enum<string>

default:descending

The desired order to sort a provided property by. This is only applied if a sortProp is explicitly set.

Available options:

ascending,

descending

isCompleted

boolean

A flag that when explicitly set will filter by only completed profiles if true and only in-progress profiles if false. If omitted as a query param it will apply no filtering and simply return all profiles regardless of completion status.

string

Text search for profiles by name, will return a fuzzy search result.

profiles

string[]

A comma separated list of profile IDs to only return those profiles specifically.

includeTags

boolean

default:false

Whether to retrieve tags associated with the profiles and include them as a "tags" field on each profile document.

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code

integer<int32>

required

HTTP status code of the successful response.

status

enum<string>

Always "success" for successful responses.

Available options:

success

profiles

object[]

Show child attributes

Get Profile Get All Pending Profiles

API Documentation

Endpoints

Account

Assessment

Assessment Invite

Fixtures

Playbook AI

Profile

Resource Alias

Tag

Authorizations

Query Parameters

Response