List webhook subscriptions

GET

/api/v1/webhooks

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/webhooks?page=1&limit=25' \
  --header 'Authorization: Bearer <token>'

Returns every subscription in the organization, newest first (not paginated).

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Query Parameters

page

number

default: 1 >= 1

limit

number

default: 25 >= 1 <= 100

is_active

boolean

event

string

Responses

200

The subscriptions

Media typeapplication/json

object

webhooks

required

Array<object>

object

_id

required

string

url

required

string

events

required

Array<string>

is_active

required

boolean

last_delivery_at

required

string | null

last_delivery_status

required

Any of:

string

string

Allowed values: pending success failed

null

null

failure_count

required

number

created_at

required

string

updated_at

required

string

key

additional properties

any

Example

{
  "webhooks": [
    {
      "last_delivery_status": "pending"
    }
  ]
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}