Skip to content

Retrieve a resource

Method

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

Description

Retrieves resource object by its ID or external ID.

Path params
tenant_id string required

Tenant where the resource belongs to.
id string required

ID of resource to retrieve. 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 resource object.
id string

Unique ID of the resource.
external_id string

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

Tenant where the resource belongs to.
name string

Resource name: user and email for Google Workspace/Microsoft 365 users, name for Shared Drives, etc.
kind string

Resource kind, e.g. office_user or office_teamdrive, etc.
archived boolean

Archived attribute, true for no longer backupable resources, e.g. deleted ones.
Response example
{
  "id": "string",
  "external_id": "string",
  "tenant_id": "string",
  "name": "string",
  "kind": "string",
  "archived": true
}