Skip to content
KynectLocal Docs

Get user details

GET
/v1/brands/{brandId}/users/{userId}
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

userId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
user
required
object
id
required

User identifier

string format: uuid
email
required

Email address (globally unique)

string format: email
firstName
required

First name

string
lastName
required

Last name

string
isSuperAdmin
required

Platform super-admin flag

boolean
tenantId
required

Tenant identifier

string format: uuid
status
required

Account status: active | suspended

string
lastLoginAt
required

Last login timestamp

string | null format: date-time
createdAt
required

Account creation timestamp

string format: date-time
updatedAt
required

Last update timestamp

string format: date-time
brandRoles

Brand-level role assignments

Array<object>
object
brandId
required

Brand identifier

string format: uuid
role
required

Role within this brand

string
Allowed values: brand_admin franchisee marketing
assignments

Location assignments (franchisee only)

Array<object>
object
locationId
required

Assigned location identifier

string format: uuid
brandId
required

Parent brand identifier

string format: uuid
Example 
{
  "data": {
    "user": {
      "brandRoles": [
        {
          "role": "brand_admin"
        }
      ]
    }
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}