Resolve a recipient's key-registered CLI devices for E2E teammate targeting.

GET

/v1/contacts/devices

const url = 'https://api.share2.us/v1/contacts/devices?email=hello%40example.com';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.share2.us/v1/contacts/devices?email=hello%40example.com' \
  --header 'Authorization: Bearer <token>'

Returns recipient device public keys only when the recipient is registered and their effective inbound policy for the caller is approvals or auto. Disallowed recipients return recipient_not_accepting without device data.

Authorizations

Parameters

Query Parameters

email

required

string format: email

Responses

200

Device list, or an empty recipient_not_registered response.

application/json

One of:

object
object

object

mode

required

string

Allowed values: disallowed approvals auto

devices

required

Array<object>

object

device_id

required

Opaque device session id.

string format: uuid

public_key

required

Recipient device public key. No device name, machine id, or IP metadata is returned.

string

Example

{
  "mode": "disallowed"
}

403

Recipient is not accepting teammate shares from this sender.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}

default

Standard error envelope.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}