Skip to main content
GET
/
resource-aliases
Fetch all existing resource aliases with optional filters available.
curl --request GET \
  --url https://vanguard.profilebehavior.com/api/v4/resource-aliases \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "resourceAliases": [
    {
      "resourceType": "profile",
      "resourceId": "6592008029c8c3e4dc76256c",
      "consumerKey": "group_1"
    }
  ]
}

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.

​
consumerKeys
string[]

A comma separated list of consumer keys to filter by.

Example:

"group1,group2,group3"

​
resourceIds
string[]

A comma separated list of resource IDs to filter by.

Example:

"507f1f77bcf86cd799439011,6592008029c8c3e4dc76256c"

​
resourceType
enum<string>

A specific resource type to filter by. If not provided will return all resource aliases regardless of type.

Available options:
profile

Response

Success

Standard response object for successful requests that return an array of resources. Used for list endpoints in the Profile Behavior API.

​
code
integer<int32>
required

HTTP status code of the successful response.

​
status
enum<string>

Always "success" for successful responses.

Available options:
success
​
resourceAliases
object[]