Skip to content
KynectLocal Docs

Resolve tenant by slug

POST
/v1/auth/tenant-lookup
 
curl --request POST \
  --url https://kynectlocal-production.up.railway.app/v1/v1/auth/tenant-lookup \
  --header 'Content-Type: application/json' \
  --data '{ "slug": "example" }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
slug
required

Tenant slug (from subdomain or login URL)

string
Example generated
{
  "slug": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
tenants
required

Tenants associated with this email

Array<object>
object
id
required

Tenant identifier

string format: uuid
slug
required

Tenant URL slug used in login

string
name
required

Tenant display name

string
isSuperAdmin

Present and true when the user is a platform super-admin

boolean
Example generated
{
  "data": {
    "tenants": [
      {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "slug": "example",
        "name": "example"
      }
    ],
    "isSuperAdmin": true
  }
}

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"
  }
}