Skip to navigation
API ReferenceServices

Get an Organization Service

View as Markdown

Retrieve a configured service by its identifier and organization. Requires the service_view authority.

Path parameters

idintegerRequired
Organization service identifier.
organizationIdlongRequired
Organization identifier.

Response

Organization service retrieved successfully.
idintegerOptional
Organization service identifier.
organizationIdlong or nullOptional
Organization owning the configured service.
integrationobject or nullOptional
Integration summary exposed for the service.
namestring or nullOptional<=300 characters

Organization-specific service name.

forDirectboolean or nullOptional
Whether the service is available for direct customers.
forSubboolean or nullOptional
Whether the service is available for subpartners.
carrierTypestring or nullOptional<=50 characters

Carrier-specific service classification.

offsetDaysinteger or nullOptional
Service scheduling offset in days.
attributesmap from strings to any or nullOptional

Provider-specific service attributes.

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error