List active references

get

https://demo.vizionapi.com/references

List all active references, sorted by creation date (newest first).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

include_metadata

boolean

Defaults to false

Include pagination metadata in response. See pagination.

limit

integer

Requested limit per paginated page

page

integer

Requested paginated page

active

boolean

Defaults to true

Filter on active

container_id

string

Filter on container_id

bill_of_lading

string

Filter on bill_of_lading

booking_number

string

Filter on booking_number

callback_urls

array of strings

length between 1 and 5

Filter on callback_url

callback_urls

carrier_code

string

enum

Filter on carrier_code

last_update_status

string

enum

Filter on last_update_status

deactivate_reason

array of strings

length ≥ 1

Filter on deactivate_reason. Repeat the parameter to filter on multiple reasons. Combine with active=false to return deactivated references — by default only active references (where deactivate_reason is null) are returned.

deactivate_reason

created_start

date-time

Filter start range of created_at

created_end

date-time

Filter end range of created_at

tag_ids

array of uuids

length between 1 and 10

Filter on tag_ids

tag_ids

tag_names

array of strings

length between 1 and 10

Filter on tag_names

tag_names

Responses

Language

Credentials

Header

URL

Loading…

Response

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

application/json

200List of active references

4XXInvalid request