The iQ GET Profile API retrieves an iQ Tag Management account profile, including specific configuration components and version history.
How it works
Use the GET method to retrieve an account profile:
GET /v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}?includes={INCLUDE}&publishVersion={PUBLISH_VERSION}
Authentication
The bearer token is used to authenticate all API calls and not the API key. The API key is only used in the authentication call. In addition to the bearer token, the authentication response includes a region-specific hostname that must be used in subsequent server-side API calls.
To learn about generating a bearer token from the API key, see Authentication.
GET operation parameters
This command uses the following parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| publishVersion | String | Optional | The version ID of the profile to retrieve. If you omit this parameter, the most recent version is retrieved. Version IDs are in the format YYYYMMDDhhmmExample: "202202111806" |
| includes | Array | Optional | An array of the configuration components to include in the response. Add this query string parameter for each component to include. For example, to get variables and extensions: &includes=variables&includes=extensions Default: noneValues: loadRules, tags, tags.templateList, tags.template, extensions, variables, events , and versionIDs |
To retrieve the list of tag templates for a profile, your GET request must include tags and tags.templateList. For example, &includes=tags&includes=tags.templateList.
To retrieve the tag templates themselves, include tags and tags.template. For example, &includes=tags&includes=tags.template.
Example cURL request
curl -H 'Authorization: Bearer {token}' \
https://platform.tealiumapis.com/v3/tiq/accounts/{ACCOUNT}/profiles/{PROFILE}?includes=loadRules&includes=extensions&includes=tags&includes=tags.template&includes=variables&includes=events&includes=versionIds&publishVersion=202003161355
Example response
Error messages
Potential error messages for this endpoint:
| Error Code | Error Message |
|---|---|
| 400 | "Profile libraries are out of date, merge changes before patching profile - {ACCOUNT} | profile: {PROFILE}""Variable validation failed - variableId: {VARIABLE ID} | {ACCOUNT} | profile: {PROFILE}. Cause: {cause}" |
| 404 | "Profile not found - account: {ACCOUNT} | profile: {PROFILE}""Profile library not found - account: {ACCOUNT} | profile: {PROFILE}""Profile (legacy) not found - account: {ACCOUNT} | profile: {PROFILE}"Error in getting next extension id - {ACCOUNT} profile: {PROFILE}" |
| 409 | "Users are currently viewing the same account: {ACCOUNT} | profile: {PROFILE}""Conflict with profile extension: _id: {ID}, extType: {TYPE}, name: {NAME} - {ACCOUNT} | profile: {PROFILE}" |
| 500 | "Error processing json for extension - account: {ACCOUNT} | profile: {PROFILE}" |
This page was last updated: May 19, 2026