manaable REST API
What's manaableAbout Us
What's manaableAbout Us
    • Introduction
    • イントロダクション
    • API v3
      • Members
        • Get Members
        • Get Member by ID
      • Teams
        • Get Teams
        • Get Team by ID
    • API v2
    • API v1

    Introduction

    About REST API#

    The REST API provides an interface to access your manaable data without using the manaable UI. By utilizing this REST API, you can integrate manaable into your applications however you like. All you need to do is find the target information (i.e., resource) within this documentation, choose the operation you want to perform (search, create, update, etc.), and send an HTTP request to the manaable endpoint.

    URIs#

    The URI is the path that identifies a resource in manaable. The basic structure of the URI is as follows (with exceptions):
    https://[my-domain-name].manaable.com/api/v[X]/[resource]/
    Replace [my-domain-name] with the subdomain of your manaable UI.
    Replace [X] with the version of the API you want to use.
    Replace [resource] with the resource name and the rest of the path.

    HTTP Methods#

    The REST API supports all standard HTTP request methods (GET, POST, PATCH, PUT, and DELETE). However, please note that not all resources necessarily support all methods.

    HTTP Headers#

    api-key - This provides the API key that you can obtain from the manaable Admin site to authenticate your requests.
    Modified at 2024-06-06 14:54:14
    Next
    イントロダクション
    Built with