Get Started with the Typed Read API

Read instances by concept with readable API aliases: create an integration, set permissions, and try the API in its documentation.

1 min read

Regarding the example of Create an Object

Create an integration and token

To create a typed read API:

  1. Go to settings
  1. Open integration settings
  1. Add a new integration
  1. Name the new integration
  1. Open the integration
  1. Click on Generate API Token
  1. Copy the token to the clipboard
    • Make sure to keep your API token.
  1. Go to your permissions tab
  1. Add the capabilities you want for each concept.
    Remember that all your related concepts require the view capability to be shown.

For details, see Set Up an Integration.

Try the API from the Read API documentation

  1. Go back to your integration list.
  1. Access the Read API documentation
  1. Click on Authorize
  1. Paste the API token you have copied to your clipboard
  1. Click on Authorize
  1. Close the available authorizations window
  1. Go to your concept API
  1. Click on try it out
  1. Click on execute
  1. View your results in responses

Read more

Related articles

Was this page helpful?