Skip to main content
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>'
{
  "code": 200,
  "profiles": [
    {
      "id": "60e9ca73c500a9001534ad84",
      "createdAt": "2025-09-26T13:49:53.256Z",
      "updatedAt": "2025-09-26T14:37:29.157Z",
      "email": "[email protected]",
      "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"
    }
  ]
}

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.

​
search
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.

​
tags
string[]

A comma separated list of tag IDs to filter profiles only associated with those tags.

​
assessmentsCompleted
string[]

A comma separated list of assessment IDs to only return profiles with that specific assessment completed. This will return profiles both completed and in-progress as long as they have completed the specific assessments provided.

​
discStyles
string[]

A comma separated list of DISC styles to filter profiles by. (E.g. To see all single-letter style reports you could provide the following: discStyles=D,I,S,C)

​
startDate
string

A valid date-time to filter profiles that started the assessment after or on the provided date. (E.g. Valid date must be provided such as: 2025-10-03T16:08:17.009Z)

​
endDate
string

A valid date-time to filter profiles that started the assessment before or on the provided date. (E.g. Valid date must be provided such as: 2025-10-03T16:08:17.009Z)

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[]