{
"opencollection": "1.0.0",
"info": {
"name": "Samsara Addresses API",
"version": "2024-11-18"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Addresses",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Addresses",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/addresses",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects."
},
{
"name": "after",
"value": "",
"type": "query",
"description": "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."
},
{
"name": "parentTagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`"
},
{
"name": "tagIds",
"value": "",
"type": "query",
"description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`"
},
{
"name": "createdAfterTime",
"value": "",
"type": "query",
"description": "A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00)."
}
]
},
"docs": "Returns a list of all addresses in an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Read Addresses** under the Addresses category when "
},
{
"info": {
"name": "Create an Address",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.samsara.com/addresses",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new address in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating"
},
{
"info": {
"name": "Retrieve an Address",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.samsara.com/addresses/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "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`"
}
]
},
"docs": "Returns a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Read Addresses** under the Addresses category when creating or editing an A"
},
{
"info": {
"name": "Update an Address",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.samsara.com/addresses/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "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`"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an A"
},
{
"info": {
"name": "Delete an Address",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.samsara.com/addresses/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "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`"
}
]
},
"docs": "Delete a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an A"
}
]
}
],
"bundled": true
}