Notifications

Get all notifications

Retrieve a list of notifications with optional filtering and pagination

GET

/api/notifications

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Query Parameters

object_id

string

Filter by object ID

webhook_id

string

Filter by webhook ID

events

string[]

Filter by events

Available options:

job.completedjob.failedjob.cancelledupload.completedupload.failedupload.expired

response_status_code.eq

integer

Filter by exact response status code

Required range: 100 <= x <= 599

response_status_code.gte

integer

Filter by response status code greater than or equal

Required range: 100 <= x <= 599

response_status_code.lte

integer

Filter by response status code less than or equal

Required range: 100 <= x <= 599

offset

default: 0

integer

Pagination offset

Required range: x >= 0

limit

default: 100

integer

Pagination limit (max 100)

Required range: 1 <= x <= 100

created.gte

integer

epoch

Filter by creation date greater than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

created.lte

integer

epoch

Filter by creation date less than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

created.sort

default: "asc"

string

Sort by creation date (asc/desc)

Available options:

ascdesc

Responses

application/json

data

object[]

required

Data contains the paginated notification items

limit

integer

required

Limit indicates the maximum number of items in the current response

offset

integer

required

Offset indicates the offset of the first item in the current response

status

"success"

string

required

Status indicates the response status "success"

total

integer

required

Total indicates the total number of items

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify'; const client = new Chunkify({ projectAccessToken: 'My Project Access Token', }); // Automatically fetches more pages as needed. for await (const notification of client.notifications.list()) { console.log(notification.id); }

from chunkify import Chunkify client = Chunkify( project_access_token="My Project Access Token", ) # Automatically fetches more pages as needed. for notification in client.notifications.list(): print(notification.id)

<?php use Chunkify\Client; $client = new Client( projectAccessToken: 'My Project Access Token', ); // Automatically fetches more pages as needed. foreach ($client->notifications->list()->pagingEachItem() as $notification) { var_dump($notification->id); }

package main import ( "context" "fmt" "github.com/chunkifydev/chunkify-go" "github.com/chunkifydev/chunkify-go/option" ) func main() { client := chunkify.NewClient( option.WithProjectAccessToken("My Project Access Token"), ) page, err := client.Notifications.List( context.TODO(), chunkify.NotificationListParams{}, ) if err != nil { panic(err.Error()) } // Loop through the pages and print the notifications IDs for page != nil { for _, notification := range page.Data { fmt.Printf("%+v\n", notification.ID) } page, err = page.GetNextPage() if err != nil { panic(err.Error()) } } }

{ "data": [ { "created_at": "2025-01-01T12:00:00Z", "event": "job.completed", "id": "notf_2G6MJiNz71bHQGNzGwKx5cJwPFS", "object_id": "job_2G6MJiNz71bHQGNzGwKx5cJwPFS", "payload": "{\"event\":\"job.completed\",\"job\":{\"id\":\"job_123\"}}", "webhook": { "enabled": true, "events": [ "job.completed", "job.failed" ], "id": "wh_2G6MJiNz71bHQGNzGwKx5cJwPFS", "project_id": "proj_2G6MJiNz71bHQGNzGwKx5cJwPFS", "url": "https://example.com/webhook" } } ], "limit": "<integer>", "offset": "<integer>", "status": "success", "total": "<integer>" }