CHchrt
/orgs
/orgs/contacts

List

Changed on

Lists organization-created contacts with associated organizations and accounts expanded. | authz: min_org_role=operator | () -> (ContactListRes)

get/orgs/contacts/list/v1

Request

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

Query parameters

filter_contact_idsstring[] nullable

Filter by selected contact ids

searchstring nullable

Full-text search query

filter_org_idstring nullable

Must be a string starting with org_

Filter by associated on-CHRT organization

filter_off_chrt_org_data_idstring nullable

Filter by associated off-CHRT organization data

filter_account_idstring nullable

Filter by associated account

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

  • 5e62049a1c19Revision changes
    • info

      added the optional property //// to the response with the status

  • b5a0a0e20ff8Revision changes
    • info

      added the new optional query request parameter filter_contact_ids