> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/user-overview/models.md).

# Models

## The UserStub object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"UserStub":{"description":"Request body for creating or updating a user.","required":["id","accountId"],"properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"email":{"type":"string","format":"email","description":"The user's email address."},"locale":{"type":"string","description":"The user's locale (e.g. `en_US`)."},"countryCode":{"type":"string","description":"The user's ISO 3166-1 Alpha-2 country code (e.g. `US`)."},"referralCode":{"type":"string","description":"A custom referral code to assign to the user."},"customFields":{"type":"object","additionalProperties":true,"description":"Custom fields for this user."}}}}}}
```

## The User object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"User":{"description":"A user in the impact.com referral program.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"lastInitial":{"type":"string","description":"The first initial of the user's last name."},"email":{"type":"string","format":"email","description":"The user's email address."},"emailHash":{"type":"string","description":"An MD5 hash of the user's email address."},"imageUrl":{"type":"string","description":"URL of the user's profile image. Empty string if not set."},"referralCode":{"type":"string","description":"The user's primary referral code."},"cookieId":{"type":"string","nullable":true,"description":"The cookie ID associated with this user."},"paymentProviderId":{"type":"string","nullable":true,"description":"The ID of the user in the payment provider system."},"locale":{"type":"string","nullable":true,"description":"The user's locale (e.g. `en_US`)."},"countryCode":{"type":"string","nullable":true,"description":"The user's ISO 3166-1 Alpha-2 country code (e.g. `US`)."},"referralSource":{"type":"string","nullable":true,"description":"The source of the user's referral."},"firstSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was first seen from."},"lastSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was last seen from."},"dateCreated":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when the user was created."},"dateBlocked":{"type":"integer","format":"int64","nullable":true,"description":"Unix timestamp (milliseconds) when the user was blocked. Null if not blocked."},"shareLinks":{"$ref":"#/components/schemas/Sharelink"}}},"Sharelink":{"description":"Legacy flat-format share links for a user, organised by share medium and engagement medium.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The user's primary share link."},"facebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook."},"twitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter."},"emailShareLink":{"type":"string","format":"uri","description":"The share link for Email."},"linkedinShareLink":{"type":"string","format":"uri","description":"The share link for LinkedIn."},"mobileShareLink":{"type":"string","format":"uri","description":"The share link for mobile devices."},"mobileFacebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook on mobile."},"mobileTwitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter on mobile."},"mobileEmailShareLink":{"type":"string","format":"uri","description":"The share link for Email on mobile."},"EMBED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"POPUP":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"HOSTED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"MOBILE":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"EMAIL":{"$ref":"#/components/schemas/SharelinkEngagementMedium"}}},"SharelinkEngagementMedium":{"description":"Share links for a single engagement medium in the legacy flat format.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The primary share link for this engagement medium."},"facebookShareLink":{"type":"string","format":"uri","description":"The Facebook share link for this engagement medium."},"twitterShareLink":{"type":"string","format":"uri","description":"The Twitter share link for this engagement medium."},"emailShareLink":{"type":"string","format":"uri","description":"The Email share link for this engagement medium."},"linkedinShareLink":{"type":"string","format":"uri","description":"The LinkedIn share link for this engagement medium."}}}}}}
```

