Get members by vehicle registration

GET /api/members/{vehicleRegistration}/members-details

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Looks up which members have a given vehicle registration recorded against their account. This is the reverse of Get member vehicle details: you have a number plate — read off a barrier camera, typed in at a reception desk — and you want to know whose it is.

Before the lookup runs, every space is removed from the value you send in the path. The comparison against stored registrations is then case-insensitive, but otherwise exact. Create vehicle record for member also removes spaces before saving, so a plate registered as AB12 CDE is found whether you search for AB12 CDE or AB12CDE.

A registration is not unique across members: uniqueness applies only to the pair of member and registration, so two people who share a car each hold their own record and both member ids come back. Treat the result as a set, not a single answer.

The response body is a JSON object with one property, memberIds, holding an array of integer member ids — for example {"memberIds": [1, 2]}. The sample below shows a bare array, which is not what the endpoint returns; code against the object form. Nothing about the member other than the id is returned, so the ids are a starting point rather than an answer — pass each one to Retrieve a member's basic profile details to get a name, or to Get member vehicle details to see the rest of that member's vehicles.

There is no "no match" success case. When no member has the registration, the call fails with 404 and the body No MemberId found for vehicle registration — so handle the miss as an error status, not an empty array.

Endpoint

GET {base_url}/api/members/{vehicleRegistration}/members-details

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`vehicleRegistration`	string	Yes	The number plate to search for, as recorded against a member. Spaces are removed from this value before the lookup, and the match is case-insensitive but otherwise exact — no partial or wildcard matching. Registrations are at most 15 characters, so a longer value can never match. URL-encode the segment if it contains characters that are not safe in a path.

Sample request

cURL

curl -X GET '{base_url}/api/members/{vehicleRegistration}/members-details' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Sample response

200 OK

[
  1
]

Errors

Status	Meaning	When
`400`	Bad request	The registration in the path is empty. Returned with an empty body. In practice a missing path segment returns `404` first, so this is mainly reachable through a path that resolves to an empty string.
`404`	Not found	No member has this registration recorded, once spaces are stripped. The body is the literal string `No MemberId found for vehicle registration`. This is the normal result for an unknown plate, not a fault.
`500`	Internal server error	An unexpected server-side failure while looking up the vehicle records. Returned with an empty body, so there is nothing to parse; retry rather than treating it as "not found".

This page as markdown · All pages · llms.txt