CHchrt
/listing

List by org (lister)

Changed on

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)

get/listing/listings/list_by_org/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/listing/listings/list_by_org/v1
  • Auth
    HTTP bearer

Query parameters

filter_audience'providers' | 'drivers'

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

sort_by'created_at_timestamp' | 'last_edited_at_timestamp'

Field to sort by.

sort_order'asc' | 'desc'

Sort order for query results

Sort order (asc or desc).

pageinteger
page_sizeinteger
filter_statusListingStatusEnum[] nullable

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

filter_typeListingTypeEnum[] nullable

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

filter_task_group_idstring nullable

Filter to listings for this task group.

filter_order_idstring nullable

Filter to listings on this order.

filter_created_by_org_idstring nullable

Must be a string starting with org_

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

filter_created_by_user_idstring nullable

Must be a string starting with user_

Filter to listings created by this operator (audit).

filter_created_at_timestamp_gtestring date-time nullable

Filter created_at_timestamp >= value (inclusive).

filter_created_at_timestamp_ltestring date-time nullable

Filter created_at_timestamp <= value (inclusive).

filter_last_edited_at_timestamp_gtestring date-time nullable

Filter last_edited_at_timestamp >= value (inclusive).

filter_last_edited_at_timestamp_ltestring date-time nullable

Filter last_edited_at_timestamp <= value (inclusive).

Response

Successful Response

total_countinteger required

Changes

  • 9a30893d8db1Revision changes
    • warning

      added the new tax enum value to the //// response property for the response status

    • info

      removed the XXX enum value from the //// response property for the response status

    • info

      removed the tax_1 enum value from the //// response property for the response status

    • info

      removed the tax_2 enum value from the //// response property for the response status

    • info

      removed the tax_3 enum value from the //// response property for the response status