## The UserPII object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"UserPII":{"description":"Full personally identifiable information for a user, including rewards, referrals, and share links. Only use in connection with data protection and privacy compliance.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"lastInitial":{"type":"string","description":"The first initial of the user's last name."},"email":{"type":"string","format":"email","description":"The user's email address."},"emailHash":{"type":"string","description":"An MD5 hash of the user's email address."},"imageUrl":{"type":"string","description":"URL of the user's profile image."},"cookieId":{"type":"string","nullable":true,"description":"The cookie ID associated with this user."},"paymentProviderId":{"type":"string","nullable":true,"description":"The ID of the user in the payment provider system."},"locale":{"type":"string","nullable":true,"description":"The user's locale (e.g. `en_US`)."},"countryCode":{"type":"string","nullable":true,"description":"The user's ISO 3166-1 Alpha-2 country code (e.g. `US`)."},"referable":{"type":"boolean","description":"Whether this user can be referred by another user."},"referralSource":{"type":"string","nullable":true,"description":"The source of the user's referral."},"referralCodes":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of program IDs to the user's referral code for that program."},"firstSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was first seen from."},"lastSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was last seen from."},"firstSeenIPLocation":{"type":"string","nullable":true,"description":"The geographic location derived from `firstSeenIP`."},"lastSeenIPLocation":{"type":"string","nullable":true,"description":"The geographic location derived from `lastSeenIP`."},"firstSeenUserAgent":{"type":"string","nullable":true,"description":"The browser user agent string from the user's first session."},"lastSeenUserAgent":{"type":"string","nullable":true,"description":"The browser user agent string from the user's most recent session."},"dateCreated":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when the user was created."},"customFields":{"type":"object","additionalProperties":true,"description":"Custom fields for this user."},"programShareLinks":{"$ref":"#/components/schemas/ProgramShareLink"},"referredByCodes":{"type":"array","items":{"type":"string"},"description":"Referral codes used to refer this user."},"referredByReferrals":{"type":"array","description":"Referral records where this user was the referred party.","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the referral."},"moderationStatus":{"type":"string","description":"The moderation status of the referral."},"dateReferralStarted":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when the referral started."},"dateReferralPaid":{"type":"integer","format":"int64","nullable":true,"description":"Unix timestamp (milliseconds) when the referral was paid."},"dateReferralEnded":{"type":"integer","format":"int64","nullable":true,"description":"Unix timestamp (milliseconds) when the referral ended."},"dateModerated":{"type":"integer","format":"int64","nullable":true,"description":"Unix timestamp (milliseconds) when the referral was moderated."},"referredModerationStatus":{"type":"string","description":"The moderation status of the referred user."},"referrerModerationStatus":{"type":"string","description":"The moderation status of the referrer."},"programId":{"type":"string","nullable":true,"description":"The program ID associated with this referral."},"referredReward":{"type":"object","nullable":true,"description":"The reward earned by the referred user."},"referrerReward":{"type":"object","nullable":true,"description":"The reward earned by the referrer."},"publicMeta":{"type":"object","nullable":true,"description":"Public metadata associated with the referral."},"privateMeta":{"type":"object","nullable":true,"description":"Private metadata associated with the referral."},"fraudSignals":{"type":"object","nullable":true,"description":"Fraud signals detected for this referral."}}}},"rewards":{"type":"object","description":"A paginated list of rewards earned by this user.","properties":{"totalCount":{"type":"integer","description":"Total number of rewards."},"data":{"type":"array","items":{"type":"object"}}}},"rewardBalances":{"type":"array","description":"Aggregated reward balance summaries for this user.","items":{"type":"object","properties":{"type":{"type":"string","description":"The reward type."},"unit":{"type":"string","description":"The unit of the reward."},"count":{"type":"integer","description":"Number of rewards of this type."},"totalAssignedCredit":{"type":"integer","description":"Total credit assigned."},"totalRedeemedCredit":{"type":"integer","description":"Total credit redeemed."},"totalPendingCredit":{"type":"integer","description":"Total credit pending."},"totalExpiredCredit":{"type":"integer","description":"Total credit expired."},"totalCancelledCredit":{"type":"integer","description":"Total credit cancelled."},"prettyAssignedCredit":{"type":"string","description":"Human-readable total assigned credit."},"prettyRedeemedCredit":{"type":"string","description":"Human-readable total redeemed credit."},"prettyPendingCredit":{"type":"string","description":"Human-readable total pending credit."},"value":{"type":"integer","description":"The available (unredeemed) credit balance."},"prettyValue":{"type":"string","description":"Human-readable available balance."}}}},"referrals":{"type":"object","description":"A paginated list of referrals made by this user.","properties":{"totalCount":{"type":"integer","description":"Total number of referrals."},"data":{"type":"array","items":{"type":"object"}}}},"segments":{"type":"array","items":{"type":"string"},"description":"The segments this user belongs to."}}},"ProgramShareLink":{"description":"A map of program IDs to share link sets for that program.","type":"object","additionalProperties":{"type":"object","properties":{"cleanShareLink":{"type":"string","format":"uri","description":"The clean (unencoded) primary share link for this program."},"UNKNOWN":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMAIL":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"MOBILE":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMBED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"POPUP":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"HOSTED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}}}}}}}}
```

## The UserList object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"UserList":{"type":"object","properties":{"count":{"type":"integer"},"totalCount":{"type":"integer"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"User":{"description":"A user in the impact.com referral program.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"lastInitial":{"type":"string","description":"The first initial of the user's last name."},"email":{"type":"string","format":"email","description":"The user's email address."},"emailHash":{"type":"string","description":"An MD5 hash of the user's email address."},"imageUrl":{"type":"string","description":"URL of the user's profile image. Empty string if not set."},"referralCode":{"type":"string","description":"The user's primary referral code."},"cookieId":{"type":"string","nullable":true,"description":"The cookie ID associated with this user."},"paymentProviderId":{"type":"string","nullable":true,"description":"The ID of the user in the payment provider system."},"locale":{"type":"string","nullable":true,"description":"The user's locale (e.g. `en_US`)."},"countryCode":{"type":"string","nullable":true,"description":"The user's ISO 3166-1 Alpha-2 country code (e.g. `US`)."},"referralSource":{"type":"string","nullable":true,"description":"The source of the user's referral."},"firstSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was first seen from."},"lastSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was last seen from."},"dateCreated":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when the user was created."},"dateBlocked":{"type":"integer","format":"int64","nullable":true,"description":"Unix timestamp (milliseconds) when the user was blocked. Null if not blocked."},"shareLinks":{"$ref":"#/components/schemas/Sharelink"}}},"Sharelink":{"description":"Legacy flat-format share links for a user, organised by share medium and engagement medium.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The user's primary share link."},"facebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook."},"twitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter."},"emailShareLink":{"type":"string","format":"uri","description":"The share link for Email."},"linkedinShareLink":{"type":"string","format":"uri","description":"The share link for LinkedIn."},"mobileShareLink":{"type":"string","format":"uri","description":"The share link for mobile devices."},"mobileFacebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook on mobile."},"mobileTwitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter on mobile."},"mobileEmailShareLink":{"type":"string","format":"uri","description":"The share link for Email on mobile."},"EMBED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"POPUP":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"HOSTED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"MOBILE":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"EMAIL":{"$ref":"#/components/schemas/SharelinkEngagementMedium"}}},"SharelinkEngagementMedium":{"description":"Share links for a single engagement medium in the legacy flat format.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The primary share link for this engagement medium."},"facebookShareLink":{"type":"string","format":"uri","description":"The Facebook share link for this engagement medium."},"twitterShareLink":{"type":"string","format":"uri","description":"The Twitter share link for this engagement medium."},"emailShareLink":{"type":"string","format":"uri","description":"The Email share link for this engagement medium."},"linkedinShareLink":{"type":"string","format":"uri","description":"The LinkedIn share link for this engagement medium."}}}}}}
```

