Get a user

GET

/v1/server/users/{external_id}

const url = 'https://app.mondochat.io/v1/server/users/example';
const options = {
  method: 'GET',
  headers: {'Mondochat-App-Id': '<Mondochat-App-Id>', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.mondochat.io/v1/server/users/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Mondochat-App-Id: <Mondochat-App-Id>'

Returns the user with this external id. Server route: send the server secret as a bearer token with Mondochat-App-Id.

Errors: 404 not_found for an unknown or deleted user.

Guide: Users.

Authorizations

app_id
server_secret

Parameters

Path Parameters

external_id

required

External Id

string

/^[A-Za-z0-9._:@-]{1,128}$/

Responses

200

Successful Response

application/json

User

A user of the app, as your server and the chat see them.

object

avatar

Any of:

string
null

string

external_id

required

External Id

The user’s id on your site, the sub claim.

string

required

The user’s id in mondochat.

string format: uuid

kind

required

Kind

member for a user your server signed in, guest for an anonymous one.

string

Allowed values: member guest

name

required

Name

Display name.

string

role

required

Role

A role key from the app’s roles.

string

Example

{
  "avatar": "https://example.test/alice.jpg",
  "external_id": "alice",
  "id": "0199d6a0-1000-7000-8000-000000000001",
  "kind": "member",
  "name": "Alice",
  "role": "member"
}

4XX

Problem

application/problem+json

An RFC 9457 problem: the body of every error answer.

object

code

required

The stable error code to branch on, such as policy_denied.

string

detail

What went wrong this time, when there is more to say.

string | null

errors

For validation, one entry per invalid field.

Array<object>

One invalid field.

object

loc

The path to the field.

array

msg

What is wrong with it.

string

instance

The path of the request.

string

reason

For policy_denied and limit_reached, the rule or limit that refused the request; for forbidden, a short cause such as you_blocked; for banned, temporary when the ban expires.

string

status

required

The HTTP status code.

integer

title

required

A short summary of the problem.

string

type

required

A URL that names the problem, https://app.mondochat.io/problems/<code>.

string

Example

{
  "code": "policy_denied",
  "detail": null,
  "instance": "/v1/conversations/0199d6a0-2000-7000-8000-000000000001",
  "reason": "pins",
  "status": 403,
  "title": "Policy denied",
  "type": "https://app.mondochat.io/problems/policy_denied"
}