Skip to content
KynectLocal Docs

List invitations

GET
/v1/brands/{brandId}/invitations
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/invitations \
  --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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
invitations
required
Array<object>
object
id
required

Invitation identifier

string format: uuid
email
required

Invitee email address

string format: email
role
required

Role to be assigned on acceptance

string
brandId
required

Target brand

string format: uuid
expiresAt
required

Expiry timestamp

string format: date-time
acceptedAt
required

Acceptance timestamp

string | null format: date-time
createdAt
required

Creation timestamp

string format: date-time
Example generated
{
  "data": {
    "invitations": [
      {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "email": "hello@example.com",
        "role": "example",
        "brandId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "expiresAt": "2026-04-15T12:00:00Z",
        "acceptedAt": "2026-04-15T12:00:00Z",
        "createdAt": "2026-04-15T12:00:00Z"
      }
    ]
  }
}

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