## The OpenUser object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"OpenUser":{"description":"A user object returned by open endpoints. Includes program share links and custom fields.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"email":{"type":"string","format":"email","description":"The user's email address."},"imageUrl":{"type":"string","description":"URL of the user's profile image."},"cookieId":{"type":"string","nullable":true,"description":"The cookie ID associated with this user."},"locale":{"type":"string","nullable":true,"description":"The user's locale (e.g. `en_US`)."},"countryCode":{"type":"string","nullable":true,"description":"The user's ISO 3166-1 Alpha-2 country code (e.g. `US`)."},"referable":{"type":"boolean","description":"Whether this user can be referred by another user."},"firstSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was first seen from."},"lastSeenIP":{"type":"string","nullable":true,"description":"The IP address the user was last seen from."},"dateCreated":{"type":"integer","format":"int64","description":"Unix timestamp (milliseconds) when the user was created."},"referralCodes":{"type":"object","additionalProperties":{"type":"string"},"description":"A map of program IDs to the user's referral code for that program."},"programShareLinks":{"$ref":"#/components/schemas/ProgramShareLink"},"customFields":{"type":"object","additionalProperties":true,"description":"Custom fields for this user."},"segments":{"type":"array","items":{"type":"string"},"description":"The segments this user belongs to."},"referredByCodes":{"type":"array","items":{"type":"string"},"description":"Referral codes used to refer this user."}}},"ProgramShareLink":{"description":"A map of program IDs to share link sets for that program.","type":"object","additionalProperties":{"type":"object","properties":{"cleanShareLink":{"type":"string","format":"uri","description":"The clean (unencoded) primary share link for this program."},"UNKNOWN":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMAIL":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"MOBILE":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMBED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"POPUP":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"HOSTED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}}}}}}}}
```

## The UserByCode object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"UserByCode":{"description":"Minimal user information returned when looking up a user by referral code from the open endpoint.","type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the user."},"accountId":{"type":"string","description":"The unique identifier of the account the user belongs to."},"firstName":{"type":"string","description":"The user's first name."},"lastInitial":{"type":"string","description":"The first initial of the user's last name."},"referralCode":{"type":"string","description":"The user's primary referral code."},"imageUrl":{"type":"string","description":"URL of the user's profile image."}}}}}}
```

