/api/v1/locations/deleted

GET

const url = 'https://example.com/api/v1/locations/deleted?limit=20';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/locations/deleted?limit=20'

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 200

cursor

string

<= 2048 characters

Responses

200

Default Response

application/json

object

locations

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

kind

required

string

Allowed values: personal home apartment garage storage_unit office vacation_home custom

deletedAt

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

purgeAfter

required

string format: date-time

nextCursor

required

string | null

Example

{
  "locations": [
    {
      "kind": "personal"
    }
  ]
}