# SIGNL4 API API

> SIGNL4 API API on Apizie: 101 endpoints (Trigger Alert, Confirms all visible alerts, Acknowlegde multiple alerts, Close all acknowledged alerts., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/communication:signl4/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:signl4`
- Category: Communication
- Status: byok
- Source: https://www.signl4.com/feedback-we-love-hear-from-you/
- Page: https://www.apizie.tech/api/communication/signl4
- OpenAPI: https://www.apizie.tech/api/communication/signl4/openapi.json

Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to: 2-way integration: Triggering of Signls and updates in the third party systems when alert state…

## Endpoints

### Trigger Alert
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Confirms all visible alerts
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-acknowledge-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | no | User ID of the user to be used to acknowledge the alarms. |
| body | object | no | JSON request body |

### Acknowlegde multiple alerts
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-acknowledge-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Close all acknowledged alerts.
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-close-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | no | User ID of the user to be used to close the alarms. |
| body | object | no | JSON request body |

### Close multiple alerts
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-close-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets alerts paged
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-paged` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| maxResults | integer | no | Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. Number of alerts could be less if filtered but… |
| userId | string | no | User ID of the user you want to get alerts for. |
| body | object | no | JSON request body |

### Get Alert Report
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | no | User ID of the user for whom you want a report. |

### Queue undo of multiple acknowledgments.
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-undo-acknowledge-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Withdraw closure of multiple alerts
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-undo-close-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Alert
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the requested Alert. |

### Acknowledge an alert
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-alert-id-acknowledge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id to acknowledge an alert. |
| body | object | no | JSON request body |

### Annotate Alert
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-alert-id-annotate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the alert to annotate. |
| body | object | no | JSON request body |

### Get annotations of an alert
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id-annotations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the requested Alert. |

### Get attachments of an alert
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id-attachments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the requested Alert. |

### Gets a specified attachment of a specified alert.
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id-attachments-attachment-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the alert that contains the wanted attachment. |
| attachmentId | string | yes | Id of the attachment, that you want to retrieve. |
| width | integer | no | Optional parameter defining the wanted width of the picture that is retrieved. |
| height | integer | no | Optional parameter defining the wanted height of the picture that is retrieved. |
| scale | boolean | no | Optional parameter defining whether it's wanted to scale the retrieved image. Default is set to true. |

### Close an alert
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-alert-id-close` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id to acknowledge an alert. |
| body | object | no | JSON request body |

### Get alert notifications
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the requested Alert. |

### Get an overview alert.
`GET https://www.apizie.tech/v1/communication:signl4/get-alerts-alert-id-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes | Id of the requested Alert. |

### Undo the acknowledgement of an alert.
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-alert-id-undo-acknowledge` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes |  |
| body | object | no | JSON request body |

### Undo the closure of an alert.
`POST https://www.apizie.tech/v1/communication:signl4/post-alerts-alert-id-undo-close` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alertId | string | yes |  |
| body | object | no | JSON request body |

### Gets the names of all alert category images. You can get the image by going to…
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-images` (byok)

### Get all categories
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-team-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the categories belong to |

### Create a new category
`POST https://www.apizie.tech/v1/communication:signl4/post-categories-team-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| body | object | no | JSON request body |

### Get metrics for all categories
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-team-id-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the categories belongs to |

### Get a specific category
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-team-id-category-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes | ID of the category to get |

### Update an existing category
`POST https://www.apizie.tech/v1/communication:signl4/put-categories-team-id-category-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes |  |
| body | object | no | JSON request body |

### Delete an existing category
`POST https://www.apizie.tech/v1/communication:signl4/delete-categories-team-id-category-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes | ID of the category to delete |

### Get metrics for a specific category
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-team-id-category-id-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes | ID of the category to get |

### Get category subscriptions
`GET https://www.apizie.tech/v1/communication:signl4/get-categories-team-id-category-id-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes | Category to get subscriptions for |

### Set category subscriptions
`POST https://www.apizie.tech/v1/communication:signl4/post-categories-team-id-category-id-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the category belongs to |
| categoryId | string | yes | Category to be updated |
| body | object | no | JSON request body |

### Get overview event paged.
`POST https://www.apizie.tech/v1/communication:signl4/post-events-paged` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| maxResults | integer | no | Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. Number of alerts could be less if filtered but… |
| body | object | no | JSON request body |

### Get overview event
`GET https://www.apizie.tech/v1/communication:signl4/get-events-event-id-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| eventId | string | yes | Id of event to get. |

### Get event parameters
`GET https://www.apizie.tech/v1/communication:signl4/get-events-event-id-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| eventId | string | yes | Event Id of the requested Alert. |

### Get your subscription's current prepaid balance.
`GET https://www.apizie.tech/v1/communication:signl4/get-prepaid-balance` (byok)

### Get your subscription's current prepaid settings.
`GET https://www.apizie.tech/v1/communication:signl4/get-prepaid-settings` (byok)

### Update your subscription's current prepaid settings.
`POST https://www.apizie.tech/v1/communication:signl4/put-prepaid-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get your subscription's prepaid transactions.
`GET https://www.apizie.tech/v1/communication:signl4/get-prepaid-transactions` (byok)

### Returns all script instances of the SIGNL4 team
`GET https://www.apizie.tech/v1/communication:signl4/get-scripts-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | no |  |

### Creates a new script instance in the in the SIGNL4 team.
`POST https://www.apizie.tech/v1/communication:signl4/post-scripts-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Returns all information about a given script instance which includes its runtime status.
`GET https://www.apizie.tech/v1/communication:signl4/get-scripts-instances-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | Instance Id of script instance to be returned. |

### Updates a given script instance, typically used for updating the configuration of a script.
`POST https://www.apizie.tech/v1/communication:signl4/put-scripts-instances-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | InstanceId of the script to be updated. |
| body | object | no | JSON request body |

### Deletes a script instance.
`POST https://www.apizie.tech/v1/communication:signl4/delete-scripts-instances-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | Instance Id of script instance to be returned. |

### Updates custom data of a given script instance which includes its display name.
`POST https://www.apizie.tech/v1/communication:signl4/put-scripts-instances-instance-id-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | InstanceId of the script to be updated. |
| body | object | no | JSON request body |

### Disables a given script instance.
`POST https://www.apizie.tech/v1/communication:signl4/post-scripts-instances-instance-id-disable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | Id of the instance to be disabled. |

### Enables a script instance.
`POST https://www.apizie.tech/v1/communication:signl4/post-scripts-instances-instance-id-enable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | string | yes | Id of the instance to be enabled. |

### Returns all available inventory scripts which can be added to a SIGNL4 subscription.
`GET https://www.apizie.tech/v1/communication:signl4/get-scripts-inventory` (byok)

### Returns all inventory scripts.
`GET https://www.apizie.tech/v1/communication:signl4/get-scripts-inventory-parsed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| language | string | no |  |

### Returns an inventory script by its id.
`GET https://www.apizie.tech/v1/communication:signl4/get-scripts-inventory-parsed-script-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scriptId | string | yes | The Id of the script to be returned. |
| language | string | no |  |

### Get infos of all available/managed subscriptions.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions` (byok)

### Get infos of a specific subscription.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | Id of the subscription that's to be retrieved. |

### Returns the subscription's channel price information.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-channel-prices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | Id of the subscription that needs to be retrieved. |

### Returns the features of a specified subscription.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-features` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | Id of the subscription from which the features need to be retrieved. |

### Get a subscription's current prepaid balance.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-prepaid-balance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes |  |

### Get a subscription's current prepaid settings.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-prepaid-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes |  |

### Update a subscription's current prepaid settings.
`POST https://www.apizie.tech/v1/communication:signl4/put-subscriptions-subscription-id-prepaid-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | ID of the subscription |
| body | object | no | JSON request body |

### Get a subscription's prepaid transactions.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-prepaid-transactions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | ID of the subscription to get transactions for |

### Updates a subscriptions profile.
`POST https://www.apizie.tech/v1/communication:signl4/put-subscriptions-subscription-id-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | ID of the subscription to be updated |
| body | object | no | JSON request body |

### Get infos for all teams of the subscription.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-teams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes |  |

### Gets a subscription's user licenses.
`GET https://www.apizie.tech/v1/communication:signl4/get-subscriptions-subscription-id-user-licenses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscriptionId | string | yes | ID of the subscription |

### Get infos of all teams.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams` (byok)

### Gets infos of a specific team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team that should be retrieved. |

### Get information about downloadable alert reports
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-alert-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of team you want to download reports from. |

### Returns Alert Report
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-alert-reports-file-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of team you want to get the duty report file infos for. |
| fileName | string | yes | File name of file you want to download. |

### Gets alert settings of a specific team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-alert-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the settings should be retrieved for. |

### Sets alert settings of a specific team.
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-alert-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the settings should be set for. |
| body | object | no | JSON request body |

### Get Information about downloadable reports
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-duty-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of team you want to get the duty report file infos for. |

### Download duty report with a specific fileName
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-duty-reports-file-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of team you want to download the duty report for. |
| fileName | string | yes | Filename of the csv to download. |

### Get duty assistant info for a team
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-dutysummary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the duty belongs to. |
| lastTwoDuties | boolean | no |  |

### Gets event sources of a specific team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-event-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the sources should be retrieved for. |

### Get all invites of a team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-memberships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team ID of team you want to request. |

### Invite users to a team
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-memberships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Id of team the user should be invited to. |
| body | object | no | JSON request body |

### Sends invite email again if an invite exists
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-memberships-resend-invite-mail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team ID of team with invited user. |
| body | object | no | JSON request body |

### Update user's team membership.
`POST https://www.apizie.tech/v1/communication:signl4/put-teams-team-id-memberships-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team the user you want to update belongs to at the moment. |
| userId | string | yes | User ID of user you want to update. |
| requesterUserId | string | no | User ID of user which you want to change role with. This must be provided when using an api key. This user must have role administrator… |
| body | object | no | JSON request body |

### Removes a user or invitation from a team, and may delete the user if he is not in any team.
`POST https://www.apizie.tech/v1/communication:signl4/delete-teams-team-id-memberships-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the user should be deleted from |
| userId | string | yes | ID of the user that should be deleted |
| requesterUserId | string | no | User ID of user which will remove the other user. |

### Updates team profile of a team
`POST https://www.apizie.tech/v1/communication:signl4/put-teams-team-id-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team ID of team which should be updated. |
| body | object | no | JSON request body |

### Returns information about all duties that belong to the team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Id of the team the schedules user belongs to |
| UserId | string | no |  |
| MinDate | string | no |  |
| Limit | integer | no |  |

### Create/Update given duty schedule.
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-schedules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Id of the team the duty is to be assigned to. |
| body | object | no | JSON request body |

### Delete duty schedules in range
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-schedules-delete-range` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team ID you want to delete |
| body | object | no | JSON request body |

### Save multiple schedules. It is possible to override existing schedules if you wish
`POST https://www.apizie.tech/v1/communication:signl4/post-teams-team-id-schedules-multiple` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Team ID to set |
| overrideExisting | boolean | no | Override or cut existing schedules if set to true. |
| body | object | no | JSON request body |

### Delete a specific duty.
`POST https://www.apizie.tech/v1/communication:signl4/delete-teams-team-id-schedules-duty-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the duty belongs to. |
| dutyId | string | yes | ID of the duty to be deleted. |

### Returns information of the duty schedule with the specified Id.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-schedules-schedule-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | Id of the team the duty belongs to |
| scheduleId | string | yes | Id of the requested duty schedule. |

### Gets setup progress of a specific team.
`GET https://www.apizie.tech/v1/communication:signl4/get-teams-team-id-setup-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | yes | ID of the team the progress should be retrieved for. |

### Get all Users
`GET https://www.apizie.tech/v1/communication:signl4/get-users` (byok)

### Get User by Id
`GET https://www.apizie.tech/v1/communication:signl4/get-users-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Identifier of the user to get. Use 'Me' to get information about the currently logged in user. This is not possible with an api key. Can… |

### Updates the password of a user
`POST https://www.apizie.tech/v1/communication:signl4/put-users-user-id-change-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | User ID of user whose password should be changed. |
| body | object | no | JSON request body |

### Checks if a user has the provided permission.
`POST https://www.apizie.tech/v1/communication:signl4/post-users-user-id-check-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | ID of the user to check permissions for. |
| teamId | string | no |  |
| body | object | no | JSON request body |

### Get duty status by user Id
`GET https://www.apizie.tech/v1/communication:signl4/get-users-user-id-duty-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Identifier of the user to get. Use 'Me' to get information about the currently logged in user. This is not possible with an api key. Can… |

### GET /users/{userId}/image
`GET https://www.apizie.tech/v1/communication:signl4/get-users-user-id-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes |  |
| height | integer | no |  |
| width | integer | no |  |

### Uploaded a profile image for a specified user.
`POST https://www.apizie.tech/v1/communication:signl4/post-users-user-id-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Id of the user. |

### Updates user profile of an user
`POST https://www.apizie.tech/v1/communication:signl4/put-users-user-id-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | ID of user to update. |
| body | object | no | JSON request body |

### Punch User in
`POST https://www.apizie.tech/v1/communication:signl4/post-users-user-id-punch-in` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Identifier of the user to punch in. Use 'Me' to get information about the currently logged in user. This is not possible with an api key.… |

### Punch User in as Manager
`POST https://www.apizie.tech/v1/communication:signl4/post-users-user-id-punch-in-as-manager` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Identifier of the user to punch in. Use 'Me' to get information about the currently logged in user. This is not possible with an api key.… |

### Punch User out
`POST https://www.apizie.tech/v1/communication:signl4/post-users-user-id-punch-out` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | Identifier of the user to punch out. Use 'Me' to get information about the currently logged in user. This is not possible with an api key.… |

### Gets setup progress of a specific user.
`GET https://www.apizie.tech/v1/communication:signl4/get-users-user-id-setup-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | string | yes | ID of the user the progress should be retrieved for. |

### Get Webhooks
`GET https://www.apizie.tech/v1/communication:signl4/get-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| teamId | string | no |  |

### Create Webhook
`POST https://www.apizie.tech/v1/communication:signl4/post-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Webhook by Id
`GET https://www.apizie.tech/v1/communication:signl4/get-webhook-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Id of the outbound webhook to be retrieved. |

### Update Webhook by Id
`POST https://www.apizie.tech/v1/communication:signl4/put-webhooks-webhook-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Id of the outbound webhook to be updated. |
| body | object | no | JSON request body |

### Delete Webhook by Id
`POST https://www.apizie.tech/v1/communication:signl4/delete-webhooks-webhook-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Id of the outbound webhook that will be deleted. |

### Ability to enable a webHook.
`POST https://www.apizie.tech/v1/communication:signl4/post-webhooks-webhook-id-disable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Webhook ID for webhook which should be disabled. |

### Ability to disable a webHook.
`POST https://www.apizie.tech/v1/communication:signl4/post-webhooks-webhook-id-enable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| webhookId | string | yes | Webhook ID for webhook which should be enabled. |

## Example
```
curl "https://www.apizie.tech/v1/communication:signl4/post-alerts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the SIGNL4 API API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/communication:signl4/post-alerts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the SIGNL4 API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. SIGNL4 API itself also needs your own key from signl4.com.

### Can AI agents use the SIGNL4 API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:signl4.

### What is the status of the SIGNL4 API API?
Needs your own provider key (bring your own key)