<aside> 💡 The UAT Swagger page points at the UAT Windfall Environment. Information about the Endpoints, Sample Messages and more are included.

For information on specific endpoints see Endpoints

</aside>

Welcome to the MoveHQ help center! We're here to answer your questions. Can't find what you're looking for? Send our support team an email at [email protected]

Swagger 📖

Swagger UI

API Key Instructions

<aside> 💡 Set the API Key in the top righthand corner

Untitled

</aside>

Viewing the Endpoints

  1. The Endpoints are parked under five Groups

    Untitled

  2. Click a Group to see the related Endpoints and a brief description

    Untitled

  3. Click the Endpoint to see more details like Implementation Notes, Response Classes, Parameters and Responses

    Untitled

Interacting with the Endpoints

  1. The Parameters section includes a sample body on the right; click it to copy the sample to the APIParameters free-typing field

    Untitled

  2. Use the resize grabber to expand the free-typing field

    Untitled

  3. Set the Parameters and click the Try It Out! button to pass it to the Endpoint

    Untitled

  4. The cURL, Request URL, Response Body and Response Code and Response Headers are displayed

    Untitled

    Untitled