Docs
Skip to content
get

Get presence

Endpoint

gethttps://<REGION>.cloud.appwrite.io/v1/presences/{presenceId}

Description

Get a presence log by its unique ID. Entries whose expiresAt is in the past are treated as not found.

Required scopes

presences.read

Authentication

Initialize the Appwrite client with setProject() and ensure the user is signed in. The SDK sends the session header automatically after login.

Path

string
Required

Presence unique ID.

Status
Content type
200
application/json

Presence

Name
Type
Description
string

Presence ID.

string

Presence creation date in ISO 8601 format.

string

Presence update date in ISO 8601 format.

arrayof string

Presence permissions. Learn more about permissions.

string

User ID.

string

Presence status.

string

Presence source.

string

Presence expiry date in ISO 8601 format.

object

Presence metadata.

JavaScript
import { Client, Presences } from "appwrite";


const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID


const presences = new Presences(client);


const result = await presences.get({
    presenceId: '<PRESENCE_ID>'
});


console.log(result);