Referência da APISignup Links

Obter um link de cadastro

Retorna um único link de cadastro pelo seu ID.

Authentication

AuthorizationBearer

API Key in the format mk_live_<43-chars>. Obtain from the Dashboard or POST /auth/api-keys.

Path parameters

idstringRequired
Unique identifier of the signup link

Response

Default Response
idstring
Unique identifier of the signup link
slugstring

URL-friendly slug used in the public link URL

namestring
Display name of the signup link
urlstring
Full public URL for the signup link
activeboolean
Whether the signup link is currently active and accepting signups
usageCountdouble
Number of times this link has been used
maxUsagesdouble or null
Maximum allowed usages, or null for unlimited
expiresAtstring or null
Expiration datetime in ISO 8601 format, or null if no expiration
customMessagestring or null

Custom message shown to end-users, or null if not set

redirectUrlstring or null
Redirect URL after signup completion, or null if not set
createdAtstring
ISO 8601 datetime when the signup link was created
updatedAtstring
ISO 8601 datetime when the signup link was last updated

Errors

401
Unauthorized Error
404
Not Found Error