Get a link - Bilt Rewards Support

Get a link

curl --request GET \
  --url https://partnerapi.biltrewards.com/v1/account-links/{partnerUserId} \
  --header 'Authorization: Bearer <token>'

{
  "linkId": "3b1f6a52-9d0e-4c8a-a1f4-2e6d7c9b8a10",
  "partnerUserId": "p-7f3a9c",
  "linkStatus": "LINKED",
  "linkedAt": "2026-05-01T14:03:22Z",
  "partnerDetails": {}
}

{
  "title": "Constraint Violation",
  "status": 400,
  "violations": [
    {
      "field": "unlink.request.partnerUserId",
      "message": "must not be blank"
    }
  ]
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Unauthorized",
    "requestId": ""
  }
}

{
  "error": {
    "code": "PARTNER_ACCOUNT_NOT_FOUND",
    "message": "No link found for partnerUserId",
    "requestId": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "requestId": "<string>",
    "source": "<string>",
    "retry": true,
    "customProperties": {},
    "humanReadableMessage": true
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "requestId": "<string>",
    "source": "<string>",
    "retry": true,
    "customProperties": {},
    "humanReadableMessage": true
  }
}

Authorizations

Authorization

string

header

required

Preferred. An access token your partner client mints with the client credentials grant. Send it only on the Authorization header. It is not the member access token from the code exchange.

Path Parameters

partnerUserId

string

required

Your account id, as sent when the link was created.

Required string length: 1 - 256

Response

The link, in any state.

linkId

string<uuid>

required

The id of this link episode. Store it; you send it to end the link.

partnerUserId

string

required

Your account id.

linkStatus

enum<string>

required

LINKED is the only usable state. UNLINKED means the member or Bilt support ended the link. LINK_REVOKED means you ended it. UNLINKING_IN_PROGRESS means Bilt is calling you to end it: treat it as unusable but not final, and read it again. A new link after UNLINKED or LINK_REVOKED creates a fresh link.

Available options:

LINKED,

UNLINKED,

LINK_REVOKED,

UNLINKING_IN_PROGRESS

linkedAt

string<date-time>

When the link was created.

partnerDetails

object

Reserved. Currently always an empty object.

⌘I

Get a link

curl --request GET \
  --url https://partnerapi.biltrewards.com/v1/account-links/{partnerUserId} \
  --header 'Authorization: Bearer <token>'

{
  "linkId": "3b1f6a52-9d0e-4c8a-a1f4-2e6d7c9b8a10",
  "partnerUserId": "p-7f3a9c",
  "linkStatus": "LINKED",
  "linkedAt": "2026-05-01T14:03:22Z",
  "partnerDetails": {}
}

{
  "title": "Constraint Violation",
  "status": 400,
  "violations": [
    {
      "field": "unlink.request.partnerUserId",
      "message": "must not be blank"
    }
  ]
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Unauthorized",
    "requestId": ""
  }
}

{
  "error": {
    "code": "PARTNER_ACCOUNT_NOT_FOUND",
    "message": "No link found for partnerUserId",
    "requestId": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "requestId": "<string>",
    "source": "<string>",
    "retry": true,
    "customProperties": {},
    "humanReadableMessage": true
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "requestId": "<string>",
    "source": "<string>",
    "retry": true,
    "customProperties": {},
    "humanReadableMessage": true
  }
}