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
Sponsorunited

SponsorUnited API

The production REST API behind the SponsorUnited platform. Its OpenAPI 3.0 description is publicly served at https://api.sponsorunited.com/docs and describes 547 operations across 422 paths and 561 schemas, covering brands, properties, leagues, agencies, events, contacts, deals and spend tracking, saved and custom reports, scouting audits, social scraping, news, user and organization management, and the Surface AI assistant. Authentication is a bearer JWT for platform users plus an X-API-Key service key for internal services. SponsorUnited publishes no developer documentation, reference site or sign-up path for this API.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 547 operations across 422 paths, organized into 86 resource areas, and defines 561 schemas. It is described by OpenAPI 3.0.0, at version v1.

Requests are made against the base URL https://api.sponsorunited.com.

547 operations 422 paths 561 schemas 56 DELETE260 GET2 PATCH140 POST89 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1
Base URL
https://api.sponsorunited.com
Authentication
HTTP Bearer, API Key
Resource Areas
86

Authentication & Security 2

SponsorUnited API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-API-Key (apiKeyAuth).

  • apiKeyAuth — Service API key for external services (ai-api, chat-api). Generate with: php artisan su:api-token:generate

Paths & Operations 547

Across 422 paths, the API surfaces 547 operations — 56 DELETE, 260 GET, 2 PATCH, 140 POST, 89 PUT. They span 86 resource areas, including AI Chatbot, Admin Surface Context, Agency, AgencyServices, AgencyServicesType, Asset Groupings, Asset Subgroupings, Audits, and 78 more. Each is listed below with its method, path, parameters, and response codes.

AI Chatbot 1

AI Chatbot

GET
/api/ai-chatbot/access
Get AI chatbot access token
db297135cc617e1f4ea5407ef93e0343 → 200
Admin Surface Context 4

Administrator-set Surface context for users and organizations

GET
/api/user/{userId}/surface/admin-context
Get a user's administrator-set Surface context
e9df1a6f4ce6e021b4f3ff72262a5a67 1 param → 200401403404
PUT
/api/user/{userId}/surface/admin-context
Update a user's administrator-set Surface context
09be3d68eb05cce7eaf3d639adb3ec00 1 param body → 200401403404422
GET
/api/organization/{organizationId}/surface/admin-context
Get an organization's administrator-set Surface context
52df41e9cf877a06a1d0a91e3517e2d0 1 param → 200401403404
PUT
/api/organization/{organizationId}/surface/admin-context
Update an organization's administrator-set Surface context
57494f69be64682492a50cc084a7996f 1 param body → 200401403404422
Agency 5

Agency

POST
/api/agency
Create a new agency
1387e8e891a95fcc75a59818ab8ed345 body → 200
GET
/api/agency/{id}
Get agency details
8f592b30c702d786206f4af44f62656d 2 params → 200
PUT
/api/agency/{id}
Update an agency
2ada65983d8b161abd1b6df83fdd09ca 1 param body → 200
DELETE
/api/agency/{id}
Delete an agency
444a655b9280f1ef01ed3e6da2710f55 1 param → 204200
GET
/api/agency/{id}/representation
Get agency representation
924e90a51d9fe2c213d2ef0ee6048db2 1 param → 200
AgencyServices 5

AgencyServices

GET
/api/agency-services
List agency services
85bce9769d63ca8dad86af3f42cb6150 → 200
POST
/api/agency-services
Create agency service
bfbab5f8ae68d4b5e57d2fd823eeae7d body → 200
GET
/api/agency-services/{id}
Get agency service
b04e408d558c062de7bb82899f31b744 1 param → 200
PUT
/api/agency-services/{id}
Update agency service
142b17c11ca48d83b3e2ce56afdea2d5 body → 200
DELETE
/api/agency-services/{id}
Delete agency service
bb5672bb8cda537bd4fc59c8b5f658bd 1 param → 204
AgencyServicesType 5

AgencyServicesType

GET
/api/agency-services-types
List agency service types
e741361353dffb28f2d2360486ead685 → 200
POST
/api/agency-services-types
Create agency service type
4220a5c00d542910c4a18d46e9eb8f8e body → 200
GET
/api/agency-services-types/{type_id}
Get agency service type
b4e4f49e59e0651f4de4ab71afb32d75 1 param → 200
PUT
/api/agency-services-types/{type_id}
Update agency service type
d44a64dbb51364ce2ddee8d04bfd2d8b body → 200
DELETE
/api/agency-services-types/{type_id}
Delete agency service type
75ed2ac36401e5549e10cc290d6e7c3e 1 param → 204
Asset Groupings 6

Asset Groupings

GET
/api/asset-grouping
List all asset groupings
f08b79a015056c8d4bd68063aa05cb8e 1 param → 200
POST
/api/asset-grouping
Create asset grouping
1390482d2e687fc2fd012794a51c7769 body → 200
GET
/api/asset-grouping/{id}
Get asset grouping
5b2f6ebcc14c9db79b7eead42722a3d3 1 param → 200
PUT
/api/asset-grouping/{id}
Update asset grouping
8c2481c0f8bd2c903fe90e204089a587 1 param body → 200
DELETE
/api/asset-grouping/{id}
Delete asset grouping
fca80b6282fcf00122c60f4b336f308b 1 param → 204
PUT
/api/asset-grouping/{old_grouping}/reassign
Reassign asset grouping
1838061788f7a8e5f4af39b182b6fc75 1 param body → 200
Asset Subgroupings 8

Asset Subgroupings

GET
/api/asset-subgrouping/
List all asset subgroupings
ab50fb3a5295ae73d825ecb7c7543008 → 200
POST
/api/asset-subgrouping
Create asset subgrouping
10e2ffa916cfeaf6e4d8360511b64908 body → 200
GET
/api/asset-subgrouping/{id}
Get asset subgrouping
5298a5dfd5179098c87173ff85b91f0e 1 param → 200
PUT
/api/asset-subgrouping/{id}
Update asset subgrouping
02261538464d9b2e00ca4513c83ec0db 1 param body → 200
DELETE
/api/asset-subgrouping/{id}
Delete asset subgrouping
4918ef38b51abd58cec25b79dcc6f41d 1 param → 204
GET
/api/asset-subgrouping/{id}/intent
Get subgrouping intent data
40322c27f64945cb564c31f36ddb9557 1 param → 200
PUT
/api/asset-subgrouping/{oldGrouping}/reassign/{newGrouping}
Reassign asset subgrouping
f0158fb0e40bb7841ed8dbcf14e761ed 2 params → 200
PUT
/api/asset-subgrouping/tag/{oldTag}
Update subgrouping tag
8d5112c31deb47ed1eea83a8e5e290af 1 param body → 200
Audits 19

Audit management endpoints for scouting reports

GET
/api/audit/{event_id}/team/{team_id}/company/{brand_id}
Get audit by brand for current user
11f41b8d9f2333f1e9d669b8b620291b 3 params → 200401
GET
/api/audit/{event_id}/team/{team_id}/review/{user_id}
Get audits for review
a66f6d57d90708be64f31f82049c8ec0 3 params → 200401
POST
/api/audit/{event_id}/team/{team_id}/review/{user_id}
Update user events with audits and item values
5f74e3e99c601565edd0082beb9b22e4 3 params body → 200401
GET
/api/audit/{event_id}/team/{team_id}/user/{user_id}/user-event-media-data
Get processed media data for user event
c2d679de4e9b5f5a66275c665a3d64fd 3 params → 200401
GET
/api/audit/{event_id}/property/{property_id}/review/{user_id}/bulk-keyword
Get audits for review with bulk keyword
8a6eda06ac278f55392a045e0daa61f5 4 params → 200401
GET
/api/audit/{event_id}/team/{team_id}/review/{user_id}/download
Download scouting report as CSV
835aa69e78cfd97f28a3250ef9dd152f 3 params → 200401403
GET
/api/audit/{event_id}/team/{team_id}/review/{user_id}/metadata
Get metadata for audit review
18e9b885369719fd5a75f7cd189967e2 3 params → 200
GET
/api/audit/{event_id}/team/{team_id}/review/{user_id}/list
Get paginated audit reviews with filters
c9d456156a2d80efed9836b8037bdb99 11 params → 200401422
GET
/api/audit/{event_id}/team/{team_id}/review/{user_id}/counts
Get review counts for property or league
caf9e363d73ccca9b52e15e301a9feac 7 params → 200401
GET
/api/scan/{event_id}
Get social scan review data
0f04091bcfcc3578f8420eaff7eced9c 1 param → 200401404
GET
/api/audit/{event_id}/team/{team_id}/item/{item_id}
Get audit by item
20f7cc34b17295e7a51087a18e5ca466 3 params → 200401
POST
/api/audit/bulk
Bulk add audits with item values
b10728f6765ff75d8823617fb604ace8 body → 200401422
POST
/api/audit/{event_id}/team/{team_id}/company/{brand_id}/{season}
Save audit with item values for a brand
7dd5498c9b500f69b94469e9ab629819 4 params body → 200401404
PUT
/api/audit/{event_id}/team/{team_id}/review/{user_id}/move-company
Move item values to a different company
0a354ddfd3c05e4a2eaf1397f6e1bd75 3 params body → 200401
DELETE
/api/audit/remove/{audit_id}
Delete an audit
c19d7bf70a1a96519334dafffe93686c 1 param → 204400401403404
POST
/api/audit/{audit_id}/item-value/{item_value_id}/copy
Copy an audit with item value to a new brand
0d13d137407bd238fa27162c338433ad 2 params body → 200400401
GET
/api/audit-count/{league_id}
Get audit counts for a league
f9180cac12467d118ff86fc38269e8c6 1 param → 200401404
PUT
/api/audit/{eventId}/team/{propertyId}/review/{userId}/bulk-clear-keyword-phrase
Clear keywords from item value descriptions
712b63adadb83ca2bef9753fa889804d 3 params body → 200401
POST
/api/audit/{event_id}/property/{property_id}/review/{user_id}/bulk-reassign-brand
Bulk reassign brand for item values
af3d7add39e7bcc43b983b0bf4568572 3 params body → 200401403
Audit Review 4

Audit Review

POST
/api/audit/{eventId}/team/{propertyId}/review/{userId}/bulk-clone
Bulk clone item values to a different asset within audit review. Omit itemvalueids to clone all.
88c7a43f29eb45595efe1c8449d8c18d 3 params body → 200401403422
PUT
/api/audit/{eventId}/team/{propertyId}/review/{userId}/bulk-update
Bulk update item values within audit review. Omit itemvalueids to update all.
9aa2de5802da6550bb9bfadc67cc8864 3 params body → 200401403422
DELETE
/api/audit/{eventId}/team/{propertyId}/review/{userId}/bulk-delete
Bulk delete item values within audit review. Omit itemvalueids to delete all.
adfa94558a981085a8c0da43a073249d 3 params body → 204401403422500
POST
/api/audit/{eventId}/team/{propertyId}/review/{userId}/bulk-reject
Bulk reject item values within audit review. Omit itemvalueids to reject all.
80b7d75859134740e8a5133a37bd87ec 3 params body → 204401403422500
AuditSynonyms 3

AuditSynonyms

GET
/api/audit/{event_id}/synonyms
List audit synonyms
b581d853897a9b3ff9add213c501b345 1 param → 200
POST
/api/audit/{event_id}/synonyms/{synonym_id}/accept
Accept audit synonym
63f94f886fbb7b6c867c1ab5a6940c84 2 params → 200
DELETE
/api/audit/{event_id}/synonyms/{synonym_id}
Delete audit synonym
2bed846d99e1b893ed8957e591ed76ff 2 params → 200
Authentication 9

Authentication

POST
/api/auth/login
Authenticate user
535ffeda4b78916efd658b2844ea897a body → 200
GET
/api/auth/logout
Logout user
8e5dc3654b57a13f0272f04962926281 → 200
GET
/api/auth/pin/send/{mfaOption}
Send MFA PIN
5c72ebefedf27de4e2552c970a09eeb9 1 param → 200401429500503
POST
/api/auth/pin/verify
Verify MFA PIN
5f4adbec6a6eedd8be6332f0b05cabb8 body → 200401429
GET
/api/email-exists
Check if email exists
345afa474b4097d1f2b85998d47f77c8 1 param → 200422
GET
/api/verify/{token}
Verify user email
42c9e8cadeae189ee4abcfb844d7f9ee 1 param → 200
POST
/api/enroll
Enroll new user
1ed175346dbfc108bd5f7654afbcba0b body → 200422
POST
/api/auth/passwords/email
Send password reset email
d35a865c89c7b6977ccbfffbf4dbf5a4 body → 200422
POST
/api/auth/passwords/reset
Reset password
af7b3ac0f01be02abbf5b940f6c10e96 body → 200422
Brand Competitors 5

Brand Competitors

GET
/api/admin/brand-competitors/review-items
List brand competitor review items
ef33ce8f47232350778e28b7a8128da2 7 params → 200401403
GET
/api/admin/brand-competitors/review-items/summary
Summary of the brand competitor review queue
06edd57996f87e3cf16b3f38425bdd9d → 200401403
GET
/api/admin/brand-competitors/review-items/{id}
Show a brand competitor review item
5994068bc291fd6584835d19294042fb 1 param → 200401403404
POST
/api/admin/brand-competitors/review-items/{id}/approve
Approve a brand competitor review item
c550a86e80111c831db9d16b2f54cafb 1 param body → 200401403404422
POST
/api/admin/brand-competitors/review-items/{id}/reject
Reject a brand competitor review item
dddca4d8e4a781afaa11c6fd38fa1d2c 1 param body → 200401403404422
Brands Social Scraping 5

Brands Social Scraping

