API REFERENCE

List Pulses

On this page

GET/api/pulses

Retrieve pulse information for the authenticated account. If the account has access to organizations, pass account_id to filter to a specific account within those organizations.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/pulses' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Query parameters

account_idstring

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

activestring · enum

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.

Values: "true", "false"

Responses

200Pulses retrieved successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success", "error"

pulsesarray<Pulse>required

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

Item properties

idstring

Unique identifier for the pulse

format: uuid

account_idstring

Unique identifier for the associated account

format: uuid

activeboolean

Whether the pulse is active (defaults to true)

errorstring

Error message (only present if status is error)

400Bad request - invalid query parameters

application/json

errorintegerrequired

format: int32

messagestringrequired

401Unauthorized - invalid or missing API key

application/json

errorintegerrequired

format: int32

messagestringrequired

403Forbidden - account_id is not a member of the organization or account tried to filter by an account_id they don't have access to

application/json

errorintegerrequired

format: int32

messagestringrequired

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Retrieve pulse information for the authenticated account. If the account has access to organizations, pass account_id to filter to a specific account within those organizations.",
  "parameters": [
    {
      "name": "account_id",
      "in": "query",
      "description": "Filter to a specific account. Only applicable when the authenticated account has access to multiple accounts via organization membership.",
      "required": false,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    },
    {
      "name": "active",
      "in": "query",
      "description": "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.",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "true",
          "false"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Pulses retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PulsesResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request - invalid query parameters",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized - invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - account_id is not a member of the organization or account tried to filter by an account_id they don't have access to",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}