Contact - List

Overview

Lists Contact records in the Clearing-House Mechanism with OData-style query parameters for filtering, sorting and paging. Use the collection parameter to restrict the query, e.g. my for your own records (including drafts).

Endpoint

GET /api/v2013/documents

Realm for this application and environment: chm (sent as the Realm HTTP header)

Calls to this endpoint require a bearer token — see User - Authentication.

Query Parameters

Parameter	Description
$filter	Filter expression selecting the record type, e.g. (type eq 'contact').
$orderby	Sort order of the results, e.g. updatedOn desc.
$top	Maximum number of records to return.
$skip	Number of records to skip (paging).
collection	Restrict the query to a collection, e.g. my = own records.

Playground

This playground connects to the production environment (api.cbd.int). Requests made here affect real, live data.

This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.

Swagger playground is loading, please wait...

An error occurred while loading Swagger playground, please refresh the page.