GET
/api/social-scraping-sessions/brand/{brandId}
Get the social scraping sessions for a given brand
40acc3bffc296a02eaa3e3ec5c192579 3 params → 200
GET
/api/social-scraping-sessions/brand/{brandId}/session/{brandScrapingSessionId}
Get the social scraping session properties for a given brand
87515f2028d4b950852fc27d9c0ff37d 2 params → 200
GET
/api/social-scraping-sessions/brand/{brandId}/latest/{platform}/{handle}
Get the latest social scraping session for a given brand
6301657bd4e4adf96ec75471aa78a72b 3 params → 200
DELETE
/api/social-scraping-sessions/brand/{brandId}/session/{scrapingSessionId}/matched-entity/{matchedEtityId}
Delete the matched entity from the posts of a social scraping session for a given brand
7dffac202e45aa05cbe52b8f3bb25020 3 params → 204
GET
/api/social-scraping-sessions/brand/{brandId}/session/{brandScrapingSessionId}/export
Export the social scraping session properties for a given brand
5dff488f5bfccba6970ed64979d13b2e 2 params → 200
BrandSynonym 5

BrandSynonym

GET
/api/brand-synonyms
List brand synonyms
a99fbc64272789926939be282f5d875d → 200
POST
/api/brand-synonyms
Create brand synonym
367b001ca47c3c0a7bc990e9f0776bc3 body → 200
GET
/api/brand-synonyms/{id}
Get brand synonym
11fddf6004cf2152ff5469d0f5a29d9f 1 param → 200
PUT
/api/brand-synonyms/{id}
Update brand synonym
533cfd766b12e2a4265129866aa29b01 1 param body → 200
DELETE
/api/brand-synonyms/{id}
Delete brand synonym
f3142a208a67ca04993529109cbc6769 1 param → 204
Campaign 4

Campaign

GET
/api/campaign
List all campaigns
ce69497e98cccfa18649dece699570fd → 200401403
POST
/api/campaign
Create a new campaign
e8348bef63e3bb96a143ee46402cccab body → 200401403
POST
/api/campaign/{id}/meta
Update campaign metadata
4563fbc3450f25c86bd32aa0d811397f 1 param body → 200401403
GET
/api/campaign/draft
Get draft campaign
710500032cf488a2308d634c724ebec0 → 200401403
Category 14

Category

GET
/api/category
List all categories
327644f4d836240fa297b2822ab6ca92 1 param → 200401
POST
/api/category
Create a new category
de40ad04180a48262a05cf249f785ab3 body → 200401403422500
GET
/api/category/{categoryId}/subcategories
Get category with its subcategories
5ac8a30a0a3c05aac34caee11cee81f4 1 param → 200401
GET
/api/category/subcategories/{subcategoryId}/export/contacts
Export contacts for a subcategory
c90e8190971834f196af3f29be981524 1 param → 200401404
GET
/api/category/subcategories
Get extended list of categories with subcategories
e5177fd1e6da08384c1a3ce8e12f0565 → 200401
GET
/api/brands/categories
Get all categories with subcategories
dc4b547df11e479d1c62778cf173bcaa → 200401
GET
/api/category/with-teams/{categoryId}
Get category with audited properties
8bc1ece7d7c47fc62daeacd3506a89a5 1 param → 200401
GET
/api/category/{id}
Get a category by ID
25690688339275caf7ded3e8702e7670 1 param → 200401403
PUT
/api/category/{id}
Update a category
9be67b4880d28356ade2ebc0b425415e 1 param body → 204401403404422500
DELETE
/api/category/{id}
Delete a category
534a636fb456263f752f0983f8097fb5 1 param → 204401403404500
GET
/api/category/{id}/intent
Get category intent data
8e13bcbaa1070ba06f5e70505c69f87f 1 param → 200401
PUT
/api/category/{oldId}/reassign/{newId}
Reassign subcategories to another category
938c724b855fe2503eb00c86d38ea942 2 params → 200401404
GET
/api/category/download
The endpoint returns list of exported categories
8fe5c701866791d2605caa179ddea8cc → 200
GET
/api/category/subcategories/download
The endpoint returns list of exported subcategories
67421d0d3de41e23c90b996497f01dcc → 200
Brand 15

Brand

GET
/api/company
List brands
3e0bffb951b3f31f83aadc004638122b 1 param → 200
POST
/api/company
Create a new brand
faf1545d2af89079ca55c4f9ed6ea302 body → 200401403422
GET
/api/company/download
Export brands to CSV
b199230656befd10721e0df2d25bbd64 → 200
GET
/api/company/{id}
Get brand details
29b0f8f11c5e74b0c7a9f94f223c0abc 5 params → 200401404
PUT
/api/company/{id}
Update a brand
dba5691bd7818c368accfd785048ea90 1 param body → 200401403404422
DELETE
/api/company/{id}
Delete a brand
a073402836212623826fbe1e5a591454 1 param → 204200
PUT
/api/company/{id}/approved
Approve a brand
d30b29c4f2531b7c2171e1a34a768789 1 param body → 200401403404
PUT
/api/company/{id}/social-handles
Add social handle to brand
a970398ff43ab364470641b8118cc660 1 param body → 200401422500
PUT
/api/company/{id}/social-handles/multiple
Add multiple social handles to brand
b64f45988c333b73cc71385e3a099eeb 1 param body → 200401422500
PUT
/api/company/quick-edit/{id}
Quick edit a brand
f5debdcf80b4e606bdc3320e60005fae 1 param body → 200401404422
GET
/api/company/exists
Check if brand exists
e178f5a55a7e826c62dfa6e9d154e71f 1 param → 200401
PUT
/api/company/{old_id}/reassign/{new_id}
Reassign brand data
c2802e6e6b434a4ab6f91d92259e5736 2 params → 200401404500
POST
/api/brand/{id}/properties/{year}
Get brand deals by season
a195f821ab9ad56096e70493cf181f51 11 params → 200401
POST
/api/brand/{id}/properties/metadata/{year}
Get brand deals metadata
81ad3bfcad5cac9e389f292c5e33ef20 3 params → 200401
PUT
/api/company/{id}/exclude-from-transcribe
Exclude brand from transcribe
adfac58a5a03047c729a5f88a48f7c7b 1 param body → 200401404
Contact 21

Contact

GET
/api/contacts/bad-email-report
List bad email reports for the authenticated user
041a0c64cd5f3b1493ccfa9e73e6fab8 1 param → 200422
POST
/api/contacts/bad-email-report
Report a bad email for a contact
2192a4af73ceff3ad02cb76ac09de32e body → 201422
GET
/api/contacts/{contactableEntity}/{contactableId}/owner/{ownerId}
List contacts for an entity
0306c0e4317485d19459722d711cffaa 4 params → 200
GET
/api/contacts/{contactableEntity}/{contactableId}/export
Export sale contacts
e8ec2765a7baa4d98a6676151b50ba45 2 params → 200
POST
/api/contacts/{contactableEntity}/{contactableId}
Create a new contact
6490ccfff8d5d83d765e6e718cd8ffb8 2 params body → 201
POST
/api/contacts/{contactableEntity}/{contactableId}/sale-contact
Create sale contacts from existing profiles
609cb760d7d7c591e132910cb7b72f09 body → 201
DELETE
/api/contacts/{contactableEntity}/{contactableId}/sale-contact
Bulk-remove sale contacts from a sale list
3ee16edfaab3704bb1556faaa2777a1c 2 params body → 204207403404422
GET
/api/contacts/{contactableEntity}/{contactableId}/{personProfileId}
Get a specific contact
14f7dc7de933883fdbdf260c9c663bdf 3 params → 200
PUT
/api/contacts/{contactableEntity}/{contactableId}/{personProfileId}
Update a contact
237249d98b1cd86f6ea34bfe6bd05d5d 3 params body → 201
DELETE
/api/contacts/{contactableEntity}/{contactableId}/{personProfileId}
Delete a contact
fa53415c5f3eabb912756e673472f632 3 params → 204
POST
/api/contacts/by-email
Search contacts by email
49a5258635a63a87c1b3d8c12685c60d body → 201
POST
/api/contacts/by-school
Search contacts by school
331f5a4226c46cf1e8711d8311e5bcc3 body → 200
PUT
/api/contacts/{contactableEntity}/{contactableId}/{personProfileId}/email-status
Update contact email status
8f017d74ad937910f805f67b00a74108 3 params body → 201
GET
/api/contacts/email/status/file
List email status files
9fef12997efe24fad8637880403e5945 5 params → 200
POST
/api/contacts/email/status/file
Upload email status file
eae7aea8cf5fdbceb8e9b0fc8cb7e245 body → 200
GET
/api/contacts/email/status/file/metadata
Get email status file metadata
eed8babdac423ea49c65826c4e05c145 → 200
GET
/api/contacts/email/status/file/{filename}
Get email status file download URL
6a96bffd311623076b41ffba48a488d3 1 param → 200
POST
/api/contacts/linkedin/scraping
Scrape LinkedIn profiles
ffeb5fd41ee874b74560bb189e824ad7 body → 200
POST
/api/contacts/{entityType}/{entityId}/employees/linkedin
Search LinkedIn employees by entity
ee9e74b1d0463ba8d8caee61c130b715 3 params → 200202404422502
POST
/api/contacts/{entityType}/{entityId}/employees/linkedin/on-demand
Request a user-triggered LinkedIn employee scrape
4af969912d081bdf4a715b3371f65990 2 params → 202403409422502
GET
/api/contacts/primary-email/check
Check if a primary email is linked to any contacts
50840c1a93f2e320ab5ffa64cd65f6ff 1 param → 200422
LinkedIn 1

LinkedIn

GET
/api/linkedin-profile-url/check
Check if a LinkedIn profile URL is linked to any contacts
75903c105d2415609f98aaa769991c2a 1 param → 200422
Webhooks 3

Webhooks

POST
/api/webhooks/phantombuster/employee-search
Handle PhantomBuster employee search completion webhook
4b2ec455c53b650fb41ef1624e09ee23 1 param body → 200403
POST
/api/webhooks/phantombuster/on-demand-employee-search
Handle PhantomBuster on-demand employee search completion webhook
2bd6564486756b0447fb1ec917becb54 1 param body → 200403
POST
/api/webhooks/brightdata/posts-ready
Handle BrightData direct post delivery webhook. BrightData POSTs the raw post collection as a JSON array. Session and gap IDs are encoded in the URL query params.
83172fa9ca4f092ade656999041ed287 2 params body → 200403422500
News 21

News

GET
/api/news/active-articles
List active news articles
e4fa099a4fa10fee9854622f2fd726f7 1 param → 200
GET
/api/news/all-articles
List all curated news articles
getAllCuratedNews 11 params → 200401403
GET
/api/news/export/all-articles
Export curated news articles
exportCuratedNews 10 params → 200401
GET
/api/news/my-articles
List current user's curated news articles
getOwnCuratedNews 10 params → 200401
GET
/api/news/submissions
List the global news submissions queue (all submitters)
0fb580a718c731e722abe30c5b1ebcdf 10 params → 403200
GET
/api/news/submissions/{id}
Get one news submission by id (global — any submitter)
64e24c71ec4f499e6a74144a4c68dbeb 1 param → 200403404
POST
/api/news/article
Create a curated news article
createCuratedNews body → 200401403422
PUT
/api/news/article/{id}
Update a curated news article
updateCuratedNews 1 param body → 200401403404422
DELETE
/api/news/article/{id}
Delete a curated news article
deleteCuratedNews 1 param → 200401403404
POST
/api/news/analyse
Bulk submit news article URLs for analysis
3b3d00be711cb398df132e0a2134086e body → 201422403
PUT
/api/news/article/{id}/publish
Publish a news article
23adff9f97c3a94e4aaffc552029477b 1 param → 200403404422
PUT
/api/news/article/{id}/unpublish
Unpublish a news article
12f229dfd29e8f99d1a3c0113f89df3c 1 param → 200403404422
PUT
/api/news/article/{id}/decline
Decline a news article
59fcc0bd30941e64cc924cb74494492b 1 param → 200403404422
PUT
/api/news/article/{id}/restore
Restore a declined news article
70198b0ef22aa7c8bbfd9ea52ea615c8 1 param → 200403404422
GET
/api/news/article/preview
Preview news article
9aace22b4f6a3d27111fb4cfbcdf7a20 1 param → 200
GET
/api/news/article/{id}/assets
List extracted assets for a curated news article
listNewsAssets 1 param → 200401403404
POST
/api/news/article/{id}/assets
Manually add an asset to a curated news article (Quick Add)
storeNewsAsset 1 param body → 201401403404422
DELETE
/api/news/article/{id}/assets/{assetId}
Dismiss a news asset row (soft — sets matchstatus=dismissed)
dismissNewsAsset 2 params → 200401403404
PATCH
/api/news/article/{id}/assets/{assetId}
Update a news asset row (pick a different itemid, flip to confirmed)
updateNewsAsset 2 params body → 200401403404422
POST
/api/news/submissions/{id}/contacts/add
Add the extracted contacts a reviewer selected
addNewsContacts 1 param body → 200403404422
POST
/api/news/submissions/{id}/contacts/{newsContactId}/resolve
Create a contact from the LinkedIn profile a reviewer chose
resolveNewsContact 2 params body → 202403404409422
Custom Reports 8

Custom Reports

GET
/api/custom-reports
List custom reports
b02ba06dc96b360112a2ceb8147ee2ac 8 params → 200
POST
/api/custom-reports
Create a custom report
991700be4fd2c2764d531f50687b91a1 body → 201422
GET
/api/custom-reports/{id}
Retrieve a custom report
313428b3f95d2fffe877d7f01c3e1152 1 param → 200403404
PUT
/api/custom-reports/{id}
Update a custom report
7d380803fd1bcc21e3cf81019e8c6d87 1 param body → 200403404422
DELETE
/api/custom-reports/{id}
Delete a custom report
891c1947e8d4ee10de25d872c74e67bf 1 param → 200403404
POST
/api/custom-reports/{id}/duplicate
Duplicate a custom report
885efeb0dbb2fb3d78bb821d1d018477 1 param → 201403404
PATCH
/api/custom-reports/{id}/rename
Rename a custom report
9f17e88224a4efee50f56e3e6c88dad6 1 param body → 200403404422
POST
/api/custom-reports/{customReport}/share
342a800c570b4f60211fb2616996b4ad 1 param body → 200404422500
Data Ingestion 6

