Warning: If you have not obtained your JWT access_token, please refer to the Authorization section to obtain your access_token and your client tenant details.

Get Locations Details

Using this location services, you can get all the locations' details.

Building your request

Please ensure that your request has been authenticated by passing your JWT access_token as the Authorization header.

Sample request:

In our example, we're going to be retrieving all the locations that are created so far.

Sample response:

{
    "data": [
    {
      "type": "location",
      "attributes": {
        "id": "1009843199016960000",
        "name": "Benevity",
        "address": {
          "addressLine": "611 Meredith Rd",
          "country": "Canada",
          "district": "Alberta",
          "locality": "Calgary",
          "postalCode": "T2E 2W5",
          "geoCoordinate": {
            "latitude": 0,
            "longitude": 0
          }
        },
        "phoneNumber": "+14035555556",
        "referenceId": "810e95f6-de45-478a-bc8c-3d94379fe002",
        "tags": [],
        "contacts": [
          {
            "id": "1009902601988210688",
            "contactId": "1009902487177527296",
            "locationId": "1009843199016960000",
            "isPrimary": false,
            "firstName": "FirstName",
            "lastName": "LastName",
            "emailAddress": "EmailAddress@email.com"
          },
          {
            "id": "1012940730538131456",
            "contactId": "1012940468872282112",
            "locationId": "1009843199016960000",
            "isPrimary": true,
            "firstName": "primary_FirstName",
            "lastName": "primary_LastName",
            "emailAddress": "test@test.com"
          }
        ]
      }
    },
    {
      "type": "location",
      "attributes": {
        "id": "1009846403511353344",
        "name": "Benevity",
        "address": {
          "addressLine": "611 Meredith Rd",
          "country": "Canada",
          "district": "Alberta",
          "locality": "Calgary",
          "postalCode": "T2E 2W5",
          "geoCoordinate": {
            "latitude": 0,
            "longitude": 0
          }
        },
        "phoneNumber": "+14035555556",
        "referenceId": "b0203cd6-dbee-4bfa-a8dd-82ac123b00ec",
        "tags": [],
        "contacts": []
      }
    }
  ]
}

Response Details:

Many of the response attributes are self-descriptive, but some of them may require a bit more clarity:

• address - Address of the Location.
• contacts - Contacts of the Location including the primary contact.
• tags - List of Tags assigned to this Location.
• referenceId - An unique Id for the Location, this value is supplied by the client and can be used to reference existing Id used in the client's existing systems.

🚀 ☀️ ⭐️ Congratulations! ⭐️ ☀️ 🚀

You have now obtained information for all locations, to help your users drive further goodness in the world!