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

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

​
account_id
string<uuid>

Filter to a specific account. Only applicable for organization API keys - org keys can filter to any account within their organization. Personal keys cannot use this parameter.

​
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. For personal keys, contains one pulse. For org keys, contains pulses for all accounts in the organization.

​
error
string

Error message (only present if status is error)