Skip to navigation
API ReferenceServices

Get Services by Type

View as Markdown

Retrieve organization services for a service type. When id is provided, the result is restricted to that service identifier.

Query parameters

idintegerOptional
Optional service identifier.
typeIdintegerRequired
Service type identifier.
forDirectbooleanOptional

Accepted for compatibility; the current implementation does not apply this value.

forSubbooleanOptional

Accepted for compatibility; the current implementation does not apply this value.

Response

Services 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

400
Bad Request Error
500
Internal Server Error