Data Ingestion

POST
/api/ingestion/submit
Submit an ingestion request
1ac6b736a48f5cd0c473de8670b78e20 body → 201422500
GET
/api/ingestion/jobs
List user's ingestion jobs
383852e686eab096f952fdd496508162 2 params → 200401
GET
/api/ingestion/jobs/{uuid}
Get ingestion job status with all tasks
e8f3415453f8570d2fc348781de24e40 1 param → 200404
GET
/api/ingestion/tasks/{uuid}
Get ingestion task details
b754d0aeb0006297c4e08d5652f8e645 1 param → 200404
GET
/api/ingestion/jobs/{uuid}/contacts
Get contact extraction results for an ingestion job
b91feacf49b7e5b4627e48cdcab01a4f 1 param → 200404
POST
/api/webhooks/ingestion
Handle Data Ingestion webhook callback
96c82d5fba07d678cc8472a8feb2dd90 body → 200422
Events 7

Events

GET
/api/events
List all events
f03fc722854a9c744a79b16f6b27016c → 200401
POST
/api/events
Create a new event
74a3db86fa6f0a55e99bb5a3c9fd29a0 body → 200401422
GET
/api/events/team/{team_id}
Get events for a specific property/team
4644cb6c07f9c2b9482ee452e2bb9966 12 params → 200401
GET
/api/events/property/all
Get all events for a selected team
e82f4dcfbf48d29b23c10433850410f9 6 params → 200401
GET
/api/event/{event_id}
Get a specific event
82f26619077a70eaccb304e3f69d483f 1 param → 200401404
PUT
/api/events/{event_id}
Update an event
d5605c8ea652015e39bba653eb03431e 1 param body → 200400401404
DELETE
/api/events/{event_id}
Delete an event
721867a307d87f7146694fa170a095f9 1 param → 200400401404
Facebook 2

Facebook

GET
/api/facebook/me
Retrieve Facebook information about the user.
a76c183630ba0f5b9aa256df8938ec79 1 param → 200
GET
/api/facebook/validate-token
Validate token
6957675db782437e00ff23a275165404 1 param → 200
Feedback 1

Feedback

POST
/api/send-feedback
Send user feedback
5ce25b7a9773b85e2ca31cc499eb5436 body → 200
FileUploads 4

FileUploads

GET
/api/files
Get list of file uploads
27dd464763aad5e6651dbfa7fd432371 → 200
POST
/api/files
Upload a new file
2498ca43195246370e48eb355e0e4fed body → 200400
GET
/api/files/{id}
Get file upload by ID
13d2f487727ef239622c205a541f3905 1 param → 200404
DELETE
/api/files/{id}
Delete a file upload
ff9f36d679456b089d6834cd6978bafd 1 param → 200404
Brand Clip Timings 1

Brand Clip Timings

GET
/api/brand/clip/timings
Get brand clip timings
bfa0671b2a21c2163c55d0654b90204d 2 params → 200404422500
Hubspot 1

Hubspot

GET
/api/hubspot/access
Get Hubspot access token
8a141cd9dae1acaeee99c4b49f9d1295 → 200401
Hubspot segments 2

Hubspot segments

GET
/api/hubspot/segments/{id}/contacts
Get contacts from a HubSpot segment
3e730210d6400fc956b388b75ebfdb1d 1 param → 200401500
GET
/api/hubspot/segments
List HubSpot segments
8976180bbcff4bb490dc16e320633fa6 3 params → 200401500
Images 4

Images

GET
/api/logos
Detect logos in an image
getLogosFromImage 1 param → 200422
GET
/api/download-image
Download an image as base64
downloadImageAsBase64 1 param → 200422
POST
/api/crop-image
Crop an image
cropImage body → 200422
POST
/api/upload-image-from-url
Upload an image from a URL
uploadImageFromUrl body → 200422
Image Enhancer 2

Image Enhancer

PUT
/api/image/{id}/enhance
Save enhanced image
14776c9602fcec3adfdf420a096c0bbe 1 param → 201400
POST
/api/image/{id}/enhance
Enhance Image
92f2efccbdac4fbf9f4b2c4a933b2594 1 param → 200404502
Infographics 4

Infographics

GET
/api/infographics
List all infographics
550d8d43223800bdd568a27fc4d2e025 → 200
POST
/api/infographics
Create infographic
69c4f07b12f460aae37dfc0a8c9c7b6e body → 200
PUT
/api/infographics/{id}
Update infographic
d022993c17802629d923ad54a0119061 1 param body → 200
DELETE
/api/infographics/{id}
Delete infographic
39377116805b93dd376aa7545fb852a0 1 param → 204
Intercom 1

Intercom

GET
/api/intercom/me
Get current user Intercom info
1ffbb501d505c809a281c5afc3f10060 → 200
Internal Sync 5

Internal Sync

GET
/api/internal/sync/brands
Paginated brand reference data for internal service sync
eb1be6c3c1a6ad6ceaeb2412572d9013 2 params → 200401422
GET
/api/internal/sync/league-assets
Paginated per-league capture-scope assets for internal service sync
09babef733ef121274ebf107361d7d97 2 params → 200401422
GET
/api/internal/sync/properties
Paginated property reference data for internal service sync
c7b0c346b6ba87c7709dfafee4201fc1 2 params → 200401422
GET
/api/internal/sync/property-known-brands
Paginated property/asset brand history for internal service sync
a6b51ca083fd0296c53223bd546c06e1 2 params → 200401422
GET
/api/internal/sync/venues
Paginated venue reference data for internal service sync
f515866308595b255b8a5ec1029f563e 2 params → 200401422
Item 9

Item

GET
/api/item
List all items (assets)
b6b5f8ca55f3977ad2ce6777f035c40e 1 param → 200
POST
/api/item
Create a new item (asset)
5567f92eba0a6eaacf0124498e81dadf body → 200401422
GET
/api/item/{id}
Get an item by ID
c6650aff4f52c233e3fd6e521dfc2be4 1 param → 200401404
PUT
/api/item/{id}
Update an item
5a1c317476a9ece281b918a25ced7a63 1 param body → 200401404422
DELETE
/api/item/{id}
Delete an item
722d07df6daf6b4d3eaf8295b04bf942 1 param → 204400401403404
GET
/api/item/{id}/intent
Get item intent data
28052170355afddfeddc33f76ab4a22e 1 param → 200401
GET
/api/items-slim
Get slim items list with platforms and subplatforms
1b581894ea4f1744b7e73cca5087f804 → 200401403
GET
/api/items-slim-with-counts
Get slim items list with current-season audits and brands counts
49b6e8dfc0fb660e4924608e6c78a8f6 → 200401403
GET
/api/items/export
Export items to CSV
984836ec54b623824658d3d0e6dde70d → 200401
Item Image 1

Item Image

DELETE
/api/item-image/{id}
Delete item image
8a57af116b799c629a48bc4793809363 1 param → 204400404
Item Platform 8

Item Platform

GET
/api/item-platform
List all item platforms
b2e49dcc485f0564767ecfb686b04cb8 4 params → 200401403
POST
/api/item-platform
Create a new item platform
0d2685847bb7856e10871a329c2e8112 body → 200401
GET
/api/item-platform/{id}
Get a platform by ID
411eb37df1ff7e72d0aad48b5c85ff49 1 param → 200401
PUT
/api/item-platform/{id}
Update a platform
07294c66c34201034d70c4663a9cbada 1 param body → 200401403
DELETE
/api/item-platform/{id}
Delete a platform
d8ad597abfad9c34d05c3407e45cb128 1 param → 204400404
GET
/api/item-platform/{id}/subplatform
Get platform's subplatforms
306d5d4ba7e724e1e6bed9a92821e4fc 3 params → 200401404
GET
/api/item-platform/{id}/intent
Get platform intent data
f3395de70dee767dddb4e3d7cf8ffa32 1 param → 200401
PUT
/api/item-platform/{oldId}/reassign/{newId}
Reassign items and subplatforms to another platform
608b966f1337688fe6b2c3bf7face0d5 2 params → 200404
Item Subplatform 7

Item Subplatform

GET
/api/item-subplatform
List all item subplatforms
455fc558b27ed533dc0094001f656ea5 3 params → 200401403
POST
/api/item-subplatform
Create a new subplatform
629695bf670aa07bedae5c34a6b5feb5 body → 200401
GET
/api/item-subplatform/{id}
Get a subplatform by ID
ef3631a90a8ddf80d08cc0c70f9b70e5 1 param → 200401
PUT
/api/item-subplatform/{id}
Update a subplatform
f43133abb49f7fe78b7587eae103b6b9 1 param body → 200401403
DELETE
/api/item-subplatform/{id}
Delete a subplatform
8ab226ade6f19de06f013a7752566766 1 param → 204400404
GET
/api/item-subplatform/{id}/intent
Get subplatform intent data
1dc1f8bdb6337b2ed8b33fe4b8107d26 1 param → 200401
PUT
/api/item-subplatform/{oldId}/reassign/{newId}
Reassign items to another subplatform
8cd9a58fd31c89021dfb2c2cc1bc09f0 2 params → 200404
Item Value 8

Item Value

GET
/api/item-value
List all item values
a1cacd09e11415c7d071297063d0d033 2 params → 200401
POST
/api/item-value
Create a new item value
cf00877fb308e11f8e5e06d5528a9c98 body → 200401422
GET
/api/item-value/{id}
Get an item value by ID
58822892c581bd792b554f045016a9d8 1 param → 200401404
PUT
/api/item-value/{id}
Update an item value
a58e5a20a8120585dee5b6055d84b66b 1 param body → 200
DELETE
/api/item-value/{id}
Delete item value(s)
84ccaee2daa18b7f563efeaf2732536e 2 params → 204401403500
PUT
/api/item-value/description
Update description for multiple item values
75c4c328b800b6d8a2d6adbe0c5e5320 body → 200401422
PUT
/api/item-value/description/clear
Clear description for multiple item values
ebd52f3c4edbce7a4e08a8eba4db162f body → 200401
POST
/api/item-value/{id}/copy
Copy an item value to another item
29b24c7a62af9f15f6fb440756aff3e2 1 param body → 200400401
Item Video 1

Item Video

DELETE
/api/item-video/{id}
Delete item video
6a79fbb3cab6f6c5a5ba52e17967011f 1 param → 204400404
Keyword 6

Keyword

GET
/api/keywords
ff11c6bbebabf52b4e565bde4f8bca0c → 200
POST
/api/keywords
df36fd61d5ccd37fd06b051065a37327 body → 201
GET
/api/keywords/{id}
fbceb84328d1c895ce7972a724f11ca0 1 param → 200
PUT
/api/keywords/{id}
dcf0c181115fdd532fdbf102e6b9069e 1 param body → 201
DELETE
/api/keywords/{id}
de3314af464060f2c2a9fc3e74ae22de 1 param → 204
POST
/api/keywords/position
95353e101c64d0c6f1f36a0642194638 body → 200
League 19

League

GET
/api/league
List leagues.
0c4c4242dae75f46c431035a2afc13ea 11 params → 200403
POST
/api/league
Create a league.
d59a99da2297073547ac6dcf6d70bf74 body → 200400403
GET
/api/league/{league}
Get a single league.
36bbe02f129adbea6fcbb0feed3cf475 1 param → 200404
PUT
/api/league/{league}
Update a league.
8b44cb2b08ef82098760d05ae8c59e81 1 param body → 200400403
DELETE
/api/league/{league}
Delete a league.
6517bdd725bb2ffc8c10bbc08c3bf631 1 param → 200400403404
GET
/api/league/{league_id}/social-scraping-settings
Get a league's social scraping settings.
b782a5ead2399d407e9930811d1b7c42 1 param → 200403
PUT
/api/league/{league_id}/social-scraping-settings
Update a league's social scraping settings.
5c60c9bbdbc44d39b7c43a3c0c37b827 1 param body → 200403
GET
/api/league/social-scraping-settings
List social scraping settings for all leagues.
ebda2e4221196cfd9d67672533d7bd4f 8 params → 200422
GET
/api/league/{league_id}/seasons
List a league's seasons.
f8c5002f468ca3e53f73b82736d30bdf 1 param → 200
GET
/api/league/{league_id}/season/{season_id}/properties-for-spend-tracker
List league properties for the spend tracker.
c75649948530590adcfff34ae80e00ac 2 params → 200
GET
/api/league/owners
List league owners.
44f79b733bee59b79eb73d263d6e46fd → 200
GET
/api/league/{league_id}/organizations
List a league's organizations.
b6e22b90bdffa54f949cea34a8716745 7 params → 200422
GET
/api/league/{league_id}/latest-scouting-dates
List latest scouting dates per property for a league.
c36410a0b71fea4ca36c7b574629130d 8 params → 200422
GET
/api/league/{league_id}/latest-scouting-dates/filter-options
Full-dataset filter options for the Audit Dates table.
317cbb22010e0365588a397a9e5c92d9 2 params → 200422
GET
/api/league/deals
List league deals per property with aggregated statistics.
0345053225041f1a688be78ede2ee6ba 17 params → 200422
GET
/api/league/deals/filter-options
Full-dataset filter options for the league-deals table.
159c70a8643366b1c625b2794ed8a1e4 9 params → 200422
GET
/api/league/{league_id}/deals/export
Export year-over-year league deal reports.
679a14c74ed3d8ee068108392cfc39f0 4 params → 200422
GET
/api/league/statistics
Fetch aggregated statistics filtered by leagues and/or scouting markets.
18454192a6ec88c59f14a3cdd8ee92a6 3 params → 200422
GET
/api/league/statistics/completion
Fetch per-metric data-quality completion percentages for a league scope.
41f4e25e1230259e57c4d74ff64b82ef 3 params → 200422
LeagueItems 4

LeagueItems

