Skip to main content
GET
/
pending-profiles
Get a paginated array of profiles invited to your account who have not yet joined
curl --request GET \
  --url https://vanguard.profilebehavior.com/api/v4/pending-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]"
    }
  ]
}

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.

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