New Current User Endpoint

• Cory Forseth

Version 1.0 of the Widen Collective® API has long had the ability to return information about the Collective user associated with the presented Access Token. This same user information is now being returned in version 2.0.

The following endpoint is now available for use in v2.0 of the API:

  • GET /v2/user

This endpoint returns much of the same user information as the /api/rest/user/address endpoint in v1.0, but in a simpler and more concise format that requires minimal migration effort.

Migration

If an integration is already using the endpoint in v1.0, then a simple migration should be performed. To do that:

  1. Change the endpoint from https://mysite.widencollective.com/api/rest/user/address to https://api.widencollective.com/v2/user.
  2. Change your data mappings to match the new format. See examples below:

Examples

v1.0 response shape:

{
  "uuid": "79ceffc3-4042-490e-bad7-1a3c9626d5f6",
  "fields": {
    "streetAddress": {
      "value": "6911 Mangrove Lane",
      "required": false
    },
    "lastName": {
      "value": "Doe",
      "required": true
    },
    "phone": {
      "value": "608-222-1296",
      "required": false
    },
    "postalCode": {
      "value": "53713",
      "required": false
    },
    "email": {
      "value": "john@widen.com",
      "required": true
    },
    "company": {
      "value": "Widen Enterprises, Inc.",
      "required": false
    },
    "stateOrProvince": {
      "value": "WI",
      "required": false
    },
    "firstName": {
      "value": "John",
      "required": true
    },
    "country": {
      "value": "United States",
      "required": false
    },
    "city": {
      "value": "Madison",
      "required": false
    }
  }
}

v2.0 response shape:

{
    "uuid": "79ceffc3-4042-490e-bad7-1a3c9626d5f6",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@widen.com",
    "username": "john@widen.com",
    "title": null,
    "company": "Widen Enterprises, Inc.",
    "phone": "608-222-1296",
    "street_address": "6911 Mangrove Lane",
    "city": "Madison",
    "state_or_province": "WI",
    "postal_code": "53713",
    "country": "United States"
}

An in-depth look is available in our API documentation. Please don’t hesitate to reach out to our Support team with any questions.