Use the API to get some information about the current user.
- In the Types panel on the right, click Query. This shows a list of queries in the left panel.
- Find setup in the list, and drill into SetupQueries:
3. Find userManager in the list and drill into UserManagerQueries:
4. Find currentUser in the list, and drill into UserEmployeeModel:
5. This shows the fields that make up the UserEmployeeModel object. Create a query that returns some of these fields.
6. Return to the Operations view by pulling down the menu that says Schema Reference and changing it to Operations. Optionally, you could open a second tab in the tool (CTRL-ALT-T for Windows; Command-Option-T for Mac). This way, the first tab is on the schema reference and the second tab is on the operations.
7. Type your desired GraphQL query. Notice that the tool helps with auto-complete functionality:
The completed query should look like this:
This query retrieves only the userName, description, and jobTitle fields.
8. Click the Run button in the upper-right corner of the Operations panel:
The results appear in the Response panel:
Note that if you get an error at this point about not being authorized, one of two things has probably happened: either you did not follow the procedure in Getting set up and signed in or the token that you retrieved has expired. Follow the instructions in Getting set up and signed in to get a token, or if your token expired, return to the Connection Settings dialog, and at the bottom of the Authorization tab, click Fetch Token and try again.
Next steps
Familiarize yourself with the API and its structure. If you are unfamiliar with GraphQL or JSON, use the links in the Introduction to learn about those technologies.
Once you are familiar with these concepts, branch out to other tools, or use the information in this document to start using a GraphQL client library to begin integrating this API into your own project.