Human-readable
Browse endpoints, fields, examples, errors and response formats without reading server code.
OPENAPI 3.0 · PRODUCTION API
URLZ OpenAPI reference
Explore every supported URLZ API operation, request parameter, response and authentication method in one clear, machine-readable reference.
OPENAPI
A reliable contract for every integration
The OpenAPI description is the technical contract between URLZ and your application. Use it to understand requests, validate responses, import the API into your tools or generate a client.
Machine-readable
Import the JSON file into Postman, Insomnia, Swagger, Redocly or an API client generator.
Safe by design
Authentication requirements are shown for every operation. Secrets must stay on your server.
QUICK START
Start in four simple steps
- 1
Create an account
Create your URLZ account and open the API section of the dashboard.
- 2
Choose authentication
Use an API key for server automation or a Bearer session for account features.
- 3
Send a request
Copy an example, replace the placeholders and send it over HTTPS.
- 4
Handle the response
Check the HTTP status first, then read the documented JSON response.
API REFERENCE
Complete interactive reference
Search the specification below, open an operation and review its parameters, request body, examples and possible responses.