Skip to main content

Lookup User Public Key (v2)

This endpoint expands upon the v1 endpoint by allowing multiple query keys to be used in a single request, this allows for batches of up to 25 users to be queried in a single request.

FieldDescription
emailEmail addresses
telephoneE.164 formatted telephone numbers
localKeySentry Interactive identifier for a user (UUID)
foreignKeyThird-party application's identifier for a user

HTTP Request

POST https://api.doordeck.com/directory/query

Request Headers

HeaderRequiredDescription
Accepttrueapplication/vnd.doordeck.api-v2+json

Request Parameters

The request body must have one and only one of the following fields.

ParameterRequiredDescription
emailfalseEmail addresses
telephonefalseE.164 formatted telephone numbers
localKeyfalseSentry Interactive identifier for users (UUID)
foreignKeyfalseThird-party application's identifier for a users

Example

CURL
curl 'https://api.doordeck.com/directory/query' \
-H 'Accept: application/vnd.doordeck.api-v2+json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TOKEN' \
--data-raw '{
"email": ["example1@doordeck.com", "example2@doordeck.com"],
"localKey": ["ee03c470-c080-11e6-9b35-cb2329105e85"],
"foreignKey": ["5a5f6e80-3c51-11e6-9e57-cf40be3013fb"]
}'
Remember
  • Replace TOKEN with your access token.