Skip to content

Generate customer portal URL

GET
/v1/customers/{external_id}/portal_url

Generate a portal URL for a customer to access their self-service portal.

external_id
required
External Id
string

Successful Response

PortalUrlResponse
object
portal_url
required
Portal Url
string

Unauthorized – invalid or missing API key

Customer not found

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object