Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List your notifications

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

Paginated (up to 50 per page), newest first; filter with is_read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
number
default: 1 >= 1
limit
number
default: 20 >= 1 <= 50
is_read
boolean

Responses

Section titled “Responses”

200

Section titled “200”

A page of notifications

Media typeapplication/json
object
items
required
Array<object>
object
_id
required
string
type
required
string
title
required
string
body
required
string | null
link
required
string | null
is_read
required
boolean
created_at
required
string
key
additional properties
any
total
required
number
page
required
number
limit
required
number
has_more
required
boolean
Examplegenerated
{
  "items": [
    {
      "_id": "example",
      "type": "example",
      "title": "example",
      "body": "example",
      "link": "example",
      "is_read": true,
      "created_at": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1,
  "has_more": true
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}