API · Contacts

Retrieve Contact

Retrieve a contact by ID or URL-encoded email address (requires full access).

GET/contacts/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Contact id or URL-encoded email (case-insensitive).

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/contacts/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "contact",
  "id": "YOUR_ID",
  "email": "you@example.net",
  "first_name": "example",
  "last_name": "example",
  "created_at": "example",
  "unsubscribed": false,
  "properties": {}
}

Behavior and errors

id accepts a contact ID or a URL-encoded email address; email lookup is case-insensitive. properties lists every defined property as { "value", "type" }, using the property’s fallback when the contact has no value and null when there is none. Missing names are null.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.