Gets a list of portals

GET /portal/get

Request

Gets a list of portals

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

PortalNamestring

Portal name

TenantIdintegerformat: int32

Tenant id

AffiliateIdstring

Affiliate id

PartnerIdstring

Partner id

Campaignstring

Campaign

FirstNamestring

First name

Emailstringformat: email

Email

Industryintegerformat: int32

Industry

Languagestring

Language

LastNamestring

Last name

Modulestring

Module

Passwordstring

Password

PasswordHashstring

Password hash

Phonestring

Phone

RecaptchaResponsestring

Recaptcha response

RecaptchaTypeone of

Recaptcha type

.enum of string

[Default - Default, AndroidV2 - AndroidV2, iOSV2 - iOSV2, hCaptcha - hCaptcha]

Can be one of: Default, AndroidV2, iOSV2, hCaptcha.

.enum of integer

[0 - Default, 1 - AndroidV2, 2 - iOSV2, 3 - hCaptcha]

Can be one of: 0, 1, 2, 3.

Regionstring

Region

AWSRegionstring

AWS region

Statusone of

Status

.enum of string

[Active - Active, Suspended - Suspended, RemovePending - Remove pending, Transfering - Transfering, Restoring - Restoring, Migrating - Migrating, Encryption - Encryption]

Can be one of: Active, Suspended, RemovePending, Transfering, Restoring, Migrating, Encryption.

.enum of integer

[0 - Active, 1 - Suspended, 2 - Remove pending, 3 - Transfering, 4 - Restoring, 5 - Migrating, 6 - Encryption]

Can be one of: 0, 1, 2, 3, 4, 5, 6.

SkipWelcomeboolean

Skip welcome

TimeZoneNamestring

TimeZone name

Spamboolean

Spam

Callsboolean

Calls

AppKeystring

App key

LimitedAccessSpaceboolean

Limited access space

statisticsboolean

Examples

GET /portal/get?PortalName=some%20text&TenantId=1234&AffiliateId=some%20text&PartnerId=some%20text&Campaign=some%20text&FirstName=Electa&Email=Flossie_Grady52%40hotmail.com&Industry=1234&Language=some%20text&LastName=D'Amore&Module=some%20text&Password=ll_nbWEyq1&PasswordHash=some%20text&Phone=some%20text&RecaptchaResponse=some%20text&Region=some%20text&AWSRegion=some%20text&SkipWelcome=true&TimeZoneName=some%20text&Spam=true&Calls=true&AppKey=some%20text&LimitedAccessSpace=true HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/portal/get?PortalName=some%20text&TenantId=1234&AffiliateId=some%20text&PartnerId=some%20text&Campaign=some%20text&FirstName=Electa&Email=Flossie_Grady52%40hotmail.com&Industry=1234&Language=some%20text&LastName=D'\''Amore&Module=some%20text&Password=ll_nbWEyq1&PasswordHash=some%20text&Phone=some%20text&RecaptchaResponse=some%20text&Region=some%20text&AWSRegion=some%20text&SkipWelcome=true&TimeZoneName=some%20text&Spam=true&Calls=true&AppKey=some%20text&LimitedAccessSpace=true' \
  --header 'Accept: application/json'

Responses

200

Ok

401

Unauthorized