Get profile completeness score

GET

/v1/brands/{brandId}/profile/{locationId}/readiness

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

• Authenticated API (v1)
• Public API (no auth required)

Authorizations

• BearerAuth

Parameters

Path Parameters

brandId

required

string format: uuid

Brand identifier

locationId

required

string format: uuid

Location identifier

Responses

200

Success

Media type application/json

object

data

required

object

score

required

Profile completeness score (0–100)

integer

<= 100

missing

required

List of missing required field names

Array<string>

Example ^generated

{
  "data": {
    "score": 1,
    "missing": [
      "example"
    ]
  }
}

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

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

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

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

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