GET
/api/league-items/item/{id}
Get leagues for item
a3980526f765b7e9ea63477bd49503b4 1 param → 200
GET
/api/league-items/league
Get items for league
07380ac867349e354cd33302608be077 1 param → 200
PUT
/api/league-items/item/{id}/update-leagues
Update item leagues
24dd6cb793b6573dabd20ecbb46e539e 1 param body → 200
PUT
/api/league-items/league/{id}/update-items
Update league items
a0a8da5418c493bd0c9581883a3b9bd5 1 param body → 200
Location 5

Location management and smart search endpoints

GET
/api/locations
List locations
24105decfb008b3fc7da567622381f14 5 params → 200401
POST
/api/locations
Create location
1bd3b438bb713a5033a6acb9228b1ed9 body → 200
GET
/api/locations/{id}
Get location
aac0f1ac8b745f670b6d74e1a681b4f0 1 param → 200401404
PUT
/api/locations/{id}
Update a location
306b86ac43db6579c15a4537e8a76edd 1 param body → 200401404422
DELETE
/api/locations/{location_id}
Delete a location
aaa89dcda0660a30bbbbefec469d9e3b 3 params → 204400401404
Search 7

Search

POST
/api/search/smart/brands/locationsdeprecated
Search brand locations
6f77cd0dc54389927b6029003009d583 body → 200401422
POST
/api/search/smart/brands/locations/metadatadeprecated
Get metadata for brand locations smart search
0da01e381072ea7386ed981e13045004 body → 200
POST
/api/search/smart/brands/locations/downloaddeprecated
Download brand locations as CSV
24c1066d5edffa9b62deef7672933b23 body → 200500
POST
/api/search/{entity}/by-id/list
Get entities by IDs as flat list
b878b803278e85324c0e01ac4ccf1f66 2 params → 200
POST
/api/search/{entity}/by-id/grouped
Get entities by IDs grouped by category/league
c54af0a74c2159945f8aee0028dd54ab 2 params → 200
GET
/api/search/entity/{entity}
Search entities by name
c1112a58865f6722aed94b0a1a32c80a 2 params → 200
GET
/api/search/{indexed_entity}
Global search over a Meilisearch-indexed entity
82e1cade2feeb042d7132eb6df8da393 2 params → 200400503
Market 6

Market

GET
/api/market
List all markets
6f7fafdb80c3b6f089224524083ecc3c 3 params → 200401
POST
/api/market
Create a new market
e34e4e4872a06886d067ee46183fa34b body → 200401422
GET
/api/market/{id}
Get a market by ID
ac49ba212650ab24ded3428a6f1cc0ce 2 params → 200401404
PUT
/api/market/{id}
Update a market
6c93de12ef8bbc568421e9efdd2de006 1 param body → 200401404422
DELETE
/api/market/{id}
Delete a market
801b9d96e19297d5db4c45798a4b8790 1 param → 204401403404
GET
/api/market/aggregated
Get aggregated markets
bb99ec6ff704a85f5e421dc97ddb72bc 3 params → 200401
Market Grouping 5

Market Grouping

GET
/api/market/grouping/{id}
Get a market grouping by ID
74a99712b4795dd5ecf862506b275890 1 param → 200401404
PUT
/api/market/grouping/{id}
Update a market grouping
89ede57c518924f57c153f0cf37f1930 1 param body → 200401404422
DELETE
/api/market/grouping/{id}
Delete a market grouping
0124464183b08a6a02beee5fa1a76019 1 param → 204400401404
POST
/api/market/grouping
Create a new market grouping
24771a930066066c112c95f0160fa8e9 body → 200401422
GET
/api/market/grouping/types
Get market grouping types
3106d52fa9d903d1e666c2c66fbcda14 → 200401
Mobile Auth 1

Mobile Auth

POST
/api/mobile-auth/token
Mint a long-lived JWT token for the Vortex mobile app
17e4b6f67811a1fd3f8aecf2d3c41e99 body → 201404401422
Notes 8

Notes management endpoints for various entities

POST
/api/note/{entity}/{entityId}
Create a note
e44423737cc22476bf5437f7f4c19ce6 2 params body → 204401500
PUT
/api/note/{id}
Update a note
0eb96723a8876e210dee3250cc7e95a6 1 param body → 200401404
DELETE
/api/note/{id}
Delete a note
712d33105a83d0a166bc76e6f55903d4 1 param → 204400401404
GET
/api/notes/{entity}/{entityId}
List notes for an entity
115e8fe6e267111684c2ac99a817b5fe 3 params → 200401403
GET
/api/notes/{leagueId}/internal-scoutingdeprecated
[Deprecated] Get internal scouting notes for a league
df19c4cb21646bf53cdb231a7b5d5207 2 params → 200401403404
GET
/api/properties/{teamId}/internal-scouting
Get internal scouting notes for a property
5e31c049d5f36405dc31ede7805ccf9e 2 params → 200401403404
GET
/api/admin/leagues/{leagueId}/scouting-notes/{seasonId}
Get the internal scouting notes for a league season
7c0efd745c87c1750e36d439659bda0c 2 params → 200401403404
PUT
/api/admin/leagues/{leagueId}/scouting-notes/{seasonId}
Upsert internal scouting notes for a league season
0909d73e17461df9d85a4c04f6668bff 2 params body → 200401403404422
Organization 21

Organization

GET
/api/organization
List organizations
d7e9f6249d9c3e47bfbe93d7443024d5 1 param → 200
GET
/api/organization/limit-access-types
List organization limit-access types
9fc24fe91dc4d6d90c95277245bf8a2c → 200
GET
/api/organization/{id}
Show organization
c6eaed98be50125ab15f307335034733 2 params → 200401403404
PUT
/api/organization/{id}
Update organization
c02b93d9c41f9b5b9b8500f4c7703194 1 param body → 200401403404422
POST
/api/organization/{organizationId}/property-types
Sync organization property types
b2d204294987ec34fb221b6681ae5bdf body → 200
POST
/api/organization/{organizationId}/markets
Sync organization markets
846eeb3e555479af60d87fecfbafe28d body → 200
GET
/api/organizations/{organizationId}/access
Get access information for an organization
1ffa201c65ab4ada35f8eec1deb71274 1 param → 200
GET
/api/organizations/{organizationId}/users
Get users from organization
a40971204aa0a52b1e45306a771666dc 5 params → 200
DELETE
/api/organizations/{organizationId}/users
Delete users from organization
789d59a344ae67c564163fdfa5bff9e8 1 param → 204
GET
/api/organization/{organizationId}/contract
Get organization contract
3e20227a3888c1e50aef1c0adc279650 1 param → 200
PUT
/api/organization/{organizationId}/contract/update
Update organization contract
a43d85dce02b65cff44049c6527a8177 1 param body → 200
GET
/api/organization/{organizationId}/users/download
Export users from organization
086ce38682c5572d54633c9dace2302e 1 param → 200
GET
/api/organization/{organizationId}/integration/salesforce
Get Salesforce integration
3a2a66df0516c68e3bb2dfc35903ca28 1 param → 200
POST
/api/organization/{organizationId}/integration/salesforce/save
Save Salesforce integration
ef42519e63760645836c779bd0975bec 1 param body → 200
POST
/api/organization/{organizationId}/eval-proposal/save
Save evaluation proposal limit for an organization
91fdfaa8436dd74e405049a7d3449f6e 1 param body → 200404500
POST
/api/organizations/intercom-sync
Sync organizations to Intercom
204f5ff35e569f1f8cc07aa7110aa8e9 body → 202403
GET
/api/organizations/intercom-sync-status
Get organizations Intercom sync status
9be9abe37d425004b7e7357fc239b786 1 param → 200403
GET
/api/organization/type
4ae2cd0d1306e86e66d789cce8771dac → 200
POST
/api/organization/type
2d6ae3f163844a4e39f546f18c873d69 body → 201
PUT
/api/organization/type/{id}
ab87760499bd9e415ca3bc7b7f471bee 1 param body → 201
DELETE
/api/organization/type/{id}
bc78288008cadd45f1391bd5cb7d9213 1 param → 204422
Partnership Reports 5

Partnership Reports

GET
/api/reports/partnership
List partnership reports
24076faf5891747e250cc430862e5cfa 7 params → 200
POST
/api/reports/partnership
Create a partnership report
e349ad776b0a6f15a5e4f98171cd27a3 body → 200
GET
/api/reports/partnership/{id}
Retrieve a partnership report
a1b7d5450a707f2651bec8c2a35e2d2a 1 param → 200404
PUT
/api/reports/partnership/{id}
Update a partnership report
e6dab17823064b265f4fa50ce92da980 1 param body → 200404
DELETE
/api/reports/partnership/{id}
Delete a partnership report
b48ee161356151da529ca8c52c1ac043 1 param → 200404
Roles & Permissions 6

Roles & Permissions

GET
/api/permissions/{name}
Get permission by name
ffb1e2cd414e0f89f1a548525c7fb7b9 1 param → 200
PUT
/api/permissions/{name}
Update permission
bdeadb094c4c3b0ec8851d065e6d390e 1 param body → 200
GET
/api/roles
List all roles
77e3636d8592997ce9d6d27b50857a69 → 200
POST
/api/roles
Create a new role
4a563842fbfcad237f63da43065fca3d body → 201
PUT
/api/roles/{id}
Update a role
786d6990093a8eb3a56931f19a827e43 1 param body → 200
DELETE
/api/roles/{id}
Delete a role
8285c46981c60ad600aa4077307aec04 1 param → 204
Product 5

Product

GET
/api/product
5cc57bec35d0f2045983cc8dcd00eccd → 200
POST
/api/product
1d0b0d8724685b7b8f9d87f403bfc4df body → 200
GET
/api/product/{product_id}
9d631e70d2683d5e29f944f988b99f8b 1 param → 200
PUT
/api/product/{product_id}
e1fbefb0afb09c2ebaf2e04353dc83d7 body → 200
DELETE
/api/product/{product_id}
f72155e45b912db495b280c1967e9263 1 param → 204
Product Type 1

Product Type

GET
/api/product-type
List all product types
d0119194a566221bfbbbd5ecd5caa5a1 → 200
Attendance 2

Attendance

GET
/api/attendance/{propertyId}
Get attendance per property by property ID
getAttendancePropertiesByPropertyId 1 param → 200
PUT
/api/attendance/{propertyId}
Update properties attendance
updatePropertiesAttendance 1 param body → 200
Representation 3

Representation

GET
/api/representation/{controllingPropertyId}
Get controlled properties by controlling property ID
getControlPropertiesByControllingPropertyId 1 param → 200
PUT
/api/representation/{controllingPropertyId}
Update controlled properties by controlling property ID
updateControlPropertiesByControllingPropertyId 1 param body → 200
POST
/api/prepresentation/{controllingPropertyId}
Store a new representation
storeRepresentation 1 param body → 200
Property 16

Property

GET
/api/property/{id}/social
8636b25bd2e3e0d823d1574071b2941a 1 param → 200
PUT
/api/property/{id}/social
c6ddc1a1090419ee64cef5ec440988c1 1 param → 200
PUT
/api/property/{id}/social-extra-handles
9ed544373cd3b61746fb1aa400a3bb53 1 param → 200
GET
/api/team
List properties
8552dd0225e6b98cfd20200cff987939 13 params → 200
POST
/api/team
Create a property
6b4e1174a273f5efad722dcf5f1b87a0 body → 200400
GET
/api/download
Download properties list
download → 200400500
GET
/api/team/{id}
Get property details
71327544c30baa9706be0707cfeb2459 6 params → 200
PUT
/api/team/{id}
Update a property
34f1b0b7bcf7e6fa7bb79ef52c432cef 1 param body → 200422
DELETE
/api/team/{id}
Delete a property
f43d1ce16fdadfe79ca89a68976ff1ab 1 param → 204200
GET
/api/team/{id}/social-scans
Get property social scans
6c74458730512e181795e5a0857db108 2 params → 200
GET
/api/team/{id}/related-counts
Get property related counts
7db00c8f95501f664a15c7ff14600bbd 1 param → 200
GET
/api/team/{id}/social-feed/{source}
Get property social feed
50e7f8791f701651a3ab4aa1ddde4a90 5 params → 200
GET
/api/team/{team_id}/scrape-social-feed/{source}
Scrape property social feed
4c31ff339a9cb71b0d7a4a00d6e45b65 6 params → 200
GET
/api/team-exists
Check whether a property name exists
e509c08783ce47ff06f3e4dff279eaa8 1 param → 200
GET
/api/team/types
List property types
05b12663fc8cb255160d1b18b180a367 → 200
PUT
/api/team/{old_id}/reassign/{new_id}
Reassign a property's related records
fb14bb76b43f3368f34d1a6e6c9f537d 2 params → 200404500
Report Sharing 4

Report sharing tracking endpoints

GET
/api/report-sharing/recipients
Get recipients of a shared report
reportSharingRecipients 2 params → 200401403422
GET
/api/report-sharing/reports
Get reports received by a user
reportSharingReports 1 param → 200401403422
GET
/api/report-sharing/saved-reports
Get all shared saved reports
reportSharingSavedReports → 200401403
GET
/api/report-sharing/representatives
Get representatives in use by active users
reportSharingRepresentatives → 200401403
RoleOrientation 5

Role orientation management endpoints

GET
/api/role-orientation
List all role orientations
292d4f62d109dc4e646db1663a613a8d 1 param → 200401
POST
/api/role-orientation
Create a new role orientation
29611295373290831b5d974f9802f8f6 body → 201401422
GET
/api/role-orientation/{id}
Get a role orientation by ID
c3daf8320d973d283c6fa7291e95ec2e 1 param → 200401404
PUT
/api/role-orientation/{id}
Update a role orientation
619f8e9c0df36d6d5e34779bf3b03b81 1 param body → 200401404422
DELETE
/api/role-orientation/{id}
Delete a role orientation
4fa1a73cd654513bfeef220f76136407 1 param → 204401404
Saved Reports 9

Saved Reports

