Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Go to API under your logged in username, shown in the upper right corner of the application window.

  2. All available endpoints are listed under the API Endpoints section of the API page.


  3. Optionally, click Authorize in the upper right corner of the API Endpoints section to specify an authorization token other than the default. See API access for more information on generating tokens.



  4. Click the Post button to expand the section for a given endpoint. Each  

    Image Added

    Each endpoint includes the following information.

    A. A list of parameters; for example:
    Image Removed
    Image Added
    Image Removed


    B. An example request; for example:

    Image AddedImage Removed

    C. Possible responses with status codes and examples; for example:

    Image AddedImage Removed

  5. To execute an endpoint, click the "Try it out" button :
    Image Removedin the Parameters area.

    Image Added

  6. Click Execute at the bottom of the Request body area.

    Image Added



    The result contains the executed request and the formatted response from the server:
    Image Removed.