Skip to main content
GET
/
api
/
pulses
cURL
curl --request GET \
  --url https://recoup-api.vercel.app/api/pulses
{
  "status": "success",
  "pulses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true
    }
  ],
  "error": "<string>"
}

Query Parameters

​
account_id
string<uuid>

Filter to a specific account. Only applicable when the authenticated account has access to multiple accounts via organization membership.

​
active
enum<string>

Filter by active status. Set to 'true' to return only active pulses, 'false' for inactive pulses. If not provided, returns all pulses regardless of active status.

Available options:
true,
false

Response

Pulses retrieved successfully

​
status
enum<string>
required

Status of the request

Available options:
success,
error
​
pulses
object[]
required

Array of pulse objects. Contains pulses for the authenticated account. If the account has access to organizations, all organization accounts are included.

​
error
string

Error message (only present if status is error)