How can we help? πŸ‘‹

How to Test Your API Token

A step-by-step guide to making your first API call to test your API token.

Get Your API Token:

  1. Ensure you have a functional API Key. Create a new one or copy it from CheckHub Admin.

Prepare Your Call:

  1. Use the endpoint GET /companies/me to retrieve your Company Details.
  1. We recommend using Postman for testing.
      • Read our guideline: [Using Postman as Developer Tool]
      • Download our Postman collection for quick setup.

Add Your Token:

  1. In Postman, navigate to the Authorization section.
  1. Select Bearer Token and enter your API token in the token field. Replace {{token}} with your actual token.
Notion image

Make Your First API Call:

  1. Send your request.
  1. If successful, you should receive a response with your company details.
Notion image
⚠️
Important: Your API token is unrestricted. Be cautious with the operations you perform on your data.

Something's Wrong?

If your request doesn't go as planned, refer to our guide: [Troubleshoot & Error Handling]

Did this answer your question?
😞
😐
🀩