Get a directory entry

gethttps://api.expiryedge.com/v1/getDirectoryEntry

any role (admin, editor or viewer)60/min

Request

curl 'https://api.expiryedge.com/v1/getDirectoryEntry?id=dir_6Hv3' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"

Response

{
  "id": "dir_6Hv3",
  "name": "Contoso Legal",
  "type": "Vendor",
  "customType": "",
  "phone": "+15550198765",
  "email": "billing@contosolegal.example",
  "address": "400 Market St, Springfield",
  "notes": "Outside counsel for licensing.",
  "typedFields": {
    "website": "https://contosolegal.example"
  },
  "customFields": [],
  "organization_id": "org_northwind",
  "user_id": "u_71bXq",
  "createdAt": "2026-09-27T14:05:00.000Z",
  "updatedAt": "2026-09-27T14:05:00.000Z"
}

Returns the entry as a flat object. An entry in another organization returns 403.

Query parameters

idstringrequired
Directory entry id.

Returns

200

The entry.

namestring
Required on create.
typestring
One of Person, Company, Vendor, Client, Partner, Asset, Property, Other. Defaults to Person.
customTypestring
Custom type label; kept only when type is Other.
phonestring
emailstring
addressstring
notesstring
typedFieldsobject
Type-specific fields as key -> value (e.g. website).
customFieldsarray of objects
Free-form label/value pairs; items without a label are dropped.
idstringread-only
organization_idstringread-only
user_idstringread-only
Creator's user id.
createdAtstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time
updatedAtstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time

Errors

`400`	The request is missing required fields or contains invalid values.
`401`	Missing, expired or invalid bearer token.
`403`	Authenticated, but your role or organization does not allow this action.
`404`	The record does not exist or is not in your organization.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.
`500`	Unexpected server error. Retry later; quote `requestId` to support.