Skip to main content
GET
Search Contacts

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
/api/2.0/oauth2/token/

Query Parameters

city
string

The city to search for contacts.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

q
string

Contact name or fax number to look for.

specialties
string

Comma separated specialties to look for contacts. Examples: "psychology,dental care" or "pharmacy".

state
string

The state to search for contacts.

Response

200 - application/json
results
object[]
required
count
integer
Example:

123

next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"