How to use the Bridge API

The Bridge API is like a secret back door into Bridge that gives you wizard-level capabilities to manipulate every detail the system contains about learners, their enrollments, courses, and everything else. You can do a lot with the Bridge admin interface, but you can do it ALL with Bridge API.

If you've never worked with an API before and/or don't have a lot of experience with coding, don't feel intimidated. The Bridge API is a tool to help you, not scare you off.

You will want to open the API Documentation to follow along. 

To help you get started, below are a series of videos that start with the most simple task of just downloading Postman, the application that runs API requests to Bridge. Each video takes you step by step through the basics of the API and gets you on your way.

You won't learn how to do everything under the sun in the videos, but in the next 27 minutes and 48 seconds, you'll learn enough to be dangerous and start making some magic. You can use the principles you learn in just about any situation in which you find yourself needing the API. Go ahead, dive in.

Was this article helpful?

21 out of 41 found this helpful

Have more questions? Submit a request

Comments

6 comments

  • Comment author
    FOUR PAWS Bridge Admin Team

    I would be very interested in participating in a webinar on the Bridge API! Hopefully something like this can be setup for Bridge customers?

    2
  • Comment author
    Jeremy Farnsworth

    Hi Beatrice, 

    I'll let the team know this is something you'd be interested in. We'll see if we can get something set up like that soon! 

    1
  • Comment author
    Artur Komarnicki

    Do you have any additional training resources / webinars for using APIs? I'd be especially interested in how to mark Checkpoints, Live Courses and Programs for historical completions. In Bridge there's CSV Bulk Upload for courses, but there is no upload for other items. I've tried following the documentation, but with little success for those items.  

    0
  • Comment author
    Steve Ostopchuck

    Where can I find the API docs? 

    1
  • Comment author
    Lindsay Boss

    Hey Steve, 

    Here is a link to the API Doc that we have. It lists out all the public calls that are available. 
    https://docs.bridgeapp.com/doc/api/html/index.html

    0
  • Comment author
    Jordan Jamison

    Is the API able to pull info on Journeys yet? That would be incredibly helpful if so!

    1

Please sign in to leave a comment.