## The OpenUserStub object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"OpenUserStub":{"description":"Request body for creating or updating a user via an open endpoint.","allOf":[{"$ref":"#/components/schemas/OpenUserUpsert"}]},"OpenUserUpsert":{"title":"A Open User object for Upsert/Create","description":"An object describing an individual user submitted to an open endpoint when you want to create or update a user.","required":["id","accountId"],"properties":{"id":{"type":"string","description":"The unique identifier provided for this user. Use the user's email as their user Id."},"accountId":{"type":"string","description":"The unique identifier of the account. Value must match `id`. Use the user's email as their account Id."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"email":{"type":"string","format":"email","description":"The email address provided for the user."},"referable":{"type":"boolean","description":"Flag to determine whether a user is able to be referred."},"referralCodes":{"type":"object","additionalProperties":{"type":"string"},"description":"The primary custom referral codes for different programs, mapping `programId` to `code`."},"locale":{"type":"string","description":"The user's locale, used for Internationalization (e.g., `en_US`)."},"countryCode":{"type":"string","description":"The user's ISO 3166-1 Alpha-2 country code (e.g., `US`)."},"dateUsTaxFormSubmitted":{"type":"integer","format":"int64","description":"The timestamp of when a user's W-9 tax form was submitted."},"referredByCodes":{"type":"array","items":{"type":"string"},"description":"An array of referral codes used to refer this account."},"cookies":{"type":"string","description":"The Base64URL encoded attribution cookie values."},"segments":{"type":"array","items":{"type":"string"},"description":"A list of operations for adding and removing a user from segments (e.g., `[\"segment1\", \"~segment2\"]`)."},"shareLinks":{"type":"object","additionalProperties":{"type":"string"},"description":"The primary custom shareLinks for different programs, mapping `programId` to `sharelink`."},"customFields":{"type":"object","additionalProperties":true,"description":"An object containing the custom fields for this user."}}}}}}
```

## The OpenUserUpsert object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"OpenUserUpsert":{"title":"A Open User object for Upsert/Create","description":"An object describing an individual user submitted to an open endpoint when you want to create or update a user.","required":["id","accountId"],"properties":{"id":{"type":"string","description":"The unique identifier provided for this user. Use the user's email as their user Id."},"accountId":{"type":"string","description":"The unique identifier of the account. Value must match `id`. Use the user's email as their account Id."},"firstName":{"type":"string","description":"The user's first name."},"lastName":{"type":"string","description":"The user's last name."},"email":{"type":"string","format":"email","description":"The email address provided for the user."},"referable":{"type":"boolean","description":"Flag to determine whether a user is able to be referred."},"referralCodes":{"type":"object","additionalProperties":{"type":"string"},"description":"The primary custom referral codes for different programs, mapping `programId` to `code`."},"locale":{"type":"string","description":"The user's locale, used for Internationalization (e.g., `en_US`)."},"countryCode":{"type":"string","description":"The user's ISO 3166-1 Alpha-2 country code (e.g., `US`)."},"dateUsTaxFormSubmitted":{"type":"integer","format":"int64","description":"The timestamp of when a user's W-9 tax form was submitted."},"referredByCodes":{"type":"array","items":{"type":"string"},"description":"An array of referral codes used to refer this account."},"cookies":{"type":"string","description":"The Base64URL encoded attribution cookie values."},"segments":{"type":"array","items":{"type":"string"},"description":"A list of operations for adding and removing a user from segments (e.g., `[\"segment1\", \"~segment2\"]`)."},"shareLinks":{"type":"object","additionalProperties":{"type":"string"},"description":"The primary custom shareLinks for different programs, mapping `programId` to `sharelink`."},"customFields":{"type":"object","additionalProperties":true,"description":"An object containing the custom fields for this user."}}}}}}
```

## The Error object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"Error":{"properties":{"statusCode":{"description":"The HTTP status code of the error.","type":"integer","format":"int32"},"message":{"description":"The human-readable description of what went wrong. Use this to help you debug.","type":"string"},"apiErrorCode":{"description":"A machine-readable error code.","type":"string"},"rsCode":{"description":"A secondary machine-readable error code.","type":"string"}}}}}}
```

