---
title: "profile url"
method: GET
path: "/utils/profile-url"
tags: ["Profiles"]
---

# profile url

`GET /utils/profile-url`

Helper endpoint to verify if a profile url is taken for a given campaign, and make suggestions if the path queried is not available
#### For custom components:
`RaiselyComponents.api.all('utils').get('profile-url', params = {}, headers = {}) => Promise<{result}>`

 :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Query parameters

- `campaignUuid` string, required — The `uuid` of the campaign to associated with the request
- `url` string
- `name` string
- `type` 'individual' | 'group' | 'team'

## Headers

- `Authorization` string

## Response `200`

The result fo the profile-url query

- object
  - `available` boolean — Status of whether the queried profile-path is currently available
  - `actual` string — A corrected representation of the provided profile url
  - `suggestions` string[] — A set of suggested paths if the provided profile is not available

## Other responses

- `401` — Authorization credentials were missing or invalid
- `403` — The user is authenticated, but is not allowed to perform the requested operation
- `410` — The requested record no longer exists, or that API has been deprecated
- `429` — You have made too many requests to the given endpoint, please try again later
- `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com

---

[API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)