Forto Platform API

Shipment
Subscriptions
Booking Request
Reports
- Download a reportget
Tokens

Forto Platform API

Shipment
Subscriptions
Booking Request
Reports
- Download a reportget
Tokens

List/Filter/Paginate Subscriptions

get https://public-api.forto.io/v1/events-api/subscriptions

URL Expired

The URL for this request expired after 30 days.

Query Params

type

string

Types of subscription, either webhook or inbox. Defaults to webhook when creating a webhook with no type specified.

url

uri

URL of the webhook where the request will be sent

eventTypes

array of strings

Types of events

eventTypes

pageSize

number

1 to 50

Defaults to 50

Desired amount of entities in the response

page

number

≥ 1

Defaults to 1

Desired page of entities

Responses

Response body

object

items

array of objects

required

Subscriptions

items*

object

string

required

ID of the subscription

type

string

Types of subscription, either webhook or inbox. Defaults to webhook when creating a webhook with no type specified.

inbox webhook

name

string

Name of the subscription

url

uri

URL of the webhook where the request will be sent

eventTypes

array of strings

required

Types of events

eventTypes*

signatureKey

string

required

Signature key that will be used to sign the requests

totalItems

number

required

≥ 0

Total number of items found

page

number

required

≥ 1

Current page number

pageSize

number

required

≥ 1

Requested size of the page

Response body

object

name

string

required

Defaults to ValidationException

Name of ValidationException

ValidationException

debugID

string

required

Internal identifier used for correlation purposes.

message

string

required

Message describing the error.

informationLink

string

URI for detailed information related to this error for the developer.

details

array of objects

required

Additional details for the error.

details*

object

field

string

required

Field causing the issue

value

object

Value of the field causing the issue

Has additional fields

location

string

Location of the field causing the issue

path body query

issue

string

required

The reason for the error

Response body

object

name

string

required

Defaults to AuthenticationException

Name of AuthenticationException

AuthenticationException

debugID

string

required

Internal identifier used for correlation purposes.

message

string

required

Message describing the error.

informationLink

string

URI for detailed information related to this error for the developer.

details

array of objects

Additional details for the error.

details

object

field

string

required

Field causing the issue

value

object

Value of the field causing the issue

Has additional fields

location

string

Location of the field causing the issue

path body query

issue

string

required

The reason for the error

Response body

object

name

string

required

Defaults to AuthorizationException

Name of AuthorizationException

AuthorizationException

debugID

string

required

Internal identifier used for correlation purposes.

message

string

required

Message describing the error.

informationLink

string

URI for detailed information related to this error for the developer.

details

array of objects

Additional details for the error.

details

object

field

string

required

Field causing the issue

value

object

Value of the field causing the issue

Has additional fields

location

string

Location of the field causing the issue

path body query

issue

string

required

The reason for the error

Response body

object

name

string

required

Defaults to NotFoundException

Name of NotFoundException

NotFoundException

debugID

string

required

Internal identifier used for correlation purposes.

message

string

required

Message describing the error.

informationLink

string

URI for detailed information related to this error for the developer.

details

array of objects

Additional details for the error.

details

object

field

string

required

Field causing the issue

value

object

Value of the field causing the issue

Has additional fields

location

string

Location of the field causing the issue

path body query

issue

string

required

The reason for the error

Response body

object

name

string

required

Human readable, unique name of the error.

debugID

string

required

Internal identifier used for correlation purposes.

message

string

required

Message describing the error.

informationLink

string

URI for detailed information related to this error for the developer.

details

array of objects

Additional details for the error.

details

object

field

string

required

Field causing the issue

value

object

Value of the field causing the issue

Has additional fields

location

string

Location of the field causing the issue

path body query

issue

string

required

The reason for the error

Updated over 1 year ago

Subscriptions

Create a Subscription

Did this page help you?

Language

Credentials

Bearer

Forto API Key Format

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://public-api.forto.io/v1/events-api/subscriptions?pageSize=50&page=1' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Subscriptions

Create a Subscription

Did this page help you?

Forto Platform API
Shipment
Get Transport Plan Events of a containerget
Get Transport Plan of a containerget
Get Transport Plan Eventsget
Get Transport Planget
Get Transport Planget
Get Transport Planget
Get Invoices of a Shipmentget
Upload a Document for a Shipmentpost
Get Documents of a Shipmentget
Get Shipmentget
List/Filter/Paginate Shipmentsget
Subscriptions
List/Filter/Paginate Inbox Eventsget
Delete a Subscriptiondelete
Create a Subscriptionpost
List/Filter/Paginate Subscriptionsget
Booking Request
Discard a booking requestput
Finalize a booking requestput
Update details of a booking requestput
Create a booking requestpost
List booking requestsget
Get a booking request by its IDget
Reports
Download a reportget
Tokens
Delete a Tokendelete
Paginate/List Tokensget
Create a Tokenpost

Forto Platform API
Shipment
Get Transport Plan Events of a containerget
Get Transport Plan of a containerget
Get Transport Plan Eventsget
Get Transport Planget
Get Transport Planget
Get Transport Planget
Get Invoices of a Shipmentget
Upload a Document for a Shipmentpost
Get Documents of a Shipmentget
Get Shipmentget
List/Filter/Paginate Shipmentsget
Subscriptions
List/Filter/Paginate Inbox Eventsget
Delete a Subscriptiondelete
Create a Subscriptionpost
List/Filter/Paginate Subscriptionsget
Booking Request
Discard a booking requestput
Finalize a booking requestput
Update details of a booking requestput
Create a booking requestpost
List booking requestsget
Get a booking request by its IDget
Reports
Download a reportget
Tokens
Delete a Tokendelete
Paginate/List Tokensget
Create a Tokenpost

200Paginated response of Subscriptions

400Request is malformed

401Authorization failed for this request

403Forbidden

404Requested resource cannot be found

defaultDefault Error