Searches the directory

Request

Path

tenantIdstringrequired

Parameters to the query

idstringrequired

directory

Bodyapplication/jsonrequired

The query

criteriaobject(Criteria)

pagenumber, (float)(Page)

The page being requested

radius_searchobject(Radius Search)

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/directories/{tenantId}/public/search/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {},
    "page": 0.1,
    "radius_search": {
      "postal_code": "string",
      "radius": 1
    }
  }'

Responses

The contact was merged successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

fieldsArray of objects

queryobject(Query)

rowsArray of objects

sqlstring(Sql)

target_servicestring(Target Service)

The target service of the query

totalNumberOfRowsnumber, (float)(Totalnumberofrows)

Response

{
  "fields": [
    { … }
  ],
  "query": {},
  "rows": [
    {}
  ],
  "sql": "string",
  "target_service": "string",
  "totalNumberOfRows": 0.1
}