Skip to main content

Get a list of accounts

Now that the user is logged into the REST API, they can obtain a list of their associated accounts. The endpoint used to achieve this is GET /accounts.

  1. From Swagger UI, locate GET /accounts, which is under Accounts.

    42719.png

  2. Click GET /accounts.

  3. View the parameters available for the endpoint, which is mainly used to format or filter the results returned. These are optional fields but can be useful to specify, especially if there are a lot of results returned. Not all endpoints will have the same parameters, and some may have required fields, so be sure to go through each endpoint to see what is applicable.

    42720.png

    You can also see what response codes will be returned from this endpoint, as well as an example response body in json format.

    42721.png

  4. Click Try it out to get the list of accounts for User1.

    42722.png

    We can leave the parameters blank for now.

  5. Scroll down and click Execute.

    42723.png

  6. Check that the endpoint returned a 200 (Success) code, and displayed the response body with the list of User1’s accounts.

    42724.png

    You should also see the Curl and Request URL used for the endpoint execution. This can be useful to note if you want to know what headers and other inputs are required if you want to execute this in an external program. It is where you can also see the bearer token issued for this session.

  7. Choose the account to change the password for. The account’s id is needed, so for this example, we will choose the first one with id: 1a7145c0-537c-4e77-af36-1a7e6ead288a.

In this section: