GET/v1/profiles/{id}

Retrieve a profile

Fetches a single profile by its Synposter ID. If you don't know the ID but you do know your own external identifier for the user, use the list endpoint with an externalId filter instead.

curl https://api.synposter.com/v1/profiles/9b3a... \
  -H "x-api-key: YOUR_API_KEY"

Response (200)

json
{
  "id": "9b3a...",
  "name": "Alice's Brand",
  "externalId": "user-42",
  "metadata": { "tier": "pro"},
  "createdAt": "2026-04-28T12:00:00Z",
  "updatedAt": "2026-04-28T12:00:00Z"
}
FieldTypeRequiredDescription
idstringYesSynposter's UUID for the profile.
namestringYesThe human-readable label that was set when the profile was created.
externalIdstring | nullYesYour own identifier for this profile, or null if one was never set.
metadataobject | nullYesThe arbitrary JSON metadata you stored on the profile. Null if you never set any.
createdAtstringYesISO 8601 timestamp of when the profile was created.
updatedAtstringYesISO 8601 timestamp of the last time the profile was updated.

Status codes

200The profile was found and returned in the response body.
401The API key was missing or invalid.
404Either no profile with that ID exists, or the profile is owned by a different developer. The same code is returned in both cases so an attacker can't probe for valid IDs.