Signl4 API V1

SIGNL4 API V1

API version: 1

Auth

ApiKey x-s4-api-key in header | ApiKey x-s4-api-key in query | OAuth2

Base URL

https://connect.signl4.com/api

Setup

1. Set your API key in the appropriate header
2. GET /alerts/report -- verify access
3. POST /alerts -- create first alerts

Endpoints

109 endpoints across 9 groups. See references/api-spec.lap for full details.

alerts

categories

events

prepaid

scripts

subscriptions

teams

users

webhooks

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a alert?" -> POST /alerts
• "Get alert details?" -> GET /alerts/{alertId}
• "Create a acknowledge?" -> POST /alerts/{alertId}/acknowledge
• "Create a annotate?" -> POST /alerts/{alertId}/annotate
• "List all annotations?" -> GET /alerts/{alertId}/annotations
• "List all attachments?" -> GET /alerts/{alertId}/attachments
• "Get attachment details?" -> GET /alerts/{alertId}/attachments/{attachmentId}
• "Create a close?" -> POST /alerts/{alertId}/close
• "List all notifications?" -> GET /alerts/{alertId}/notifications
• "List all overview?" -> GET /alerts/{alertId}/overview
• "Create a undoAcknowledge?" -> POST /alerts/{alertId}/undoAcknowledge
• "Create a undoClose?" -> POST /alerts/{alertId}/undoClose
• "Create a acknowledgeAll?" -> POST /alerts/acknowledgeAll
• "Create a acknowledgeMultiple?" -> POST /alerts/acknowledgeMultiple
• "Create a closeAll?" -> POST /alerts/closeAll
• "Create a closeMultiple?" -> POST /alerts/closeMultiple
• "Create a paged?" -> POST /alerts/paged
• "List all report?" -> GET /alerts/report
• "Create a undoAcknowledgeMultiple?" -> POST /alerts/undoAcknowledgeMultiple
• "Create a undoCloseMultiple?" -> POST /alerts/undoCloseMultiple
• "Get category details?" -> GET /categories/{teamId}
• "Get category details?" -> GET /categories/{teamId}/{categoryId}
• "Update a category?" -> PUT /categories/{teamId}/{categoryId}
• "Delete a category?" -> DELETE /categories/{teamId}/{categoryId}
• "List all metrics?" -> GET /categories/{teamId}/{categoryId}/metrics
• "List all subscriptions?" -> GET /categories/{teamId}/{categoryId}/subscriptions
• "Create a subscription?" -> POST /categories/{teamId}/{categoryId}/subscriptions
• "List all metrics?" -> GET /categories/{teamId}/metrics
• "List all images?" -> GET /categories/images
• "List all overview?" -> GET /events/{eventId}/overview
• "List all parameters?" -> GET /events/{eventId}/parameters
• "Create a paged?" -> POST /events/paged
• "List all balance?" -> GET /prepaid/balance
• "List all settings?" -> GET /prepaid/settings
• "List all transactions?" -> GET /prepaid/transactions
• "List all instances?" -> GET /scripts/instances
• "Create a instance?" -> POST /scripts/instances
• "Get instance details?" -> GET /scripts/instances/{instanceId}
• "Update a instance?" -> PUT /scripts/instances/{instanceId}
• "Delete a instance?" -> DELETE /scripts/instances/{instanceId}
• "Create a disable?" -> POST /scripts/instances/{instanceId}/disable
• "Create a enable?" -> POST /scripts/instances/{instanceId}/enable
• "List all inventory?" -> GET /scripts/inventory
• "List all parsed?" -> GET /scripts/inventory/parsed
• "Get parsed details?" -> GET /scripts/inventory/parsed/{scriptId}
• "List all subscriptions?" -> GET /subscriptions
• "Get subscription details?" -> GET /subscriptions/{subscriptionId}
• "List all channelPrices?" -> GET /subscriptions/{subscriptionId}/channelPrices
• "List all features?" -> GET /subscriptions/{subscriptionId}/features
• "List all inboundVoiceNumberLicenses?" -> GET /subscriptions/{subscriptionId}/inboundVoiceNumberLicenses
• "List all prepaidBalance?" -> GET /subscriptions/{subscriptionId}/prepaidBalance
• "List all prepaidSettings?" -> GET /subscriptions/{subscriptionId}/prepaidSettings
• "List all prepaidTransactions?" -> GET /subscriptions/{subscriptionId}/prepaidTransactions
• "List all settings?" -> GET /subscriptions/{subscriptionId}/settings
• "List all teams?" -> GET /subscriptions/{subscriptionId}/teams
• "List all userLicenses?" -> GET /subscriptions/{subscriptionId}/userLicenses
• "List all teams?" -> GET /teams
• "Create a team?" -> POST /teams
• "Get team details?" -> GET /teams/{teamId}
• "Delete a team?" -> DELETE /teams/{teamId}
• "List all alertReports?" -> GET /teams/{teamId}/alertReports
• "Get alertReport details?" -> GET /teams/{teamId}/alertReports/{fileName}
• "List all alertSettings?" -> GET /teams/{teamId}/alertSettings
• "Create a alertSetting?" -> POST /teams/{teamId}/alertSettings
• "List all dutyReports?" -> GET /teams/{teamId}/dutyReports
• "Get dutyReport details?" -> GET /teams/{teamId}/dutyReports/{fileName}
• "List all dutysummary?" -> GET /teams/{teamId}/dutysummary
• "List all eventSources?" -> GET /teams/{teamId}/eventSources
• "List all memberships?" -> GET /teams/{teamId}/memberships
• "Create a membership?" -> POST /teams/{teamId}/memberships
• "Update a membership?" -> PUT /teams/{teamId}/memberships/{userId}
• "Delete a membership?" -> DELETE /teams/{teamId}/memberships/{userId}
• "Create a resendInviteMail?" -> POST /teams/{teamId}/memberships/resendInviteMail
• "List all schedules?" -> GET /teams/{teamId}/schedules
• "Create a schedule?" -> POST /teams/{teamId}/schedules
• "Delete a schedule?" -> DELETE /teams/{teamId}/schedules/{dutyId}
• "Get schedule details?" -> GET /teams/{teamId}/schedules/{scheduleId}
• "Create a deleteRange?" -> POST /teams/{teamId}/schedules/deleteRange
• "Create a multiple?" -> POST /teams/{teamId}/schedules/multiple
• "List all setupProgress?" -> GET /teams/{teamId}/setupProgress
• "List all users?" -> GET /users
• "Get user details?" -> GET /users/{userId}
• "Delete a user?" -> DELETE /users/{userId}
• "Create a checkPermission?" -> POST /users/{userId}/checkPermissions
• "List all dutyStatus?" -> GET /users/{userId}/dutyStatus
• "List all image?" -> GET /users/{userId}/image
• "Create a image?" -> POST /users/{userId}/image
• "Create a location?" -> POST /users/{userId}/location
• "Create a punchIn?" -> POST /users/{userId}/punchIn
• "Create a punchInAsManager?" -> POST /users/{userId}/punchInAsManager
• "Create a punchOut?" -> POST /users/{userId}/punchOut
• "List all setupProgress?" -> GET /users/{userId}/setupProgress
• "List all webhooks?" -> GET /webhooks
• "Create a webhook?" -> POST /webhooks
• "Get webhook details?" -> GET /webhooks/{webhookId}
• "Update a webhook?" -> PUT /webhooks/{webhookId}
• "Delete a webhook?" -> DELETE /webhooks/{webhookId}
• "Create a disable?" -> POST /webhooks/{webhookId}/disable
• "Create a enable?" -> POST /webhooks/{webhookId}/enable
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP