SAsamsara
Addresses

Retrieve an address

Returns a specific address.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

To use this endpoint, select Read Addresses under the Addresses category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

get/addresses/{id}

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the Address. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: key:value. For example, crmId:abc123

Response

An Address.

Example response

{
  "data": {
    "addressTypes": [
      "yard"
    ],
    "contacts": [
      {
        "firstName": "Jane",
        "id": "22408",
        "lastName": "Jones"
      }
    ],
    "createdAtTime": "2019-05-18T20:27:35Z",
    "externalIds": {
      "maintenanceId": "250020",
      "payrollId": "ABFS18600"
    },
    "formattedAddress": "350 Rhode Island St, San Francisco, CA",
    "geofence": {
      "circle": {
        "latitude": 37.765363,
        "longitude": -122.4029238,
        "radiusMeters": 25
      },
      "polygon": {
        "vertices": [
          {
            "latitude": 37.765363,
            "longitude": -122.403098
          },
          {
            "latitude": 38.765363,
            "longitude": -122.403098
          },
          {
            "latitude": 37.765363,
            "longitude": -123.403098
          }
        ]
      }
    },
    "id": "22408",
    "latitude": 37.765363,
    "longitude": -122.4029238,
    "name": "Samsara HQ",
    "notes": "Hours of operation: 8am - 6pm; Truck entrance on the Rhode Island street side.",
    "tags": [
      {
        "id": "3914",
        "name": "East Coast",
        "parentTagId": "4815"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.