CHchrt
/orgs
/orgs/accounts

List

Changed on

Lists coordinator-created shipper accounts with association filters, name search, sorting, and pagination. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (AccountListRes)

get/orgs/accounts/list/v1

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/orgs/accounts/list/v1
  • Auth
    HTTP bearer

Query parameters

filter_account_idsstring[] nullable

Filter by selected account ids

searchstring nullable

Full-text account name search query

filter_org_idstring nullable

Must be a string starting with org_

Filter by associated on-CHRT shipper organization

filter_off_chrt_org_data_idstring nullable

Filter by associated off-CHRT shipper organization data

sort_by'name'

Field to sort by

sort_order'asc' | 'desc'

Sort order for query results

Sort order

pageinteger
page_sizeinteger

Response

Successful Response

total_countinteger required

Changes

  • b5a0a0e20ff8Revision changes
    • warning

      deleted the query request parameter filter_account_id

    • info

      added the new optional query request parameter filter_account_ids