---
agentTools:
  projectIndex: https://docs.vizionapi.com/llms.txt
---

# Simplified querying of GET List active references endpoint

## Enhanced Querying for References

The `/references` endpoint has been updated to allow for filtering by multiple criteria, including inactive references using query parameters. This is a non-breaking change

### Permitted Filter Conditions

| Key                  | Description                                                         |
| -------------------- | :------------------------------------------------------------------ |
| container\_id        | Filter results based on a specific container ID                     |
| bill\_of\_lading     | Filter results based on a specific Bill of Lading                   |
| booking\_number      | Filter results based on a specific Booking Number                   |
| carrier\_code        | Filter results based on a specific Carrier                          |
| active               | Filter results based on whether the reference is active or inactive |
| created\_start       | Filter results based on when it was created                         |
| created\_end         | Filter results based on when it was created                         |
| last\_update\_status | Filter results based on a reference's `last_update_status`          |

### Examples:

To show all active references whose last update status is `extraction_failed`:

`{{baseUrl}}/references?last_update_status=extraction_failed`

To show all inactive references under the Bill of Lading 12345678:

`{{baseUrl}}/references?active=false&bill_of_lading=12345678`

To show all active PIL references created between January 1, 2024 and January 15, 2024:

`{{baseUrl}}/references?carrier_code=PCIU&created_start=2024-01-01&created_end=2024-01-15`