Read a contact

GEThttps://<your-url>/api/v2/contacts/{contact}

MCP id contacts.showAlso on this path: PATCH Update a contact, DELETE Delete a contact

Returns one contact in the detail view.

Token scope: api:read:customers
Without it: 403 insufficient-token-scope.
Permission: customers::read
Without it: 403 insufficient-permission.
Rate cost: 1 unit, read bucket.
Also: If-None-Match answers 304 when nothing changed. Never cached: private, no-store. Unknown query parameters are refused, never ignored.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: One contact

curl -G \
  'https://<your-url>/api/v2/contacts/1' \
  --data-urlencode 'include=contactable,role' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

const response = await fetch('https://<your-url>/api/v2/contacts/1?include=contactable%2Crole', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
  },
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->get('https://<your-url>/api/v2/contacts/1?include=contactable%2Crole');

import requests
response = requests.request(
    'GET',
    'https://<your-url>/api/v2/contacts/1?include=contactable%2Crole',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "contactable_type": "customer",
    "contactable_id": 1,
    "contactable": {
      "id": 1
    },
    "contact_role_id": 1,
    "role": null,
    "name": "Marieke de Vries",
    "email": "marieke@example.test",
    "phone": "+31 20 123 4567",
    "address": "…",
    "zip": "…",
    "city": "…"
  }
}

6 more fields, listed under Response

The response carries a strong ETag derived from updated_at; send it back as If-None-Match to get a 304.

Path parameters

contactintegerRequired

The Contact's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-None-Matchstring

The ETag a read is conditional on. A match is answered 304 with no body.

Response 200

Returns a Contact in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

contactable_typestring

The kind of record contactable points at; it says which branch of contactable applies.

customeruser

New values may be added.

contactable_idinteger

The id of the record contactable points at.

contactableRef or CustomerSummary or UserSummary

The record this contact belongs to: a customer for a CRM contact, a user for an employee's emergency contact. Rendered as {"id": N} until named in ?include=contactable, and still as {"id": N} where the caller may not read the parent's prefix. contactable_type and contactable_id are always present, so the parent can be found without the include, and the reference form shows nothing contactable_id does not.