Endpoints and testing the API

Japanese translation unavailable

This page has not been translated into Japanese yet - we apologise for the inconvenience! If you’re interested in helping us out, feel free to translate any article in the jp folder of the DevCenter repository and open a PR!

このページは日本語への翻訳がまだ完了しておりません。ご不便をおかけして申し訳ございません! もしお手伝いできる方がいらっしゃれば、ご自由にjpフォルダの記事を日本語に訳していただき、PRを開いてください


The Bitrise API endpoint reference documentation lists every available endpoint and their parameters, along with the possible responses. You can also try them out!

Testing the API

You can try out any endpoint in the reference documentation itself! All you need to do is authenticate yourself and provide the required parameters. The API will return the appropriate response based on the call.

  1. Acquire a Personal Access Token.
  2. Go to the Bitrise API endpoint reference documentation.
  3. Click Authorize.

  4. Paste your Personal Access Token to the Value field.

  5. Click on the endpoint you want to try it out to open its details.
  6. Fill in the required parameters.
  7. Click Execute.

The API will return: