Sign in
/orgs
/orgs/accounts

List

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

Query parameters

filter_account_idsstring[] nullable

Filter by selected account ids

Filter by selected account ids

searchstring nullable

Full-text account name search query

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

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

itemsAccount1[] required— unresolved $ref
total_countinteger required

Changes

Changed in 1 of the 9 revisions of this API.11

  • b5a0a0e20ff811See the full diff
    • ●

      deleted the query request parameter filter_account_id

      request-parameter-removed

    • ○

      added the new optional query request parameter filter_account_ids

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog