goals

List goals

Changed on

List all goals a user can set.

get/users/{user_guid}/goals

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/goals
  • Auth
    HTTP basic

Path parameters

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Query parameters

pageinteger

Results are paginated. Specify current page.

records_per_pageinteger

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

Headers

Acceptstring required
Example:application/vnd.mx.api.v1+json

Specifies the media type expected in the response.

Response

OK

Changes

  • e74cd2b059b5Revision changes
    • breaking

      added the new required header request parameter Accept

    • breaking

      for the query request parameter page, the type changed from string to integer

    • warning

      deleted the query request parameter records_per_age

    • info

      api operation id listGoals was added

    • info

      added the new optional query request parameter records_per_page

    • info

      media type application/json was changed to a more specific media type application/vnd.mx.api.v1+json for the response status

  • 471bc9021d67Revision changes
    • info

      endpoint added