Get user by id

GET 
/api/v2/users/:user_id

Retrieve a user by their id, or 'me' for the current user

Request

Path Parameters

user_id stringrequired

Responses

200

application/json

Schema

Schema

id uuidrequired

Unique ID of the user

name stringnullable

Name of the user

email stringrequired

Email of the user

role stringrequired

Possible values: [admin, group_manager, business_manager]

Role of the user

email_confirmed booleanrequired

Whether the user has confirmed their email

language stringnullable

Language of the user

permissions

object

required

home string[]

Possible values: [read, write]

dashboard string[]

Possible values: [read, write]

website string[]

Possible values: [read, write]

reservations string[]

Possible values: [read, write]

crm string[]

Possible values: [read, write]

reviews string[]

Possible values: [read, write]

suppliers string[]

Possible values: [read, write]

product_catalog string[]

Possible values: [read, write]

basic_information string[]

Possible values: [read, write]

opening_hours string[]

Possible values: [read, write]

activity string[]

Possible values: [read, write]

photos string[]

Possible values: [read, write]

posts string[]

Possible values: [read, write]

presence string[]

Possible values: [read, write]

business_creation string[]

Possible values: [read, write]

Example (from schema)

{
  "id": "70996641-8d6e-4b10-bee5-44633bc306e8",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "role": "business_manager",
  "email_confirmed": true,
  "language": "en",
  "permissions": {
    "home": [
      "read"
    ],
    "dashboard": [
      "read"
    ],
    "website": [
      "read"
    ],
    "reservations": [
      "read"
    ],
    "crm": [
      "read"
    ],
    "reviews": [
      "read"
    ],
    "suppliers": [
      "read"
    ],
    "product_catalog": [
      "read"
    ],
    "basic_information": [
      "read"
    ],
    "opening_hours": [
      "read"
    ],
    "activity": [
      "read"
    ],
    "photos": [
      "read"
    ],
    "posts": [
      "read"
    ],
    "presence": [
      "read"
    ],
    "business_creation": [
      "read"
    ]
  }
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...