Obtain an access token
For customers with applications that need to integrate with Lineup, we support the OAuth 2.0 Client Credentials Flow. This authentication flow allows machine-to-machine applications such as CLIs, daemons, or services running on your back-end to obtain an access token from our identity provider.
You will need this to obtain this access in order to securely start working with the Lineup API.
Additional Resources:
Lineup API
Once your system has been configured to obtain an access token from our identity as a service provider Auth0, it will be able to make API requests to obtain and modify user and application data for your instance of Lineup.
The Lineup API allows your integration systems to perform many of the same actions that your Lineup admins can do via our web application.
Our API data is encrypted in transit using SSL/TLS certificates and at rest using AWS Key Management Service (KMS).
You can view sample API documentation here: https://integration.lineupteams.com/swagger/index.html
If you already have a Lineup account, you can view your live API documentation at https://YOURSUBDOMAIN.lineupteams.com (substituting "YOURSUBDOMAIN" with your actual subdomain).
Webhook Subscriptions
In addition to using our APIs to take actions and get information, Lineup also supports webhooks that you can subscribe to.
Read more about our webhook subscriptions here.
Types of Integrations
With Lineup's API, your integration can accomplish most things that can be done in the Lineup web application, from adding and updating people, to fetching data from Lineup to write back into your own system.
However, the following are some common use cases and integration strategies.
Downstream Integrations
These types of integrations push data from an external system (such as your AMS or your CRM) into Lineup. You can utilize our API to update this information. When building this integration, we encourage your developers to take advantage of a system field within Lineup called the "External System Id" to store your system's unique ID. This way, when updating a Lineup Profile from another system, you're always updating the correct profile.
Downstream integrations can also create and populate teams within Lineup, to match any groups you may have within your own system
Upstream Integrations
Sometimes, you'd like to pull data from Lineup into your own system or data warehouse. For this kind of integration, you can always pull records one-by-one using the API, but this is not the recommended path.
For consuming data in bulk, we recommend using our OData Endpoints (the endpoints that drive our searches and reports):
- ApplicationReport
- GET /api/v1/query/ApplicationReport
- Evaluation
- GET /api/v1/query/Evaluation
- People
- GET /api/v1/query/People
- PersonCertificationReport
- GET /api/v1/query/PersonCertificationReport
- TeamRoster
- GET /api/v1/query/TeamRoster
- Teams
- GET /api/v1/query/Teams
- TeamSurvey
- GET /api/v1/query/TeamSurvey
For all of these endpoints, you can pass queries to the call to filter down your results or control the results that you receive. For more information, please talk to us, or see the Microsoft guidelines here.
All data will be returned in JSON format, and you can then use these to update your system.
Zapier Integrations
Lineup is also available on the Zapier Marketplace. Zapier lets you connect Lineup with thousands of the most popular apps, so you can automate your work and have more time for what matters most—no code required.
Comments
0 comments
Please sign in to leave a comment.