POST
/api/saved-report
Create saved report
4b17aa49f0abf8949e4abc0977c76b7e body → 200
PUT
/api/saved-report/{id}
Update saved report
e4a65fb6c9ecaf55bcc616c4c574c2b5 1 param → 200
DELETE
/api/saved-report/{id}
Delete saved report
ff2f1444c914623a22c0192e67dbc52c 1 param → 204
POST
/api/saved-report/{id}/duplicate
Duplicate saved report
723516a6ca767d93c8130a900001cfe1 1 param body → 200
POST
/api/saved-report-light/{id}/duplicate
Duplicate light report
6c0f74781e0fe168304ee8b993ec7c38 1 param body → 200
POST
/api/saved-report-light
Create light report
edd4a58f082fabf7ef3629d9a1f224e1 body → 200
PUT
/api/saved-report-light/{id}
Update light report
39b5adc9239e1dfbb1a3c003c9639bb0 1 param body → 200
POST
/api/saved-report/{savedReport}/share
Share saved report
d5c66ff43c9179ea630704c0dcd3dadb 1 param body → 200404422500
POST
/api/saved-report/{id}/mark-viewed
Mark saved report as viewed
c9223109f8bbfd438f21dbb3ed54c7b4 1 param → 200403404
Audio Download Links 3

Audio Download Links

GET
/api/user/{user_id}/event/{event_id}/property/{property_id}/audio-download-links
Get audio download link
c2e5f6c0fc67f2eda4da441931c1597c 3 params → 200
POST
/api/user/{user_id}/event/{event_id}/property/{property_id}/audio-download-links
Create or update audio download link
4bdbdb07e1b0858bb7bea28207af2c83 3 params body → 201
DELETE
/api/user/{user_id}/event/{event_id}/property/{property_id}/audio-download-links/{id}
Delete audio download link
7904d623aeaa1d3108faf379b3b1a449 4 params → 204
LogoRecognition 2

Logo recognition and brand detection endpoints

POST
/api/logo-recognition/{logo_recognition_entity}/{logo_recognition_entity_id}/ignore-brands
Ignore brands in logo recognition
14c6aceb7082ad12958c9114e9ddf13a 2 params body → 200401404
POST
/api/logo-recognition/image-process
Process images for logo recognition
6eebea24c204bb57d38b56ab5d8b266f body → 200401403500
ScoutingYoutubeLink 4

ScoutingYoutubeLink

GET
/api/user/{user_id}/event/{event_id}/property/{property_id}/youtube-links
List scouting YouTube links
f37e57ce3931072c428b34c3e1019ea4 3 params → 200
POST
/api/user/{user_id}/event/{event_id}/property/{property_id}/youtube-links
Create scouting YouTube link
fbf9d05c4a9df0c3785de2a173c2352a 3 params body → 201
PUT
/api/user/{user_id}/event/{event_id}/property/{property_id}/youtube-links/{youtube_link_id}
Update scouting YouTube link
8ba473a8031b2e2b3861ef41461309ba 4 params body → 200
DELETE
/api/user/{user_id}/event/{event_id}/property/{property_id}/youtube-links/{youtube_link_id}
Delete scouting YouTube link
0cc8ce3838092a4c4edae7fdee1dbcfe 4 params → 204
UserEventUploads 4

UserEventUploads

GET
/api/user/{user_id}/event/{event_id}/property/{property_id}/uploads
List user event uploads
524f8e4fdc1679c416a7d77907e179b9 3 params → 200
POST
/api/user/{user_id}/event/{event_id}/property/{property_id}/uploads
Create user event upload
771e646a60c2f5aa906c4bc4553604c4 3 params body → 200
GET
/api/user/{user_id}/event/{event_id}/property/{property_id}/uploads/{id}
Get user event upload
980635bb54b0609011b71e03bc7b2c4c 4 params → 200
DELETE
/api/user/{user_id}/event/{event_id}/property/{property_id}/uploads/{id}
Delete user event upload
24dc1887901dea7a932854a1f13a7a62 2 params → 204
Scouting Groups 3

Scouting Groups

GET
/api/scouting-groups
List scouting groups
c5781451f1f168b06373e1540fb1b1de → 200
POST
/api/scouting-groups
Create or update scouting group
a62afe6f35086bd538f28960530ea525 body → 200
DELETE
/api/scouting-groups/{id}
Delete scouting group
6dc6853da67618952c1bc19a474813b4 1 param → 204
Social Scraping Sessions 6

Social Scraping Sessions

GET
/api/unmatched-handles/{type}
List matched suggestions for brand unmatched handles
9a8a07bdffc544680cb891496521fbac 4 params → 200401422
GET
/api/unmatched-handles/property
List matched suggestions for property unmatched handles
573c306d117d36e7f6c0728c8b310203 3 params → 200401422
GET
/api/social-scraping-sessions
List league social scraping sessions
f617ecb88fca2271399be8bdfc587b8e 20 params → 200401422
GET
/api/social-scraping-sessions/metadata
Get metadata for social scraping session filters
1503975946cff04fc828c91fa78c13ea 6 params → 200422
GET
/api/social-scraping-session/{id}
Get a single social scraping session
0417d333767f17f71ea890853caa2d00 1 param → 200401
GET
/api/social-scraping-sessions/league/{leagueId}/latest/download
Download latest league social scans
a4020e700c894c877101ee48d63d226e 2 params → 200
Spend tracker 43

Spend tracker

GET
/api/spend-tracker/accuracy-metrics/league/{leagueId}/season/{seasonId}
Get accuracy metrics for league in season
f500969136e1001e147bce6ef2156007 2 params → 200
GET
/api/spend-tracker/currency-rates
Get currency exchange rates for a season
217cadb5e7e9edb860992e98b98f6b1c 1 param → 200
PUT
/api/spend-tracker/currency-rates
Update currency exchange rates for a season
63f9d62ecf90fce72c96064315f19417 body → 200
GET
/api/spend-tracker/bucket/assets
Get all asset buckets
3b21ebc75cf8f6e4ace00b5f4d79e670 → 200
POST
/api/spend-tracker/bucket/assets
Update asset buckets
39ee2b1280b1ae0e5cdd5ac37bed9ef6 body → 201
GET
/api/spend-tracker/change-log/season/{seasonId}
Fetch and format activity logs for spend tracker actions by season id
11336d3a0c7334f0513e31ba5703601f 1 param → 200
GET
/api/spend-tracker/deal-bucket-assets
Get deal with deal assets in buckets
cbfc753d982e3b42de8399fb18d7163a body → 200
POST
/api/spend-tracker/league-assets/custom-bucket
Assing an asset to a different bucket, only for a certain deal
065d70f66e9f126868752b47c57babff body → 200
PUT
/api/spend-tracker/deal-levels
Update deal level
46c17ed57521c9c33da7328d0594cdf5 body → 200
DELETE
/api/spend-tracker/deal-levels/season/{seasonId}/property/{propertyId}/brand/{brandId}
Delete deal level
bdfcaa7c7f3e7ae7f6df042f6f4ba891 3 params → 204404
POST
/api/spend-tracker/deal-types
Create deal type
36dcf579f48882ca602031cb409a1a7e body → 200
PUT
/api/spend-tracker/deal-types/{id}
Update deal type
99072c0508aa97d8b2a7b84081ca51f4 body → 200
DELETE
/api/spend-tracker/deal-types/{id}
Delete deal type
5cabbabc832c5a326ee8f9ea0acb30c7 body → 204404
GET
/api/spend-tracker/dollar-off-metrics/accuracy-selection
Get Dollar-Off Accuracy Selections for league and season
1898aa181391b5b09622098751c9de87 → 200
POST
/api/spend-tracker/dollar-off-metrics/accuracy-selection
Highlight a cell in Dollar-Off Metrics Accuracy Selection table
e3ff2251a8900ab3b69941bb25cecfe9 → 204
DELETE
/api/spend-tracker/dollar-off-metrics/accuracy-selection
Remove Highlight from a cell in Dollar-Off Metrics Accuracy Selection table
3920981fad7b05b15a721072177aad85 → 204
GET
/api/spend-tracker/dollar-off-metrics/league
Get Dollar-Off metrics for league and season
3a87e017973166a460942b4ef18f24a4 → 200
GET
/api/spend-tracker/metrics/dollar-off
Get dollar-off metrics
35a2788882b0439863fc4e07be964795 → 200
POST
/api/spend-tracker/metrics/dollar-off
Highlight metrics cell
9db709b9538d6ee05d797df13c23ef41 → 204
DELETE
/api/spend-tracker/metrics/dollar-off
Remove metrics cell highlight
d4dcdbeeba7aa55370c1c0778c85adb1 → 204
GET
/api/spend-tracker/league-assets/{leagueId}/season/{seasonId}
Fetch league asset buckets with droplets
177818034594465200b97f570662f837 2 params → 200
POST
/api/spend-tracker/league-assets/{leagueId}/season/{seasonId}
Fetch league asset buckets with droplets
5fd5bbae0bb3c4c3f3e667142c14a060 2 params body → 200
GET
/api/spend-tracker/league/{leagueId}/season/{seasonId}/minimums/calculate
Calculate League Minimums, save to database, return League Minimums
d3948bb1739920103da839f857669647 2 params → 200
GET
/api/spend-tracker/league-properties/{leagueId}/season/{seasonId}
Fetch league property buckets and revenues in season
8f3c0dbe61678adbaef1063932d87b3f 2 params → 200
POST
/api/spend-tracker/league-properties
Creates/updates Buckets and Droplets in specific LeaguePropertyBuckets
56c4a4c1da5a07a5eadf43482eaa3dce body → 200
GET
/api/spend-tracker/revenue/league/{leagueId}/season/{seasonId}
Fetch league revenue in season
7da04a734412dc545300d5b667bebfc1 2 params → 200404
GET
/api/spend-tracker/leagues
Fetch spendtracker leagues with buckets
9f09ef16ffc4e7558ffca3f983224776 → 200
GET
/api/spend-tracker/league/{leagueId}/season/{seasonId}/margin-of-error/calculate
Calculate Margin of Error, save to database, return WIP Predicted Revenues with MOE
18b2eda354297e7ba2b6b9783c7c7010 2 params → 200
GET
/api/spend-tracker/property-deal-revenues/actual/season/{seasonId}/property/{propertyId}
Fetch property deals with actual revenues grouped by parent brand
eb23e3c13fff633587f3d27f326ad6f4 2 params → 200
GET
/api/spend-tracker/property-deal-revenues/predicted/season/{seasonId}/property/{propertyId}
Fetch property deals with predicted revenues grouped by parent brand
43710b2f5aa2248986bbfe24208909ea 2 params → 200
GET
/api/spend-tracker/property-deal-revenues/predicted/league/{leagueId}/season/{seasonId}/download
Fetch league deals with predicted revenues grouped by parent brand
f65158e84467d3ba4b9026bc41937d9f 1 param → 200
POST
/api/spend-tracker/revenue/accept-wip-predicted-deal-revenues
a74b2a2bbdc1bfb4371ca649861ba15a body → 204
GET
/api/spend-tracker/property-deal-revenues/season/{seasonId}/property/{propertyId}
Fetch property deals with revenues grouped by parent brand
fe1e46e83488920c9c29b1da40dced1b 2 params → 200
PUT
/api/spend-tracker/publish/season
Publish SpendTracker data by League and Season
34fee405549f93f4d09d510829b40034 body → 200
GET
/api/spend-tracker/revenue/deals
Fetch deal, property and predicted revenues for property in season
e9840745f3112724811eb572c9f278a1 body → 200
GET
/api/spend-tracker/revenue/deals/deal
Fetch brand revenues, types and levels for property across seasons
8a0e74abadaaa3a18f50c2fe43ffc97a body → 200
POST
/api/spend-tracker/revenue/deals/deal
Update deal brand revenues across seasons
ef78556dff185a7e6a0bd4831b8240bc body → 200
GET
/api/spend-tracker/revenue/deals/deal/season
Fetch actual/estimated revenue and predicted revenue for deal in season
b80dfe9aeb9dac36e732c0a23b14215d body → 200
POST
/api/spend-tracker/revenue/deal-revenues/duplicate
Duplicate actual/estimated Deal Revenues from one season to another
af3b544d938853f5f0bf665495c4f360 body → 200
POST
/api/spend-tracker/revenue/subcategory/factors
Update subcategory revenue factors for league in season
19cbe81114ddb1f8f93f145818294cc9 body → 201
GET
/api/spend-tracker/revenue/subcategory/{subcategoryId}/season/{seasonId}
Fetch subcategory revenues in season
87bcb93801ca3d4aa5d78f9615ac9904 2 params → 200
POST
/api/spend-tracker/revenue/subcategory-revenues
d107e572679297d0c9295b2f30d87792 body → 201
GET
/api/spend-tracker/revenue/subcategories-deals/league/{leagueId}/season/{seasonId}
Fetch league subcategories revenues report in season
18a937056b508c523abd38a822777184 2 params → 200
Stats 6

Stats Performance API endpoints

GET
/api/stats/mappings
Get available SU/STATS mapping entries
getStatsMappings body → 200401422
GET
/api/stats/mappings/sports
Get available sports from Stats Perform
getStatsSports body → 200401422
GET
/api/stats/mappings/leagues
Get available leagues from Stats Perform
getStatsLeagues body → 200401422
PUT
/api/stats/mappings/{id}
Update a stats perform mapping
updateStatsMapping 1 param body → 200401404422
PUT
/api/stats/unmap/{id}
Unmap a stats perform mapping
unmapStatsMapping 1 param → 200401404
GET
/api/stats/mappings-job-status/{propertyId}
Get job status for a property
getStatsPerformJobStatus 1 param → 200401
language 2

language

GET
/api/language/{domain}
Fetch language fields
24e2d761909b96c578396a9f6ae302ee → 200
POST
/api/language/{domain}
b7539dd42890b9eff8362db9c7317bc9 body → 201
Subcategory 8

Subcategory

