aVenture APIRecord Slugs

Get a company's slug

View as Markdown

Returns the current slug, canonical path, and public URL. Bearer access requires ROLE_ADMIN or ROLE_CLIENT.

Authentication

AuthorizationBearer

User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key

Path parameters

entityIdstringRequiredformat: "uuid"
Entity UUID

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
idstring
pathstring
resourceTypeenum
Resource type whose slug is being changed
Allowed values:
slugstring
urlstring
entityTypestring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error