List by org (lister)

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.listing.listings.listByOrgV1({
        filter_audience: "providers",
        sort_by: "created_at_timestamp",
        sort_order: "asc",
        page: 1,
        page_size: 1,
        filter_task_group_id: "filter_task_group_id",
        filter_order_id: "filter_order_id",
        filter_created_by_org_id: "filter_created_by_org_id",
        filter_created_by_user_id: "filter_created_by_user_id",
        filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
        filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
        filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
    });
}
main();

{
  "items": [
    {
      "listing_description": "Urgent shipment of electronics from LA to SF",
      "task_group_id": "tg_9f8e7d6c5b4a3",
      "task_group_summary_for_bidders": "Handle fragile electronics with care, delivery by next Monday",
      "audience": "providers",
      "created_by_user_id": "user_abc123xyz",
      "created_by_org_id": "org_12345abcde",
      "created_at_timestamp": "2024-01-15T09:30:00Z",
      "last_edited_at_timestamp": "2024-01-20T14:45:00Z",
      "status": "open",
      "order_id": "order_20240115_001",
      "order_short_id": "ORD001",
      "_id": "listing_00123456789",
      "schema_version": 1,
      "pro_forma_line_items": [
        {
          "item": "base_rate",
          "rate": 1500,
          "quantity": 1,
          "provenance": "rate_sheet"
        }
      ],
      "share_pro_forma_line_items": true,
      "participant_provider_org_ids": [
        "org_12345abcde"
      ],
      "org_bidding_group_ids": [
        "bg_67890fghij"
      ],
      "participant_driver_ids": [
        "driver_98765zyxwv"
      ],
      "driver_bidding_group_ids": [
        "dbg_54321lkjhg"
      ],
      "type": "dispatch",
      "auto_award_first_accept": true,
      "auto_open_priced_bid_threads": true,
      "internal_notes": "Priority client, ensure all safety protocols followed",
      "order_off_chrt_reference_id": "ref_2024_01_15_001",
      "accepted_bid_thread_id": "bidthread_7890abcd"
    }
  ],
  "total_count": 1
}

Lists listings owned (created) by the caller’s org with filtering, sorting, and pagination. Lister view. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ListingListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

filter_audienceenum or nullOptional

Filter to a single audience (PROVIDERS or DRIVERS). Lister-only — bidder routes hardcode audience.

Allowed values:

sort_byenum or nullOptional

Field to sort by.

Allowed values:

sort_orderenum or nullOptional

Sort order (asc or desc).

Allowed values:

pageinteger or nullOptional>=1Defaults to 1

page_sizeinteger or nullOptional1-100Defaults to 20

filter_statusenum or nullOptional

Filter by listing status(es). Multi-select.

Allowed values:

filter_typeenum or nullOptional

Filter by listing type(s). Multi-select.

Allowed values:

filter_task_group_idstring or nullOptional

Filter to listings for this task group.

filter_order_idstring or nullOptional

Filter to listings on this order.

filter_created_by_org_idstring or nullOptional

Filter to listings created by this provider org (lister). Mostly useful on bidder views to slice by lister.

filter_created_by_user_idstring or nullOptional

Filter to listings created by this operator (audit).

filter_created_at_timestamp_gtedatetime or nullOptional

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltedatetime or nullOptional

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtedatetime or nullOptional

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltedatetime or nullOptional

Filter last_edited_at_timestamp <= value (inclusive).

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Listings List by Org V1request Unprocessable Entity Error