SAsamsara
Beta APIs

[beta] List vendor locations.

Returns a paginated list of vendor locations in the organization. Each linked Place owns the location's name, address, and notes. Use the location's addressId as {id} in the public Addresses API: GET /addresses/{id} retrieves data.name, data.formattedAddress, and data.notes; PATCH /addresses/{id} updates name, formattedAddress, and notes. These calls require Read Addresses and Write Addresses permissions, respectively.

<b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Work Orders under the Work Orders 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>

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.

get/fleet/maintenance/vendor-locations

Request

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

Query parameters

idsstring[]

A comma-separated list of up to 100 vendor location IDs to filter on. Accepts Samsara UUIDs or external IDs in key:value format. See external IDs.

externalIdsstring[]

A comma-separated list of up to 100 external IDs in key:value format to filter vendor locations on. See external IDs.

includeResolvedSettingsboolean

Include resolved vendor settings and their sources. Defaults to false.

includeExternalIdsboolean

When true, include externalIds on each vendor location in the response. Default false.

afterstring

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

OK response.

Example response

{
  "data": [
    {
      "addressId": "281474993384538",
      "assetAttributeSelections": [
        {
          "attributeId": "11111111-1111-4111-8111-111111111111",
          "values": [
            {
              "id": "11111111-1111-4111-8111-111111111111"
            }
          ]
        }
      ],
      "categoryIds": [
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      ],
      "defaultLaborRatePerHour": {
        "amount": "140.00",
        "currency": "USD"
      },
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "parentVendorId": "11111111-1111-4111-8111-111111111111",
      "payeeId": "PAYEE-12345",
      "resolvedSettings": {
        "assetAttributeSelections": [
          {
            "attributeId": "11111111-1111-4111-8111-111111111111",
            "values": [
              {
                "id": "11111111-1111-4111-8111-111111111111"
              }
            ]
          }
        ],
        "assetAttributeSelectionsSource": "system",
        "defaultLaborRatePerHour": {
          "amount": "140.00",
          "currency": "USD"
        },
        "defaultLaborRatePerHourSource": "system",
        "isMobileSource": "system",
        "isPreferredSource": "system"
      },
      "servicesProvided": "Oil changes, tire rotations, brake services",
      "status": "active",
      "vendorId": "0000000772"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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