Use the JUNO API
The JUNO API allows the Client team to programmatically perform actions or retrieve data from the platform. For example, you can edit a user's email address or get a list of all tags on the platform.
If you or someone on your team is familiar with using APIs, contact your JUNO Customer Success Manager and request an API key to get started.
Go to the JUNO API Documentation to learn more.
Additional reference
You might reference this information while using the API documentation.
Â
Contents
User payload details
This is a reference for the user payload fields you will see in the API documentation.
Field | Description | Example Value |
---|---|---|
| JUNO’S unique User ID used for API updates. |
|
| User's legal first name |
|
| User's legal last name |
|
| Default dimension ID: 12 |
|
| Default dimension ID: 18 |
|
| Default dimension ID: 11 |
|
| User's organization they belong to. |
|
| Users must have a unique email address in JUNO. |
|
| Default dimension ID: 5 |
|
| Default dimension ID: 10 |
|
| Default dimension ID: 13 |
|
| Default dimension ID: 14 |
|
| Default dimension ID: 15 |
|
| Default dimension ID: 16 |
|
| The users time zone. |
|
| Image set on the User's profile. |
|
| Continuing education points earned from a user's activity. (CE) |
|
| JUNO admin level access. 0 = limited User access 99 = Full administrative access |
|
| Alternate Client ID |
|
| Can be used for the unique system user IDs. |
|
| Determines if a user has restricted site access. |
|
| Default dimension ID: 1 |
|
| Default dimension ID: 2 |
|
| Default dimension ID: 3 |
|
| Default dimension ID: 8 |
|
| Typically used for custom SSO integrations. |
|
| Default dimension ID: 4 |
|
| Date and time a user was initially created in the JUNO database. |
|
| A time stamp of the most recent user login. |
|
| A time stamp of the most recent user data update. |
|
Example JSON User payload:
{ "id": 123, "first_name": "John", "last_name": "McLane", "designation": "Lt", "title": "Detective," "job_type": "law enforcement", "company": "Nakatomi", "email": "jmclane@diehard.com", "phone": "123-555-4321", "address": "2121 Avenue of the Stars", "city": "Los Angeles", "state_province": "CA", "postal_code": "90067", "country": "United States of America", "timezone": -25200, "avatar": "https://nakatomiplaza.com/avatar.png", "points": 120, "account_level": 99, "client_id": A125637, "client_guid": "735992af-c8a2-4cac-9072-5f1a29437e98", "banned": "false", "username": "jmclane", "website": "https://junolive.co", "linkedin": "https://www.linkedin.com/in/jmclane/", "twitter": "https://twitter.com/jmclanenypd", "facebook": "https://www.facebook.com/john.mclane", "instagram": "https://www.instagram.com/jmclane/", "date_created": "1900-01-01T00:00:00", "date_last_login": "1900-01-01T00:00:00", "date_updated": "1900-01-01T00:00:00", "tags": [ { "id": "1", "name": "Main Stage", "type": "2", "type_name": "Access Level", "score": "35" } ], "dimensions": [ { "id": 14, "name": "Medical School", "value": "University of Washington" } ] }
Continuing Education (CE) API definitions
This is a reference for the CE fields you will see in the API documentation.
ce_credits
: The maximum number of credits/hours a User can potentially earn for a CE.
ce_threshold
: The % (0-100) amount of credits/hours a User must complete in order to claim a CE.
ce_status
:
None
= Hides the CE record from the User’s CE dashboard in their profile.Open
= The CE is available for the User to earn.Ready
= The CE is in the "ready to claim" state and displays a "claim" button in the user interface.Done
= The CE has been claimed by the User.
ce_earned_hours
: The amount of credits/hours a User has earned towards the completion of the CE.
ce_claimed_hours
: The amount of credits/hours a User has officially claimed for the completion of the CE.