API Guidelines
  • Introduction
  • Process
  • General guidelines
  • Authentication
  • Documentation
  • Versioning
  • Sources
  • Change log
  • Request
    • Request
    • HTTP Methods
    • Request Parameters
    • API Endpoint
  • Response
    • Response
    • Response Formats
    • Response Codes
Powered by GitBook
On this page

Was this helpful?

URL Structure

The URL is a sentence, where HTTP methods (GET, POST, DELETE, PUT) are verbs and resources are nouns.

Example: Creating a new Manager into an Organization

Use this

  • POST/organizations/:id/managers

    • A Verb (post) + nouns.

Do NOT use this

  • POST /organizations/:id/createManager

    • Erroneous use of verb instead of a noun (createManager).

Last updated 5 years ago

PreviousChange logNextHTTP Methods
  1. Request

Request