API referenceConnections
Find your connection for a domain
Returns the caller's connection for a domain, for an app that stored the domain but not the connection id (for example to open the removal flow). A connect-scoped widget token must be minted for that domain, and finds a connection that names an end user only when minted with the same end_user_ref; an app-scoped token finds any domain of its application, and an API key any domain of its tenant.
AuthorizationBearer <token>
Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).
In: header
Query Parameters
domain*string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/connections:lookup?domain=string"{ "id": "string", "application_id": "string", "domain": "string", "host": "string", "provider_id": "string", "setup_type": "automatic", "status": "pending", "managed": true, "created_at": "2019-08-24T14:15:22Z", "last_checked_at": "2019-08-24T14:15:22Z", "www_redirect": true, "override_spf": true, "validate_dmarc": true, "validate_caa": true, "monitor": true, "batch_id": "string", "end_user_ref": "string", "retried_at": "2019-08-24T14:15:22Z", "records_source": "integrator", "created_via": "", "secure_root_domain": true, "redirect_to": "http://example.com", "power_root_path_access": [ "string" ], "error_code": "string", "error_message": "string", "write_rail": "api_key", "provider_account_id": "string", "removal_started_at": "2019-08-24T14:15:22Z", "records": [ { "type": "CNAME", "host": "string", "value": "string", "ttl": 3600, "priority": 0, "applied": true, "change": "created", "prior": [ { "type": "string", "value": "string", "ttl": 0, "priority": 0 } ], "prior_source": "provider" } ]}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}