Skip to main content
GET
/
v1
/
tenants
Get tenants
curl --request GET \
  --url https://api.petrasecurity.com/v1/tenants \
  --header 'Authorization: Bearer <token>'
{
  "totalTenants": 2,
  "tenants": [
    {
      "petraTenantId": "ZZk90t",
      "name": "Acme Corporation",
      "microsoftTenantId": "abcd1234-5678-90ef-ghij-klmnopqrstuv",
      "isPaused": false,
      "onboardingDate": "2025-01-15T00:00:00.000Z"
    },
    {
      "petraTenantId": "Y3mPqr",
      "name": "Globex Inc.",
      "microsoftTenantId": "ffff0000-1111-2222-3333-444455556666",
      "isPaused": true,
      "onboardingDate": "2024-09-02T00:00:00.000Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.petrasecurity.com/llms.txt

Use this file to discover all available pages before exploring further.

For common API errors, see API Troubleshooting.

Authorizations

Authorization
string
header
required

Bearer token authentication. Include your API key in the Authorization header as 'Bearer YOUR_API_KEY'

Response

Successful response

totalTenants
integer

The number of tenants returned

tenants
object[]

Tenants in your organization, sorted alphabetically by name