Partner API ExplorerCustom Domains
List domains eligible to connect
Required scope
partner:custom-domains:readGET
The organizations, brands, and venues in reach that could own a custom domain but have not connected one yet. Use this to populate a connect-a-domain picker.
header
AuthorizationBearer <token>WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.
Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected
with 401 Invalid or expired token; send it in X-API-Key instead.
WorkOS organization API keys are not accepted yet.
ownerEntityExternalId?stringLength
length <= 200ownerEntityType*stringValue in
"brand""organization""property"Owners eligible to connect a domain.
application/json- response
items*array<>curl -X GET 'https://api-prd.cf.journey.com/v1/partner/custom-domains/eligible?ownerEntityType=brand'{ "items": [ { "externalId": "string", "hostname": "string", "ownerEntityExternalId": "string", "ownerEntityType": "brand", "status": "active" } ]}