---
title: Clients
slug: Web/API/Clients
translation_of: Web/API/Clients
---
<p>{{SeeCompatTable}}{{APIRef("Service Workers API")}}</p>

<p>The <code>Clients</code> interface of the <a href="/en-US/docs/Web/API/Service_Worker_API">Service Workers API</a> represents a container for a list of {{domxref("Client")}} objects.</p>

<h2 id="Methods">Methods</h2>

<dl>
 <dt>{{domxref("Clients.get()")}}</dt>
 <dd>Gets a service worker client matching a given <code>id</code> and returns it in a {{jsxref("Promise")}}.</dd>
 <dt>{{domxref("Clients.matchAll()")}}</dt>
 <dd>Gets a list of service worker clients and returns them in a {{jsxref("Promise")}}. Include the <code>options</code> parameter to return all service worker clients whose origin is the same as the associated service worker's origin. If <code>options</code> are not included, the method returns only the service worker clients controlled by the service worker. </dd>
 <dt>{{domxref("Clients.openWindow()")}}</dt>
 <dd>Opens a service worker {{domxref("Client")}} in a new browser window.</dd>
 <dt>{{domxref("Clients.claim()")}}</dt>
 <dd>Allows an active Service Worker to set itself as the active worker for a client page when the worker and the page are in the same scope. </dd>
</dl>

<h2 id="Examples">Examples</h2>

<pre class="brush: js">clients.matchAll(options).then(function(clients) {
  for(i = 0 ; i &lt; clients.length ; i++) {
    if(clients[i] === 'index.html') {
      clients.openWindow(clients[i]);
      // or do something else involving the matching client
    }
  }
});</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('Service Workers', '#clients', 'Clients')}}</td>
   <td>{{Spec2('Service Workers')}}</td>
   <td>Initial definition</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

{{Compat("api.Clients")}}

<h2 id="See_also">See also</h2>

<ul>
 <li><a href="/en-US/docs/Web/API/ServiceWorker_API/Using_Service_Workers">Using Service Workers</a></li>
 <li><a href="https://github.com/mdn/sw-test">Service workers basic code example</a></li>
 <li><a href="https://jakearchibald.github.io/isserviceworkerready/">Is ServiceWorker ready?</a></li>
 <li>{{jsxref("Promise")}}</li>
 <li><a href="/en-US/docs/Web/Guide/Performance/Using_web_workers">Using web workers</a></li>
</ul>