Partner API ExplorerCustom Domains
List custom domains
Required scope
partner:custom-domains:readGET
Custom domains connected within the reach of the credential.
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.
limit?numberRange
1 <= valueoffset?numberRange
0 <= valueA page of connected domains.
application/json- response
items*array<>limit*numberoffset*numbertotal*numbercurl -X GET 'https://api-prd.cf.journey.com/v1/partner/custom-domains'{ "items": [ { "activatedAt": "2019-08-24T14:15:22Z", "blockedBy": "dns", "createdAt": "2019-08-24T14:15:22Z", "dnsState": "unknown", "externalId": "string", "hostingState": "ready", "hostname": "string", "lastCheckedAt": "2019-08-24T14:15:22Z", "lastError": "string", "ownerEntityExternalId": "string", "ownerEntityName": "string", "ownerEntityType": "brand", "requiredDnsRecords": [ { "host": "string", "type": "CNAME", "value": "string" } ], "status": "active", "updatedAt": "2019-08-24T14:15:22Z" } ], "limit": 0, "offset": 0, "total": 0}