Resource

    All the endpoints of one resource listed in a single topic.

    Required

    The left-hand navigation should display the following sections of this topic:

    • Functional grouping, for example: Tasks.
      • All items in each group, for example: Getting tasks, Creating tasks, Updating tasks.

    Examples

    Preparing code samples
    The number of languages supported in the code samples affects the amount of time needed from the customer’s development team.
    Using AI for code samples
    Currently, the AI-powered LLMs can’t ’translate’ samples from language into language without a reliable developer ‘sample proof-reader’.

    REST API reference template

    REST API references are structured in a precise way. To download a REST API reference template, select the link below.

    Access rights needed
    To download the file, you need the access to the company SharePoint.

    Download the REST API reference template

    UI and UX analysis

    Below, you can see an example of a functional and well-organised endpoint page and its elements.

    A similar user flow is currently out of scope as our default.
    clickup api reference screenshot
    clickup api reference screenshot
    clickup api reference screenshot

    Screenshot legend

    1. The left-hand navigation contains the list of all endpoints, grouped by functions and labelled with the type of the HTTP request method (GET, PUT, POST, DELETE).
    2. Each page contains several subsections hidden in drop-downs.
    3. On page load, the key section is expanded by default.
    4. Most endpoints have a Try it button that lets the users make a test request directly from their browser, using their API credentials.
    5. All right-hand code sections are also drop-downs that can be expanded to simplify navigation and reduce scrolling.
    6. Request samples are provided in 15 popular programming languages.
    7. The buttons to the right allow the users to:
      • Show/hide code samples.
      • Move code samples to the bottom of the page.
    8. All parameters of a request and a response are linkable.
    9. That’s what an expanded Response section looks like.

    Resource 2

    Optional

    The number of these topics depends on the number of resources. All the resource topics can be displayed on one page if the portal’s performance isn’t compromised by that.