List all unique URLs

Returns a list of your unique URLs.


CampaignId optional

Id of the program (formerly known as campaign) that hosts the unique URL.

State optional

State of the unique URL.

View possible enum values
AVAILABLEUnique URL is available for assignment.
DELETEDUnique URL has been deleted.
INUSEUnique URL is currently being used by a partner.
QUARANTINEUnique is quarantined and is being investigated.
RESERVEDUnique URL is reserved for a certain partner.


Returns an array of unique URL objects up to a limit dictated by @pagesize. Each entry in the array is a separate unique URL. If no unique URLs meet the criteria, the resulting array will be empty. This request should never return an error.

Example Request

curl '<AccountSID>/UniqueUrls' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -d 'CampaignId=1000' \
  -d 'State=AVAILABLE' \

Example Response

  "@page": "1",
  "UniqueUrls": [
      "Id": "00005",
      "Url": "",
      "LandingPage": "",
      "CampaignId": "1000",
      "CampaignName": "Acme Campaign",
      "State": "AVAILABLE",
      "MediaPartnerId": "10000",
      "MediaPartnerName": "Acme Partner",
      "DateCreated": "2020-09-18T19:17:36-04:00",
      "DateLastAssigned": "",
      "DateLastReleased": "",
      "Uri": "/Advertisers/<AccountSID>/UniqueUrls/00005"