GET
/api/subcategory
List all subcategories
d0ef34a3d183131dac2ccc3fee2f3764 1 param → 200401
POST
/api/subcategory
Create a new subcategory
0b77d9c7d1c76b7bd5fb6f6d94bdd94e body → 200401403422500
GET
/api/subcategory/{id}
Get a subcategory by ID
06653546c6a25efefe7d2bdcfc813606 1 param → 200401403
PUT
/api/subcategory/{id}
Update a subcategory
79b491fe0b903767f66257da636daa10 1 param body → 200401403404422
DELETE
/api/subcategory/{id}
Delete a subcategory
86e8237bae1ff5d55df21e12e496619c 1 param → 204401403404
GET
/api/subcategory/top-rank
Get top ranked subcategory
76ad458de6f592a6b8eb0ce14b2ced78 → 200401
GET
/api/subcategory/{id}/intent
Get subcategory intent data
120e6b1e4f171feb9e8d1b804b702f81 1 param → 200401
PUT
/api/subcategory/{oldId}/reassign/{newId}
Reassign brands to another subcategory
93b4b32dc9daebdd4d0a480c6aa0d522 2 params → 200401404500
Subscription 1

Subscription

POST
/api/subscription/swap-plan
Swap the subscription plan of a billable entity.
swapSubscriptionPlan body → 200403422
Surface 7

Surface context and usage endpoints

GET
/api/me/surface/context
Get authenticated user's Surface context
698f1e9a17edaf0f846902ced2ef565d → 200401
POST
/api/me/surface/usage/record
Record a Surface prompt usage and check limit
cf3ed601eaa2b22f2fe4af9d6e357fa0 → 200401
GET
/api/me/surface/usage
Get current Surface usage status
397f563e396f624f71835c69257ad7cb → 200401
GET
/api/me/surface/user-context
Get the authenticated user's Surface user context
1e3827335eb4adf1cafa2fc05eff5b55 → 200401
PUT
/api/me/surface/user-context
Update the authenticated user's Surface user context
56d8da641d7ffcdfcbe63d8524aae715 body → 200401422
GET
/api/organization/{organizationId}/surface/context
Get an organization's Surface context
be005d21bbb7248dd352429fc6cc4af7 1 param → 200401403
PUT
/api/organization/{organizationId}/surface/context
Update an organization's Surface context
898ee6c813a7eb13e587f19fedd71296 1 param body → 200401403422
Tags 2

Tags

GET
/api/tags
3b8fd17c63dfdad4c49a9ce73fb0e066 body → 200
PUT
/api/tag
c6e4cbd4c75b281bc0d18103137d8bc5 body → 200
Tasks 9

Tasks

GET
/api/tasks/metadata
Get task metadata
444ba23093ea6f3cf8d23d92af8e6b31 1 param → 200
GET
/api/tasks
List tasks
471d938a3bfaeb6fbd981d7c3e2728b0 1 param → 200
GET
/api/tasks/export/invalid-emails
Export invalid email tasks
fe4d5adeeb1b1e7cc12d5aeb05052c83 1 param → 200
GET
/api/tasks/export/invalid-social-tasks
Export invalid social tasks
5a000e24be009bfb116cc4ef5689c983 1 param → 200
GET
/api/tasks/{id}
Get task by ID
90b3cd4d2d4b416dc989d2055dbed06c 1 param → 200
PUT
/api/tasks/{id}
Update task
1aaf37e74360ef4c10fadaee02ae77fb 1 param body → 200
DELETE
/api/tasks/{id}
Delete task
ad582480cd57c2a4e3b6a426943eeca5 1 param → 204
POST
/api/tasks/
Create task
b263247033817cfd225af5d2a51a93fb body → 200
PUT
/api/tasks/{taskId}/assign
Assign task to user
8e3bea883b14aa0aae0f3f808b0beac1 1 param → 204
Transcription 1

Transcription

POST
/api/webhooks/transcription
Handle the data-ingestion transcription completion webhook
71a8e5d7c2178ab12352a85ca897fa72 body → 200422
Follows 2

Follows

POST
/api/follows
Follow one or more entities
b51b60ea8fc7dec0803ae92a4530c977 body → 200401422
DELETE
/api/follows
Unfollow one or more entities
69ef442f3509964dd78fead1e3ec3a2e body → 204401422
User 7

User

POST
/api/integration/salesforce/access-token
f9e23006d272a3c9bd73317396ea0cf0 body → 200
PUT
/api/user/{id}
Update a user
ec1a3effa21ec04f5b2bd8865806a89a 1 param body → 200
PUT
/api/user/{id}/profile
Update user profile
b24fa748295efa27b8b9c706ae54b0d8 1 param body → 200
POST
/api/user/profile/{id}/phone/validate
Validate and send phone verification PIN
0e48f7966790f7ab8a78f032a889162b 1 param body → 200
POST
/api/user/profile/{id}/phone/verify
Verify phone number PIN
ef9cc65df5368525b3def92de7d39c73 1 param body → 200
GET
/api/user/by-email
Get user by email
fbfdd986024cbb953166810bf850d816 1 param → 200
POST
/api/user/downloadUrl
cd6c5128b0c1f4bd290f90b35c721e55 body → 200422503
User Management 32

User Management

GET
/api/me
Get current user
31b0d32acb524c1d5a56453eb860d66d → 200401
GET
/api/me/access/{entityType}
Get user access permissions
ce3191316a8b980d74a4df910febbb5d 1 param → 200401
GET
/api/entities
Get user entities
13cd6aa88ab21979affb330d56c503b6 → 200401
GET
/api/user/{user_id}
Get user by ID
a06a40effd210ef49367ada55a928970 1 param → 200401403404
POST
/api/users
List all users
9428a8001e09068bab0dc2a6fcd34054 body → 200401403
POST
/api/user
Create new user
f180c4943527271251a17160f5602a89 body → 200401403422
DELETE
/api/user/{id}
Delete user
156d66de1b244d16b2daa335a30ffefb 1 param → 200400401403404
GET
/api/user/{id}/representative
Get user representative
e6764d61307532449b0aedb7c79a4232 2 params → 200401404
PUT
/api/user/{id}/representative
Update user representative
5973cac744f8def9246a667b80d5566f 1 param body → 200401404
DELETE
/api/user/{id}/representative
Delete user representative
3bc9d96939d74dc51210159ee97cc6f8 1 param → 200401404500
POST
/api/user/{id}/profile/phone/check
Check phone number validity
c1762c95ea1a53b3b14206aadc746dd9 1 param body → 200400401
POST
/api/user/{id}/profile/email/validate
Initiate email validation
47409117d1235835a9cabe9cbb7d2c87 1 param body → 200400401422
PUT
/api/user/{id}/profile/mfa
Update MFA preference
af2a4d9e2915e62eda3ba1e0ea5f6c86 1 param body → 200401422
PUT
/api/user/{id}/password
Change user password
6269f58e997d88ec71e1791e7d03ba33 1 param body → 200401403
POST
/api/user/{id}/credentials
Send user credentials
f036656c76cab76ec0c2580a240c6e93 1 param body → 200401403404
POST
/api/user/{fromUserId}/dm-reassign
Bulk-reassign Deal Manager profiles and contacts
10130677567c18866edd30ae2ef900c6 1 param body → 200401403404422
GET
/api/user/{userId}/dm-assignments/count
Count a user's Deal Manager assignments
e51f7b0dfba6af8d14d397ede3c8194c 1 param → 200401403404
POST
/api/user/{id}/restore
Restore deleted user
392df502a617d3cb0bf5ca193553dc86 1 param → 200401403404
GET
/api/users/export
Export users
aff36670925ec67b69499b1f73c0b112 3 params → 200401
GET
/api/user/{id}/profile/phone/countries
Get countries list
72e97ad7438e8f4863022a18e1e02f05 → 200401
GET
/api/user/{id}/integration/salesforce
Get Salesforce integration status
d619c947f2abd8328e8e10cd75e9e29a 1 param → 200401404
POST
/api/users/intercom-sync
Sync users to Intercom
01abe88ed275b660cadbe0464da5d806 body → 202403
GET
/api/users/intercom-sync-status
Get users Intercom sync status
af628fcb5305272cb6fd1e3ce3ce0af0 1 param → 200403
POST
/api/users/for-report-sharing
List users for report sharing
forReportSharing body → 200401403422
GET
/api/user/events
List user events
c0a5bdc0b689d60bb5cdd0d12329a890 11 params → 200401422
GET
/api/user/{user_id}/event/{event_id}/team/{team_id}
Get single user event
7bbb03c61b3c5af244d4c639cbaeb45d 3 params → 200401404
POST
/api/user/{user_id}/event/{event_id}/team/{team_id}
Create or update user event
6307350b8b21cdf4dcac4a4a3955f4b8 3 params body → 200400401422
DELETE
/api/user/{user_id}/event/{event_id}/team/{team_id}
Delete user event
b73c3ac932c400bf4c1d7be4ee040237 3 params → 204400401404
GET
/api/user/events/download
Export user events
a97da5668fccb315a5e42734a466026b 4 params → 200401422
POST
/api/user/settings
Create user setting
4a09ccf8120071be7948ae3b6dfcc859 body → 200401422
PUT
/api/user/settings/{id}
Update user setting
fbb8a4cd8a6dfba5b2546051ab8a0dd1 1 param body → 200401403404
DELETE
/api/user/settings/{id}
Delete user setting
70c5f8429bdb0d889f8138bc1024d012 1 param → 204401403404500
Users 1

Users

GET
/api/users/search
Search users by name
870e0c5e700bcc087b5ca3cfe0049939 1 param → 200
Cookies 1

Cookies

POST
/api/user-social-cookies
Update user cookies
userCookies body → 200401
User Authentication 1

User Authentication

GET
/api/users/{id}/invalidate
Invalidate User Tokens
invalidateUserTokens 1 param → 200404
User Actions 9

User activity tracking and organization statistics endpoints

GET
/api/user-actions
Get user actions
8217d4dee6518c14d691f5d6e285c1aa 3 params → 200
GET
/api/track/organization/stats
Get all organization statistics
6c8929e308dd725c0a0e716ba633cb24 2 params → 200401
GET
/api/track/organization/stats/export
Export all organization statistics
8be3f9c3dfdd119d6d6955f1da6e1aef 2 params → 200401
GET
/api/track/organization/{organization_id}/stats
Get organization statistics
ffcc3b63bddd3d4f5f4e99c5665aa00a 3 params → 200401
GET
/api/track/organization/{organization_id}/stats/export
Export organization statistics
8ee16e6ed81610e7aa962072b21defb4 3 params → 200401
GET
/api/track/organization/{organization_id}/stats/user
Get organization user statistics
884680279e13f7e35884fba30ff4f489 3 params → 200401
GET
/api/track/organization/{organization_id}/stats/weekly
Get organization weekly statistics
17109e09fb716082b087fa6f3edae2a7 3 params → 200401
GET
/api/track/organization/{organization_id}/stats/category
Get organization category statistics
11db03e97916a183a03c8853dab1e493 3 params → 200401
GET
/api/track/organization/{organization_id}/stats/league
Get organization property type statistics
cbe197d686bedeb45fb6665aa0b8be94 3 params → 200401
User Custom Reports 4

User Custom Reports

PUT
/api/user/custom-reports/{id}/rename
Rename a user's custom report
12d65039d785ecedbb39f94a0ee42507 1 param body → 200403404422
DELETE
/api/user/custom-reports/{id}
Delete a user's custom report
1bb45af3d01a08ee9ec58e516fdeb88c 1 param → 200403404
POST
/api/user/custom-reports/{id}/duplicate
Duplicate a user's custom report
f95af124361b5ef8465fcf591e8cb612 1 param → 201403404
POST
/api/custom-reports/{id}/mark-viewed
Mark a user's custom report as viewed
804d28c4e99271e2cc4e802b74f4ec3a 1 param → 200403404
Vortex 5

Service-to-service endpoints for the Vortex mobile app. Authenticated via X-API-Key header.

POST
/api/vortex/upload-image-from-url
Ingest a scouting photo from a URL as an asset
3bc149d730c8a0f92d46b2a9aa9fc9a3 body → 201422401
POST
/api/vortex/events
Create a scouting event from a Vortex session
735059a13732ba80b5619ddbc579e9f4 body → 201422401
POST
/api/vortex/audit/bulk
Push bulk scouting data from a completed Vortex session
b345ce5989c7db7985d6226075ceca03 body → 200422401
POST
/api/vortex/user-event-notes
Attach notes to a scouting event
7688f9a0f9fc94c86a6f3aec6bb465c7 body → 201422401
POST
/api/vortex/user-event-uploads
Attach session-level media to a scouting event
64882b86eec7c644fd28067f5e650665 body → 201422401
YouTube Brand Assets 1

YouTube Brand Assets

GET
/api/youtube-brand-assets-combination/{userEvent}
Get brand-asset combinations for a YouTube scouting event
1cd62c0bed197799e56b1eb7797a9f12 1 param → 200404

Schemas 561

The contract defines 561 schemas that model the data the API accepts and returns. The most detailed are Property (40 properties), PropertySocialMediaDetails (32 properties), Company (32 properties), AgencyContact (31 properties). Each schema is shown below with its type and property counts.

