---
title: "Return integration link configuration"
method: GET
path: "/get_integration_link_user_config"
tags: ["Integration", "Links"]
---

# Return integration link configuration

`GET /get_integration_link_user_config`

This function retrieves configuration information about a specified integration link in a specified user's cPanel interface.

## Query parameters

- `app` string, required
- `user` string, username, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `userconfig` object — An object with information about the user's integration link.
      - `app` string — The application to link.
      - `autologin_token_url` string, url — A publicly-available URL to which the server will send the `app`, `token`, `user`, and `subscriber_unique_id` values through an HTTP POST request. The destination server will respond with a JSON-encoded object with either a `redirect_url` key or the `retry` and `attempt` keys. * If the response contains `redirect_url`, the system will redirect the user to that URL (for example, `{"redirect_url":"http://www.whmcs.com/client_area/login/?one_time_user_token_that_expires_in_120_seconds=d41d8cd98f00}` will send the user to that URL). * If the response contains `retry` and `attempt`, the system will wait for the `retry` value in seconds for a maximum of 60 seconds and then attempt the call again. The `attempt` value indicates the number of attempts that the system tried. The system will stop after three attempts (for example, `{"retry":30, "attempt":2}` represents the second attempt to connect, and the system will pause the user for 30 seconds before it tries again).
      - `base64_png_image` string, base64 image — The image to display for the application on the cPanel *Home* interface.
      - `implements` string — The service for which to implement authentication. The `implements` value is a string from the WHM API 1 `get_users_links` function. Typically, this function returns one of the following values: * `billing` — This link appears in the user menu. * `customer_service` — This link appears in the user menu. * `support` — This link appears in the user menu. * `upgrade` — This link appears in the user menu and context-sensitive areas when the user may require more of a resource.
      - `label` string — The label to display for the application on the cPanel *Home* interface.
      - `subscriber_unique_id` string — The subscriber's unique ID that the system will present to the URL in the `autologin_token_url` endpoint.
      - `url` string, url — A publicly-available URL to which to send the user if the location in the `autologin_token_url` parameter does not respond.
      - `user` string, username — The cPanel account name.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)