Skip to content

Retrieve a resource.

Method

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}

Description

Retrieves a resource by its ID or external ID.

Path params
tenant_id string required

Tenant that owns the resource.
id string required

ID of the resource to retrieve. An external ID can be used if prefixed with `ext$`.

 
curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}
Successful response (200) schema
object

Resource describes a single managed resource.
id string

Unique ID of the resource.
external_id string

External (Google Workspace, Microsoft 365, etc.) ID of the resource.
tenant_id string

Tenant that owns the resource.
name string

Resource name (for example, a user's email for Google Workspace or Microsoft 365 tenants, or the name of a Shared Drive).
kind string

Resource kind (for example, office_user or office_teamdrive).
archived boolean

Indicates whether the resource is archived. When true, the resource can no longer be backed up (for example, if it was deleted).
Response example
{
  "id": "string",
  "external_id": "string",
  "tenant_id": "string",
  "name": "string",
  "kind": "string",
  "archived": true
}