StatsMappingDto
object
Data Transfer Object representing a stats perform mapping entry
10 properties
StatsMappingUpdateDto
object
Data Transfer Object for updating a stats perform mapping
1 property
StatsPerformJobStatusDto
object
Data Transfer Object representing the status of Stats Perform import jobs for a property
9 properties
EmailExistsResponse
object
1 property
VerifyUserResponse
object
2 properties
SendPinResponse
object
2 properties
EnrollResponse
object
2 properties
ForgotPasswordResponse
object
2 properties
ResetPasswordResponse
object
2 properties
GenericEntity
object
2 properties
LeagueAssetEntity
object
8 properties
PropertySyncEntity
object
3 properties
PropertyKnownBrandEntity
object
5 properties
StoreAgencyContactRequest
object
19 properties 1 required
UpdateAgencyContactEmailStatusRequest
object
3 properties 3 required
UpdateAgencyContactRequest
object
19 properties
AgencyServiceCreateRequest
object
2 properties
AgencyServiceTypeCreateRequest
object
1 property
AgencyServiceTypeUpdateRequest
object
1 property
AgencyServiceUpdateRequest
object
2 properties
AgencyStoreRequest
object
1 required
AgencyUpdateRequest
object
1 required
AssetGroupingIndexRequest
object
3 properties
AssetGroupingReassignRequest
object
1 property
AssetGroupingRequest
object
3 properties
AssetIndexRequest
object
6 properties
AssetStoreUpdateRequest
object
21 properties 4 required
AssetSubgroupingStoreRequest
object
4 properties
AssetSubgroupingTagRequest
object
1 property
AssetSubgroupingUpdateRequest
object
3 properties
AttendanceUpdateRequest
object
Request for updating attendance data
1 property
UpdateEmptyAudioRequest
object
6 properties 4 required
StoreAudioDownloadLinkRequest
object
1 property 1 required
AuditBulkReassignBrandRequest
object
3 properties 1 required
AuditCopyRequest
object
2 properties 1 required
AuditReviewListRequest
object
8 properties
BulkAddAuditsRequest
object
5 properties 3 required
SaveUserEventRequest
object
9 properties 1 required
UpdateUserEventsRequest
object
10 properties
AuditReviewBulkCloneRequest
object
3 properties 1 required
AuditReviewBulkDeleteRequest
object
2 properties
AuditReviewBulkRejectRequest
object
3 properties 1 required
AuditReviewBulkUpdateRequest
object
6 properties 1 required
AuthEmailExistsRequest
object
1 property 1 required
LoginRequest
object
3 properties 2 required
VerifyLoginRequest
object
1 property 1 required
ApproveBrandCompetitorReviewItemRequest
object
1 property 1 required
RejectBrandCompetitorReviewItemRequest
object
2 properties 1 required
BrandSynonymStoreRequest
object
1 required
BrandSynonymUpdateRequest
object
1 required
CategoryIndexRequest
object
1 property
CategoryStoreRequest
object
2 properties 1 required
CategoryUpdateRequest
object
2 properties 1 required
CompanyIndexRequest
object
7 properties
StoreBrandContactRequest
object
19 properties 1 required
UpdateBrandContactEmailStatusRequest
object
3 properties 3 required
UpdateBrandContactRequest
object
18 properties
BrandContactsIndexRequest
object
1 property
BadEmailReportIndexRequest
object
1 property
ContactCreateSaleRequest
object
3 properties 2 required
ContactDeleteSaleRequest
object
3 properties 1 required
ContactEmailStatusFileRequest
object
1 property
ContactIndexRequest
object
1 property
ContactLinkedinEmployeeSearchRequest
object
2 properties
ContactLinkedinScrapeShowRequest
object
1 property 1 required
ContactSearchByEmailRequest
object
2 properties
ContactSearchBySchoolRequest
object
2 properties
StoreContactRequest
object
21 properties 1 required
UpdateContactEmailStatusRequest
object
3 properties 3 required
UpdateContactRequest
object
21 properties
PhantombusterEmployeeSearchWebhookRequest
object
11 properties 3 required
ReportBadEmailRequest
object
3 properties 3 required
ActiveCuratedNewsRequest
object
8 properties
AddNewsContactsRequest
object
1 property 1 required
AnalyseCuratedNewsRequest
object
7 properties 1 required
NewsSubmissionShowRequest
object
1 property
NewsSubmissionsRequest
object
10 properties
ResolveNewsContactRequest
object
1 property 1 required
StoreNewsAssetRequest
object
2 properties 1 required
UpdateNewsAssetRequest
object
3 properties
CustomReportIndexRequest
object
8 properties
CustomReportRenameRequest
object
1 property 1 required
CustomReportShareRequest
object
1 property 1 required
CustomReportStoreRequest
object
11 properties 1 required
IngestionWebhookRequest
object
9 properties 4 required
ListIngestionJobsRequest
object
2 properties
SubmitIngestionRequest
object
2 properties 2 required
EnrollRequest
object
3 properties 3 required
FeedbackSendRequest
object
1 property
FileUploadRequest
object
Request schema for uploading a file
2 properties 1 required
ForgotPasswordRequest
object
1 property 1 required
CropImageRequest
object
Request schema for cropping an image
4 properties 1 required
DownloadImageRequest
object
Request schema for downloading an image as base64
1 property 1 required
GetLogosRequest
object
Request schema for detecting logos in an image via Google Cloud Vision
1 property 1 required
UploadImageFromUrlRequest
object
Request schema for uploading an image from a URL to S3
2 properties 1 required
InfographicsIndexRequest
object
7 properties
InfographicsStoreRequest
object
10 properties 5 required
InfographicsUpdateRequest
object
10 properties 5 required
SalesforceAccessTokenRequest
object
2 properties
SaveSalesforceRequest
object
3 properties
BrandsSyncRequest
object
2 properties
LeagueAssetsSyncRequest
object
2 properties
PropertiesSyncRequest
object
2 properties
PropertyKnownBrandsSyncRequest
object
2 properties
VenuesSyncRequest
object
2 properties
ItemValueIndexRequest
object
2 properties
ItemValueUpdateRequest
object
7 properties
PositionKeywordRequest
object
1 property 1 required
StoreKeywordRequest
object
2 properties 2 required
UpdateKeywordRequest
object
2 properties
LeagueStoreRequest
object
21 properties
LeagueUpdateRequest
object
24 properties
LeagueSocialScrapingPlatformSettings
object
5 properties
LeagueUpdateSocialScrapingSettingsRequest
object
4 properties
LeagueDealsFilterOptionsRequest
object
9 properties 1 required
LeagueDealsStatisticsCompletionRequest
object
3 properties 1 required
LeagueDealsStatisticsRequest
object
3 properties
LeagueItemsUpdateItemLeaguesRequest
object
2 properties
LeagueItemsUpdateLeagueItemsRequest
object
2 properties
LeagueLatestScoutingDatesFilterOptionsRequest
object
1 property
LeagueLatestScoutingDatesIndexRequest
object
7 properties
LocationForSmartSearchOnBrandsDownloadRequest
object
5 properties
LocationForSmartSearchOnBrandsMetadataRequest
object
8 properties 1 required
LocationForSmartSearchOnBrandsShowRequest
object
12 properties
LocationStoreRequest
object
7 properties
LocationUpdateRequest
object
5 properties
LogoRecognitionIgnoreBrandsRequest
object
1 property
LogoRecognitionImageProcessRequest
object
1 property 1 required
ManageMarketCategoryForCountryRequest
object
5 properties 3 required
MarketIndexRequest
object
6 properties
MarketStoreUpdateRequest
object
8 properties 1 required
MintTokenRequest
object
1 property 1 required
LeagueScoutingNoteUpsertRequest
object
7 properties
AdminOrganizationSurfaceContextUpdateRequest
object
1 property 1 required
OrganizationEvalProposalSaveRequest
object
1 property
OrganizationIndexRequest
object
10 properties
OrganizationIntercomSyncRequest
object
1 property
OrganizationSurfaceContextUpdateRequest
object
1 property 1 required
OrganizationSyncMarketsRequest
object
1 property
OrganizationSyncPropertyTypeRequest
object
1 property
OrganizationUpdateContractRequest
object
21 properties
OrganizationUpdateRequest
object
16 properties 6 required
StoreOrganizationTypeRequest
object
4 properties 1 required
UpdateOrganizationTypeRequest
object
5 properties 1 required
PartnershipReportIndexRequest
object
7 properties
PartnershipReportWriteRequest
object
12 properties
PermissionUpdateRequest
object
2 properties
ProductCreateRequest
object
4 properties
ProductUpdateRequest
object
3 properties
ReportSharingRecipientsRequest
object
2 properties
ReportSharingReportsRequest
object
1 property
RepresentationUpdateRequest
object
7 properties
ResetPasswordRequest
object
4 properties 4 required
StoreRoleRequest
object
5 properties 1 required
UpdateRoleRequest
object
4 properties
RoleOrientationIndexRequest
object
1 property
RoleOrientationStoreRequest
object
1 property 1 required
RoleOrientationUpdateRequest
object
1 property 1 required
SavedReportShareRequest
object
1 property 1 required
SavedReportStoreRequest
object
4 properties
SavedReportUpdateRequest
object
1 property
ScoutingGroupsStoreRequest
object
4 properties 1 required
ScoutingYoutubeLinkStoreRequest
object
1 property 1 required
ScoutingYoutubeLinkUpdateRequest
object
1 property 1 required
SearchEntityByIdRequest
object
2 properties 1 required
SearchEntityRequest
object
1 property
SearchIndexedRequest
object
15 properties 1 required
SearchSmartOnBrandsRequest
object
8 properties
BrightdataPostsDeliveryRequest
object
2 properties 2 required
AssetsBucketsUpdateRequest
object
1 property 1 required
CurrencyExchangeRateIndexRequest
object
1 property 1 required
CurrencyExchangeRateUpdateRequest
object
2 properties 2 required
DealBucketAssetsGetDealAssetsByBucketsRequest
object
4 properties 3 required
DealLevelsUpdateRequest
object
4 properties 4 required
DealTypesCreateUpdateRequest
object
6 properties 4 required
DealTypesDeleteRequest
object
3 properties 3 required
AccuracySelectionIndexRequest
object
2 properties 2 required
AccuracySelectionUpdateRequest
object
4 properties 4 required
LeagueAssetBucketsUpdateRequest
object
1 property 1 required
SaveCustomAssetBucketForDealRequest
object
7 properties 6 required
LeaguePropertyBucketsUpdateRequest
object
2 properties 2 required
DollarOffMetricsHighlightCellRequest
object
4 properties 2 required
DollarOffMetricsRequest
object
2 properties 2 required
GetPropertyDealsWithPredictedRevenuesRequest
object
1 property 1 required
PublishedSeasonUpdateRequest
object
3 properties 1 required
RevenueDealParentLineUpdateRequest
object
5 properties 5 required
RevenueDealPredictedParentLineUpdateRequest
object
5 required
RevenuePropertyUpdateRequest
object
1 property 1 required
RevenueSubcategoryUpdateRequest
object
1 property 1 required
AcceptWIPPredictedDealRevenuesRequest
object
2 properties 2 required
DealRevenuesDuplicateRequest
object
5 properties 4 required
PropertyReviewDealSeasonsRequest
object
3 properties 3 required
RevenueDealGetDealDataBySeasonsRequest
object
3 properties 3 required
RevenueDealGetDealRevenueInSeasonRequest
object
4 properties 3 required
RevenueDealGetPropertyDealRevenuesRequest
object
2 properties 2 required
RevenueDealUpdateDealRevenuesRequest
object
5 properties 1 required
UpdatedSubcategoryRevenuesRequest
object
4 properties 3 required
SubcategoryRevenueFactorsUpdateRequest
object
3 properties 3 required
StatsMappingUpdateRequest
object
Request schema for updating a stats perform mapping
1 property 1 required
StatsMappingsGetRequest
object
Request schema for filtering stats perform mappings
7 properties
StatsMappingsLeaguesRequest
object
Request schema for filtering stats perform leagues by sport and api type
2 properties
StatsMappingsSportsRequest
object
Request schema for filtering stats perform requests by api type
1 property
SuLanguageRequest
object
1 property 1 required
SubcategoryIndexRequest
object
1 property
SubcategoryStoreRequest
object
7 properties 1 required
SubcategoryUpdateRequest
object
6 properties
SwapPlanRequest
object
3 properties 3 required
AdminUserSurfaceContextUpdateRequest
object
1 property 1 required
SurfaceUserContextUpdateRequest
object
1 property 1 required
TagIndexRequest
object
1 property
TagUpdateRequest
object
2 properties
TaskStoreRequest
object
5 properties
TaskUpdateRequest
object
5 properties
StorePropertyContactRequest
object
18 properties 1 required
UpdatePropertyContactEmailStatusRequest
object
3 properties 3 required
UpdatePropertyContactRequest
object
18 properties
TranscriptionWebhookRequest
object
9 properties 3 required
DealManagerReassignRequest
object
1 property 1 required
OrgAdminUserCreateRequest
object
13 properties 2 required
OrgAdminUserUpdateRequest
object
3 properties
UserAllRequest
object
9 properties
UserCookiesRequest
object
2 properties
UserCreateRequest
object
17 properties 4 required
UserDownloadFileRequest
object
2 properties 1 required
UserExportRequest
object
3 properties
UserForReportSharingRequest
object
25 properties
UserGetByEmailRequest
object
1 property 1 required
UserIntercomSyncRequest
object
1 property
UserProfileUpdateRequest
object
14 properties 3 required
UserRepresentativeRequest
object
1 property
UserSearchRequest
object
4 properties 1 required
UserUpdateMfaPreferenceRequest
object
1 property 1 required
UserUpdateRequest
object
14 properties 3 required
ValidateUserEmailRequest
object
1 property 1 required
ValidateUserPhoneNumberRequest
object
2 properties 2 required
VerifyUserPhoneNumberRequest
object
2 properties 2 required
UserCustomReportRenameRequest
object
1 property 1 required
UserEventAllRequest
object
18 properties 1 required
UserEventCreateOrUpdateRequest
object
6 properties 1 required
UserEventUploadsStoreRequest
object
2 properties
UserSettingCreateRequest
object
3 properties 2 required
UserSettingUpdateRequest
object
2 properties 1 required
VortexBulkAddRequest
object
5 properties 4 required
VortexCreateEventRequest
object
9 properties 5 required
VortexUserEventNotesStoreRequest
object
4 properties 4 required
VortexUserEventUploadsStoreRequest
object
4 properties 4 required
GetBrandClipTimingsRequest
object
Request parameters for retrieving brand clip timings
2 properties
AgencyLightResource
object
3 properties
AgencyServicesIndexResource
array
AgencyServicesResource
object
3 properties
AgencyServicesTypeIndexResource
array
AgencyServicesTypeResource
object
2 properties
AgencyShowStoreUpdateResource
object
AssetGroupingIndexResource
array
AssetGroupingResource
object
5 properties
AssetIndexResource
object
AssetResource
object
24 properties
AssetSubgroupingIndexResource
object
2 properties
AssetSubgroupingIntentResource
object
8 properties
AssetSubgroupingResource
object
6 properties
AttendanceResource
object
17 properties
AudioResource
object
7 properties
AudioDownloadLinkResource
object
4 properties
ReviewMetadataResource
object
4 properties
AuditSynonymCollection
array
List of audit synonyms.
AuditSynonymResource
object
4 properties
BrandCompetitorReviewItemResource
object
17 properties
BrandSynonymIndexResource
array
BrandSynonymResource
object
3 properties
BrandFinancialDataResource
object
A brand's financial data for one fiscal year
8 properties
CompanyIndexResource
array
CompanyLightResource
object
4 properties
CompanyResource
object
Brand details with related data (agencies, organizations, primary/secondary profiles)
ActiveCuratedNewsResource
array
AnalyseCuratedNewsResource
object
5 properties
AnalyseCuratedNewsResultsResource
object
1 property
CuratedNewsArticlePreviewResource
object
3 properties
NewsAssetResource
object
12 properties
NewsContactAddResultsResource
object
1 property
NewsMatchStatsResource
object
4 properties
NewsReResolveResource
object
3 properties
NewsSubmissionResource
object
23 properties
NewsExtractionMatch
object
Entity-mapping resolver verdict for one extracted person (OP-966/967/968).
9 properties
NewsExtractionMatchedContact
object
Present-day platform values of the matched contact, for side-by-side comparison against the extracted ones. Null when the extraction resolved to no contact.
5 properties
NewsExtractionAdd
object
Outcome of adding this extracted person to the platform. Contacts only — a quote becomes a note on a contact, never a contact of its own. notadded is the only…
6 properties
CustomReportLightCollection
object
3 properties
CustomReportLightResource
object
7 properties
CustomReportResource
object
17 properties
IngestionJobResource
object
8 properties
IngestionTaskResource
object
11 properties
AgencyContactIndexResource
array
AgencyContactShowStoreUpdateResource
object
31 properties
AsyncEmployeeFilteringResource
object
Response when AI filtering is being processed asynchronously (HTTP 202 Accepted)
5 properties
BadEmailReportResource
object
7 properties
BrandContactIndexResource
array
BrandContactShowStoreUpdateResource
object
28 properties
ContactEmailStatusFileIndexResource
array
ContactEmailStatusFileMetadataResource
object
1 property
ContactEmailStatusFileResource
array
AgencyContact
object
31 properties
BrandContact
object
31 properties
PropertyContact
object
28 properties
ContactInformationCheckResource
ContactLinkedinScrapedDataResource
object
13 properties 10 required
ContactSearchByEmailResource
array
LinkedinEmployeeSearchResource
object
LinkedIn employee search results with contact links, including both new and existing employees
2 properties
OngoingEmployeeScrapingResource
object
Response when an employee scraping operation is already in progress for the entity
9 properties
PropertyContactIndexResource
array
PropertyContactShowStoreUpdateResource
object
28 properties
SaleContactIndexResource
array
SaleContactShowStoreUpdateResource
object
29 properties
FileUploadCollection
array
List of file uploads.
FileUploadResource
object
File upload details.
11 properties
ErrorResource
object
1 property
HubspotSegmentResource
object
2 properties
InfographicsCollection
array
List of infographics.
InfographicsResource
object
11 properties
SalesforceAccessTokenResource
object
1 property
ItemValueUpdateResource
object
KeywordIndexResource
array
KeywordShowStoreUpdateResource
object
5 properties
LeagueDemographics
object
5 properties
LeagueItemForItemResource
array
LeagueItemForLeagueResource
array
LocationForSmartSearchOnBrandsShowResource
object
17 properties
LocationLabelResource
object
3 properties
LocationResource
object
7 properties
MarketGroupingManagementResource
object
13 properties
OrganizationAccessResource
object
4 properties
OrganizationContractResource
object
23 properties
OrganizationLimitAccessTypeResource
object
3 properties
CredentialsSalesforceResource
object
3 properties
OrganizationSubcategoryAccessResource
object
2 properties
OrganizationSyncMarketsResource
object
9 properties
OrganizationSyncPropertyTypeResource
object
18 properties
OrganizationSyncStatusResource
object
3 properties
OrganizationTypeIndexResource
object
7 properties
OrganizationUsersResource
object
3 properties
PartnershipReportCollection
array
List of partnership reports.
PartnershipReportResource
object
13 properties
PermissionShowResource
object
6 properties
ProductResource
object
7 properties
PropertyLightResource
object
12 properties
PropertyResource
object
PropertyShowSocialResource
object
30 properties
ReportSharingRecipientResource
object
6 properties
ReportSharingReportResource
object
6 properties
ReportSharingRepresentativeResource
object
3 properties
ReportSharingSavedReportResource
object
11 properties
RepresentationResource
object
9 properties
RoleOrientationResource
object
2 properties
RoleIndexResource
object
2 properties
RoleResource
object
4 properties
RoleStoreUpdateResource
object
2 properties
SavedReportLightCollection
object
3 properties
SavedReportLightResource
object
6 properties
SavedReportResource
object
9 properties
ScoutingGroupsIndex
BrandClipTimingResource
object
7 properties
ScoutingYoutubeLinkResource
object
6 properties
SearchByIdGroupedResource
array
SearchEntityResource
array
SearchIndexedResource
object
2 properties
BrandLatestSocialScrapingSessionResource
object
9 properties
BrandSocialScrapingSessionsResource
object
2 properties
BrandSocialScrapingSessionPropertiesResource
object
10 properties
SocialScrapingSessionLatestScansPerLeagueResource
array
PredictionAccuracyResource
object
AccuracyMetricsResultResource
object
2 properties
AssetBucketResource
object
4 properties
AssetBucketsCollection
array
AssetDropletResource
object
8 properties
CalculateLeagueMinimumsResource
object
CalculateMarginOfErrorResource
object
2 properties
SpendTrackerChangeLogShowResource
object
1 property
ClientFacingAssetsRevenueCollection
array
ClientFacingAssetsRevenueResource
object
ClientFacingDealRevenueCollection
array
ClientFacingDealRevenueResource
object
CurrencyExchangeRateResource
object
5 properties
DealAssetAuditResource
object
10 properties
DealBucketAssetsGetDealAssetsByBucketsResource
object
DealLevelsResource
DealNotesResource
object
DealTypesResource
AccuracySelectionResource
object
1 property
LeagueDollarOffMetricsResource
DollarOffMetricsResource
object
LeagueAssetBucketResource
object
8 properties
LeagueAssetBucketsCollection
object
LeagueAssetDropletResource
object
13 properties
BucketLeaguePropertyResource
object
7 properties
DropletLeaguePropertyResource
object
8 properties
LeaguePropertyBucketsShowResource
object
LeagueStatusCollection
object
1 property
LeagueStatusResource
object
2 properties
OrphanRevenuesCollection
PredictChildDealResource
object
6 properties
PredictDealCollection
PredictDealResource
object
PropertyDealRevenuesGetPredictedResource
object
PropertyDealRevenueChildResource
object
18 properties
PropertyDealRevenueResource
object
PropertyDealRevenuesGetActualResource
object
PropertyDealRevenuesGetResource
object
PropertyDealRevenuesCollection
PublishedSeasonResource
RevenueCalculatedMidpointResource
object
3 properties
RevenueCalculatedResource
object
6 properties
RevenueDealGetDealDataBySeasonsCollection
object
1 property
RevenueDealGetDealRevenueInSeasonResource
object
RevenueDealGetPropertyDealRevenuesResource
object
SeasonsWithDealDataResource
object
7 properties
RevenueDealCollection
array
RevenueDealMultiYearResource
RevenueDealPredictedCollection
object
1 property
RevenueDealPredictedResource
object
RevenueDealResource
object
RevenueLeagueResource
RevenuePropertyResource
RevenueResource
object
RevenueSubcategoryFactorResource
object
5 properties
RevenueSubcategoryResource
object
11 properties
SubcategoryRevenueFactorsUpdateResource
object
1 property
SubcategoryRevenuesDealsBySubcategoryResource
object
SubcategoryRevenuesReportResource
object
SubcategoryRevenuesShowResource
object
UpdateSubcategoryRevenuesResource
object
SuLanguageCollection
array
SuLanguageResource
object
3 properties
SurfaceUsageRecordResource
object
2 properties
SurfaceUsageResource
object
1 property
TagIndexResource
object
2 properties
TagResource
object
2 properties
ContactTaskIndexResource
array
TaskIndexResource
array
TaskIndexMetadataResource
object
4 properties
TaskShowStoreUpdateResource
object
UserSyncStatusResource
object
3 properties
UserCustomReportCollection
array
UserCustomReportResource
object
7 properties
UserEventUploadsIndexResource
array
UserEventUploadsStoreResource
object
LoginResource
object
7 properties 2 required
NeedsConfirmationResource
object
2 properties
ProfileFieldMfaResource
object
MFA field validation response
3 properties
ProfileMfaUpdateResource
object
1 property
ProfilePhoneCheckResource
object
4 properties
UserAccessResource
object
User access permissions by entity type
3 properties
UserDownloadFileResource
object
2 properties
UserForReportSharingResource
object
28 properties
UserLightResource
object
1 property
UserMeResponse
object
Complete response for authenticated user profile with permissions, access, entities, and settings
UserOrganizationAgenciesResource
object
2 properties
UserOrganizationBrandsResource
object
2 properties
UserOrganizationPropertiesResource
object
2 properties
UserOrganizationResource
object
1 property
UserProfileResource
object
UserRepresentativeResource
object
User representative information
4 properties
UserResource
object
UserSalesforceIntegrationResource
object
User Salesforce integration status and configuration
10 properties
UserSearchResource
array
YoutubeBrandAssetCombinationResource
object
2 properties
AdministrativeLevel
object
8 properties
Agency
object
20 properties
AgencyService
object
5 properties
AgencyServicesType
object
4 properties
Audio
object
11 properties
Company
object
32 properties
CompanySlim
object
4 properties
PersonProfile
object
16 properties
PersonProfileContactDetail
object
18 properties
PersonProfileSocialDetail
object
9 properties
ContactEmailStatusFile
object
7 properties
ContactLinkedinData
object
6 properties
CuratedNews
object
12 properties
CustomReport
object
17 properties
FileUpload
object
12 properties
FollowedEntity
object
4 properties
Genre
object
8 properties
Image
object
21 properties
Infographics
object
9 properties
OrganizationSalesforceIntegration
object
7 properties
UserIntegration
object
6 properties
Item
object
25 properties
ItemAudio
object
5 properties
ItemAudioFragment
object
7 properties
ItemImage
object
6 properties
ItemValue
object
12 properties
ItemVideo
object
6 properties
Keyword
object
6 properties
Sport
object
4 properties
League
object
22 properties
LoginPin
object
4 properties
Market
object
10 properties
MarketGrouping
object
18 properties
NewsAsset
object
13 properties
NewsContact
object
26 properties
NewsQuote
object
20 properties
NewsTags
object
2 properties
Note
object
8 properties
Organization
object
25 properties
OrganizationSlim
object
4 properties
OrganizationRepresentative
object
3 properties
OrganizationType
object
5 properties
PartnershipReport
object
16 properties
Permission
object
6 properties
Product
object
6 properties
ProductType
object
2 properties
PropertyFollowersCount
object
9 properties
PropertySocialMediaDetails
object
32 properties
Role
object
6 properties
RoleOrientation
object
2 properties
SavedReport
object
10 properties
ScoutingGroup
object
5 properties
SocialScrapingSession
object
13 properties
TeamFacebookHandle
object
5 properties
TeamInstagramHandle
object
5 properties
TeamTiktokHandle
object
6 properties
TeamTwitchHandle
object
5 properties
TeamTwitterHandle
object
5 properties
TeamYoutubeHandle
object
5 properties
BucketAsset
object
4 properties
BucketLeagueAsset
object
7 properties
BucketLeagueProperty
object
8 properties
CustomDropletLeagueAsset
object
7 properties
DealLevel
object
5 properties
DealType
object
6 properties
DropletAsset
object
3 properties
DropletLeagueAsset
object
4 properties
DropletLeagueProperty
object
5 properties
ExcludedPropertySeason
object
3 properties
RevenueAssetBucket
object
7 properties
RevenueDeal
object
16 properties
RevenueDealAsset
object
9 properties
RevenueDealMultiYear
object
4 properties
RevenueDealPredicted
object
26 properties
RevenueLeague
object
7 properties
RevenueLeagueBucket
object
7 properties
PredictionTotalUnits
object
5 properties
RevenueProperty
object
8 properties
RevenueSubcategory
object
9 properties
RevenueSubcategoryFactor
object
5 properties
SpendTrackerPublishedSeason
object
6 properties
SuLanguage
object
4 properties
Subgenere
object
7 properties
Tag
object
5 properties
Task
object
11 properties
Property
object
40 properties
PropertySlim
object
4 properties
TeamHashtag
object
3 properties
User
object
14 properties
UserCustomReport
object
9 properties
UserDownloadFile
object
11 properties
UserEventUploads
object
5 properties
UserLinkedinCookie
object
10 properties
UserRepresentative
object
3 properties
UserSetting
object
3 properties
Video
object
15 properties
WeeklyReport
object
6 properties
PermissionsGroupedByLabel
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sponsorunited-api-openapi.json Raw ↑
#Sponsorship#Sports#Marketing#Data#Analytics
← Back to S APIs
API Details
ID
sponsorunited:sponsorunited-api
Base URL
https://api.sponsorunited.com
Docs
https://www.sponsorunited.com/platform
Provider
Sponsorunited
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=sponsorunited-sponsorunited-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sponsorunited-sponsorunited-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 SponsorUnited 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.