Address Search

Base Path: /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/addresses/search

Version: 3.5.0

The Address Search API searches for a contact or contact group based on the criteria provided.

Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.

Methods

Find provider (simple search)

POST /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/addresses/search/

Finds the Direct email addresses of healthcare workers (providers) based on the criteria provided.

Parameters

Name

Type

Data Type

Description

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload: 

{
  "searchString": "search",
  "maxResult": 15
}


Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.


Sample Value: developer.portal@example.com

Responses

application/json+fhir

200

We found a list of providers that match the search criteria.

application/json+fhir

400

Your request was invalid. A parameter, or the data in a parameter, may be incorrect.

application/json+fhir

401

Your API key or access token has expired or is invalid.

Sample Request

curl -X POST "https://api.orionhealth.io/actor/current/webmail/DIRECT/mailboxes/developer.portal@example.com/addresses/search/" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
-d '{"searchString":"search","maxResult":15}'

Find contact

POST /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/addresses/search/contact

Searches for contacts, in the address book, using the search string provided.

Parameters

Name

Type

Data Type

Description

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload: 

{
  "searchString": "search",
  "maxResult": 15
}


Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.


Sample Value: developer.portal@example.com

Responses

application/json+fhir

200

We found a list of contacts that match the search criteria.

application/json+fhir

400

Your request was invalid. A parameter, or the data in a parameter, may be incorrect.

application/json+fhir

401

Your API key or access token has expired or is invalid.

Sample Request

curl -X POST "https://api.orionhealth.io/actor/current/webmail/DIRECT/mailboxes/developer.portal@example.com/addresses/search/contact" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
-d '{"searchString":"search","maxResult":15}'

Find contact group

POST /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/addresses/search/group

Searches for contact groups, in the address book, using the search string you provide.

Parameters

Name

Type

Data Type

Description

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload: 

{
  "searchString": "search",
  "maxResult": 15
}


Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.


Sample Value: developer.portal@example.com

Responses

application/json+fhir

200

We found one or more contact groups that match the search criteria.

application/json+fhir

401

Your API key or access token has expired or is invalid.

Sample Request

curl -X POST "https://api.orionhealth.io/actor/current/webmail/DIRECT/mailboxes/developer.portal@example.com/addresses/search/group" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
-d '{"searchString":"search","maxResult":15}'