How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Impact

Impact User API

API for managing users, including creation, lookup, and blocking.

Documentation Provider Profile APIs.io OpenAPI GitHub

Impact User API is one of 62 APIs that Impact publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a changelog, and rate-limit docs.

This API exposes 12 operations across 8 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://app.referralsaasquatch.com/api/v1.

12 operations 8 paths 11 schemas 1 DELETE6 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.impact.com/Advertisers/{AccountSID}/
Authentication
HTTP Basic, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Impact User API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP basic authentication (APIKey). An API key is passed in the header as X-SaaSquatch-User-Token (UserJWT). By default, every request must be authenticated.

  • basicAuth — Use your AccountSID as the username and AuthToken as the password.
  • APIKey — Authorize your requests using a tenant's API Key. Use this method only in server-to-server interactions.
  • UserJWT — A JWT for a given user. Used by the Mobile and Web SDKs and other client-side contexts via Open Endpoints.

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User 12

API for managing users, including creation, lookup, and blocking.

POST
/{tenant_alias}/user
Create or Update a User
createUser 1 param body → 200
GET
/{tenant_alias}/user
Lookup a user by Referral Code
findUserByReferralCode 2 params → 200404
GET
/{tenant_alias}/account/{accountId}/user/{userId}
Lookup a user
getUser 3 params → 200404
GET
/{tenant_alias}/account/{accountId}/user/{userId}/pii
Lookup a user PII
getUserPII 3 params → 200404
POST
/{tenant_alias}/account/{accountId}/user/{userId}/block
Block user
blockUser 3 params → 200404
POST
/{tenant_alias}/account/{accountId}/user/{userId}/unblock
Unblock user
unblockUser 3 params → 200404
GET
/{tenant_alias}/users
List users
listUsers 4 params → 200
GET
/{tenant_alias}/open/account/{accountId}/user/{userId}
Lookup a user (Open Endpoint)
openGetUser 5 params → 200401403404
PUT
/{tenant_alias}/open/account/{accountId}/user/{userId}
User Upsert (Open Endpoint)
openUserUpsert 5 params body → 200403
POST
/{tenant_alias}/open/account/{accountId}/user/{userId}
Create a user and account (Open Endpoint)
openCreateUser 5 params body → 201403
DELETE
/{tenant_alias}/open/account/{accountId}/user/{userId}
Delete a user (Open Endpoint)
openDeleteUser 5 params → 204404
GET
/{tenant_alias}/open/user
Get a user by a referral code (Open Endpoint)
openGetUserByCode 2 params → 200403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are UserPII (30 properties), User (19 properties), OpenUser (18 properties), OpenUserUpsert (15 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties
OpenUserUpsert
object
An object describing an individual user submitted to an open endpoint when you want to create or update a user.
15 properties 2 required
UserList
object
3 properties
User
object
A user in the impact.com referral program.
19 properties
ProgramShareLink
object
A map of program IDs to share link sets for that program.
UserStub
object
Request body for creating or updating a user.
9 properties 2 required
UserByCode
object
Minimal user information returned when looking up a user by referral code from the open endpoint.
6 properties
Sharelink
object
Legacy flat-format share links for a user, organised by share medium and engagement medium.
14 properties
UserPII
object
Full personally identifiable information for a user, including rewards, referrals, and share links. Only use in connection with data protection and privacy com…
30 properties
SharelinkEngagementMedium
object
Share links for a single engagement medium in the legacy flat format.
5 properties
OpenUser
object
A user object returned by open endpoints. Includes program share links and custom fields.
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

impact-user-api-openapi.yml Raw ↑

Other APIs Impact publishes across the network.

Impact MCP Server
AE Profile APIs.io
Impact Account API
AE Profile APIs.io
Impact Accounts API
AE Profile APIs.io
Impact Action Inquiries API
AE Profile APIs.io
Impact Action Updates API
AE Profile APIs.io
Impact Actions API
AE Profile APIs.io
Impact Ads API
AE Profile APIs.io
Impact Advertisers API
AE Profile APIs.io
Impact API Submissions API
AE Profile APIs.io
Impact Call Data API
AE Profile APIs.io
Impact Catalog Items API
AE Profile APIs.io
Impact Catalogs API
AE Profile APIs.io
#User
← Back to I APIs
API Details
ID
impact:impact-user-api
Base URL
https://api.impact.com/Advertisers/{AccountSID}/
Docs
https://integrations.impact.com/brand-api-reference
Provider
Impact
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=impact-user-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/impact-user-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Impact User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.