GET
/api/public/v1/domains/{domainId}

Get a domain

Retrieve a domain with assigned locations and email status.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

domains:read

Path Parameters

NameTypeRequiredDescription
domainIdstringRequiredDomain ID.
GETExample request
curl
curl -X GET "https://www.pxb.app/api/public/v1/domains/{domainId}" \
  -H "Authorization: Bearer your_access_token"
200Example response
json
{
  "message": "Domain retrieved successfully!",
  "content": {
    "domain": {
      "id": "dom_123",
      "name": "example.com",
      "emailEnabled": true,
      "emailStatus": "verified",
      "emailAddresses": [],
      "assignedLocations": []
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Domains
/domains
  1. Open a domain from the list.