## The Sharelink object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"Sharelink":{"description":"Legacy flat-format share links for a user, organised by share medium and engagement medium.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The user's primary share link."},"facebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook."},"twitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter."},"emailShareLink":{"type":"string","format":"uri","description":"The share link for Email."},"linkedinShareLink":{"type":"string","format":"uri","description":"The share link for LinkedIn."},"mobileShareLink":{"type":"string","format":"uri","description":"The share link for mobile devices."},"mobileFacebookShareLink":{"type":"string","format":"uri","description":"The share link for Facebook on mobile."},"mobileTwitterShareLink":{"type":"string","format":"uri","description":"The share link for Twitter on mobile."},"mobileEmailShareLink":{"type":"string","format":"uri","description":"The share link for Email on mobile."},"EMBED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"POPUP":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"HOSTED":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"MOBILE":{"$ref":"#/components/schemas/SharelinkEngagementMedium"},"EMAIL":{"$ref":"#/components/schemas/SharelinkEngagementMedium"}}},"SharelinkEngagementMedium":{"description":"Share links for a single engagement medium in the legacy flat format.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The primary share link for this engagement medium."},"facebookShareLink":{"type":"string","format":"uri","description":"The Facebook share link for this engagement medium."},"twitterShareLink":{"type":"string","format":"uri","description":"The Twitter share link for this engagement medium."},"emailShareLink":{"type":"string","format":"uri","description":"The Email share link for this engagement medium."},"linkedinShareLink":{"type":"string","format":"uri","description":"The LinkedIn share link for this engagement medium."}}}}}}
```

## The SharelinkEngagementMedium object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"SharelinkEngagementMedium":{"description":"Share links for a single engagement medium in the legacy flat format.","type":"object","properties":{"shareLink":{"type":"string","format":"uri","description":"The primary share link for this engagement medium."},"facebookShareLink":{"type":"string","format":"uri","description":"The Facebook share link for this engagement medium."},"twitterShareLink":{"type":"string","format":"uri","description":"The Twitter share link for this engagement medium."},"emailShareLink":{"type":"string","format":"uri","description":"The Email share link for this engagement medium."},"linkedinShareLink":{"type":"string","format":"uri","description":"The LinkedIn share link for this engagement medium."}}}}}}
```

## The ProgramShareLink object

```json
{"openapi":"3.1.0","info":{"title":"impact.com API - User","version":"2.0.0"},"components":{"schemas":{"ProgramShareLink":{"description":"A map of program IDs to share link sets for that program.","type":"object","additionalProperties":{"type":"object","properties":{"cleanShareLink":{"type":"string","format":"uri","description":"The clean (unencoded) primary share link for this program."},"UNKNOWN":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMAIL":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"MOBILE":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"EMBED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"POPUP":{"type":"object","additionalProperties":{"type":"string","format":"uri"}},"HOSTED":{"type":"object","additionalProperties":{"type":"string","format":"uri"}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/user-overview/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.