Business Services
Read business mail and registered-agent services
Read private Stable service status for an authorized business. With enrollmentId, fetch one page of current mail; with mailItemId, refresh one saved mail item and temporary scan links. Private business content requires explicit business-services:read access and current administrative-file permission. Platform scope is admin-only. A provider-active agent is not proof of state appointment.
Method
GET
Path
/v1/business-services
Required scope
business-services:readRequest
curl -X GET "https://api.endurancehq.app/v1/business-services" \
-H "Authorization: Bearer $EHQ_API_KEY"Query schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"scopeType": {
"type": "string",
"enum": [
"platform",
"organization",
"user"
]
},
"scopeId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"enrollmentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"mailItemId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"after": {
"type": "string",
"maxLength": 2000
},
"search": {
"type": "string",
"maxLength": 200
}
},
"required": [
"scopeType"
],
"additionalProperties": false
}Response
Success status: 200
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"const": "stable"
},
"configured": {
"type": "boolean"
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"serviceKind": {
"type": "string",
"enum": [
"virtual_mailbox",
"registered_agent"
]
},
"status": {
"type": "string"
},
"jurisdictionRegion": {
"type": [
"string",
"null"
]
},
"providerLocationId": {
"type": [
"string",
"null"
]
},
"onboardingStatus": {
"type": [
"string",
"null"
]
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": [
"string",
"null"
]
},
"line2": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"postalCode": {
"type": [
"string",
"null"
]
}
},
"required": [
"line1",
"line2",
"city",
"state",
"postalCode"
],
"additionalProperties": false
},
"lastSyncedAt": {
"type": [
"string",
"null"
]
},
"stateAppointmentVerified": {
"type": "boolean",
"const": false
}
},
"required": [
"id",
"serviceKind",
"status",
"jurisdictionRegion",
"providerLocationId",
"onboardingStatus",
"address",
"lastSyncedAt",
"stateAppointmentVerified"
],
"additionalProperties": false
}
},
"mail": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"enrollmentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"providerMailItemId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sender": {
"type": [
"string",
"null"
]
},
"businessRecipient": {
"type": [
"string",
"null"
]
},
"individualRecipient": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"scanStatus": {
"type": [
"string",
"null"
]
},
"receivedAt": {
"type": [
"string",
"null"
]
},
"envelopeUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"scanUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"enrollmentId",
"providerMailItemId",
"sender",
"businessRecipient",
"individualRecipient",
"summary",
"scanStatus",
"receivedAt",
"envelopeUrl",
"scanUrl"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"provider",
"configured",
"services",
"mail",
"nextCursor",
"hasMore"
],
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
}Other surfaces
MCP tool: ehq_business_services_get