Clerk API (unofficial showcase)
GET/sign_ups/{id}

Retrieve a sign-up by ID

Retrieve the details of the sign-up with the given ID

1 parameter
idstringrequired
The ID of the sign-up to retrieve

2 status codes
200Success
objectstringrequired
Allowed:sign_up_attempt
idstringrequired
statusstringrequired
Allowed:missing_requirementscompleteabandoned
required_fieldsarray<string>required
optional_fieldsarray<string>required
missing_fieldsarray<string>required
unverified_fieldsarray<string>required
verificationsobjectrequired
usernamestringrequired
email_addressstringrequired
phone_numberstringrequired
web3_walletstringrequired
password_enabledbooleanrequired
first_namestringrequired
last_namestringrequired
unsafe_metadataobjectoptional
public_metadataobjectoptional
custom_actionbooleanrequired
external_idstringrequired
created_session_idstringrequired
created_user_idstringrequired
abandon_atintegerrequired
Unix timestamp at which the user abandoned the sign up attempt.
legal_accepted_atintegerrequired
Unix timestamp at which the user accepted the legal requirements.
timezonestringoptional
The IANA timezone associated with the sign-up attempt.
localestringoptional
The user locale preference for the sign-up specified as a BCP-47 language tag.
external_accountobjectdeprecatedoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 403 is returned: Authorization invalid.