/** * @example * {} */ export interface GetPlacesRequest { /** 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. */ after?: string; /** The limit for how many objects will be in the response. Default and max for this value is 512 objects. */ limit?: number; /** Comma-separated Samsara place IDs for batch lookup (max 100). When set, list filters and cursor pagination are ignored. Mutually exclusive with `externalIds`. */ placeIds?: string; /** Comma-separated external ID tokens (`key:value`) for batch lookup (max 100). When set, list filters and cursor pagination are ignored. Mutually exclusive with `placeIds`. */ externalIds?: string; /** When true, expands tag objects on each place. Defaults to false. */ includeTags?: boolean; /** When true, includes externalIds on each place. Defaults to false. */ includeExternalIds?: boolean; /** Comma-separated numeric tag IDs to filter places. */ tagIds?: string; /** Comma-separated parent tag IDs to filter places. Includes places tagged with each parent tag and its descendant tags. */ parentTagIds?: string; /** Comma-separated place type tokens (e.g. yard,normalGeofence). */ placeTypes?: string; /** Filter places by name text. */ name?: string; }