By task group

GET

/listing/listings/by_task_group/v1/:task_group_id

GET

/listing/listings/by_task_group/v1/:task_group_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.listing.listings.byTaskGroupV1("task_group_id");
8 }
9 main();

1 [
2   {
3     "listing_description": "listing_description",
4     "task_group_id": "task_group_id",
5     "task_group_summary_for_bidders": "task_group_summary_for_bidders",
6     "audience": "providers",
7     "created_by_user_id": "created_by_user_id",
8     "created_by_org_id": "created_by_org_id",
9     "created_at_timestamp": "2024-01-15T09:30:00Z",
10     "last_edited_at_timestamp": "2024-01-15T09:30:00Z",
11     "status": "open",
12     "order_id": "order_id",
13     "order_short_id": "order_short_id",
14     "_id": "_id",
15     "schema_version": 1,
16     "pro_forma_line_items": [
17       {
18         "item": "base_rate",
19         "rate": 1.1,
20         "quantity": 1.1,
21         "provenance": "rate_sheet"
22       }
23     ],
24     "share_pro_forma_line_items": true,
25     "participant_provider_org_ids": [
26       "participant_provider_org_ids"
27     ],
28     "org_bidding_group_ids": [
29       "org_bidding_group_ids"
30     ],
31     "participant_driver_ids": [
32       "participant_driver_ids"
33     ],
34     "driver_bidding_group_ids": [
35       "driver_bidding_group_ids"
36     ],
37     "type": "dispatch",
38     "auto_award_first_accept": true,
39     "auto_open_priced_bid_threads": true,
40     "internal_notes": "internal_notes",
41     "order_off_chrt_reference_id": "order_off_chrt_reference_id",
42     "accepted_bid_thread_id": "accepted_bid_thread_id"
43   }
44 ]

Fetches all listings for a single task group. Typically returns one or two (dual-audience siblings) OPEN listings during active bidding plus any terminal history. Visible only to the task group’s coordinator. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[Listing1])

Authentication

AuthorizationBearer

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

Path parameters

task_group_idstringRequired

Response

Successful Response

listing_descriptionstring

task_group_idstring

task_group_summary_for_biddersstring

audienceenum

created_by_user_idstring

Must be a string starting with user_

created_by_org_idstring

Must be a string starting with org_

created_at_timestampdatetime

last_edited_at_timestampdatetime

statusenum

order_idstring

order_short_idstring

_idstring

schema_versionintegerDefaults to 1

pro_forma_line_itemslist of objects

share_pro_forma_line_itemsbooleanDefaults to false

participant_provider_org_idslist of strings

org_bidding_group_idslist of strings

participant_driver_idslist of strings

driver_bidding_group_idslist of strings

typeenum

auto_award_first_acceptbooleanDefaults to false

auto_open_priced_bid_threadsbooleanDefaults to false

internal_notesstring<=524288 characters

order_off_chrt_reference_idstringformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

accepted_bid_thread_idstring

Errors

422

Listings by Task Group V1request Unprocessable Entity Error