Skip to content
Book a Demo

FeedbackPulse REST API

Send API requests to https://api.feedbackpulse.com with a workspace API key. A workspace Admin creates the key in FeedbackPulse, as described in Authentication.

A workspace Admin opens Settings > Integrations > API Clients, chooses Create API Client, and selects the scopes the integration needs. Copy the key into your secret store. Select employees:read to list or read employees, employees:write to create them, and employees:sync to sync them. Send the key in the Authorization: Bearer <key> header over HTTPS.

The REST API requires a workspace-owned API-client key. The token management guide covers personal tokens for MCP clients.

Send Accept: application/json. A 401 response has a message field. Other API errors can include error and error_description. Validation failures can also include an errors object with field-level details. The employee sync response can include row-level failures in a successful HTTP response.

Status What to check
401 The bearer key is present and valid.
403 The key belongs to an API client in an active workspace and has the required scope.
409 The request with this idempotency key is in progress, or the key was used with a different payload. Check the error code before retrying.
422 Correct invalid request fields or an invalid idempotency key.
429 Wait for the Retry-After interval before sending the request again.

If an error continues after these checks, contact support.

The default limit is 120 read requests and 30 write requests per minute, counted separately per API-client key. A rate-limited request returns 429. For a sync request retried after a timeout, a 429, or a server error, send the same payload and Idempotency-Key. The API stores every response for an idempotency key except a 429 or a server error, and replays a stored response, including a 422, for a retry with the same key and payload. After you correct a rejected request, send it with a new Idempotency-Key.

The major version is part of the URL path, such as /v1. List operations use page numbers (page) and page size (per_page). To read the next page, send the same per_page and increase page by 1. meta.last_page is the number of the last page. Employee sync accepts a batch and returns a result per row in one response.