--- title: "List all users" method: POST path: "/api/users" tags: ["User Management"] --- # List all users `POST /api/users` ## Request - Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from) - URL: `https://api.sponsorunited.com/api/users` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves a paginated list of users with optional filtering. ## Request body - UserAllRequest - `name` string: Filter by user name - `role` integer[]: Filter by role IDs - `organization` integer[]: Filter by organization IDs - `contract_status` string[]: Filter by contract status - `external` 0 | 1: Filter by external status (0 or 1) - `active` 0 | 1: Filter by active status (0 or 1) - `order_by` string: Field to order results by - `order` 'asc' | 'desc': Sort order direction - `page` integer: Page number for pagination ## Response `200` Paginated list of users - object - `data` UserResource[] - `id` integer - `email` string - `currency` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `last_active_at` string, date-time - `is_external` boolean - `verified` integer - `genuine` integer - `hubspot_id` integer - `hubspot_synced_on` string, date-time - `force_new_password` integer - `credentials_sent_at` string, date-time - `roles` Role[] - `id` integer - `name` string - `display_name` string - `description` string - `created_at` string, date-time - `updated_at` string, date-time - `teams` Property[] - `id` integer - `parent_id` integer - `type_id` integer - `uuid` integer - `division_id` integer - `sport_id` integer - `name` string - `synopsis` string - `alias` string - `logo` string - `cover` string - `is_continuous` integer - `league_level_property` integer - `no_of_employees` integer - `email` string - `website_url` string - `linkedin_url` string - `linkedin_id_url` string - `facebook_url` string - `twitter_url` string - `instagram_url` string - `twitch_url` string - `tiktok_url` string - `youtube_url` string - `exclude_from_social_scan` integer - `inactive` integer - `market` string - `state` string - `city` string - `geolocation` string - `corporate_phone` string - `linkedin_employees` string - `targeted_prospects_feed_url` string - `top_sponsorship_headlines_feed_url` string - `headlines_feed_url` string - `capacity` string - `venue_uuid` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `agencies` Agency[] - `id` integer - `name` string - `synopsis` string - `logo` string - `no_of_employees` integer - `corporate_phone` string - `website` string - `linkedin` string - `linkedin_id_url` string - `linkedin_employees` string - `facebook` string - `twitter` string - `instagram` string - `twitch` string - `tiktok` string - `youtube` string - `feed_url` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `brands` Company[] - `id` integer - `parent_company_id` integer - `subcategory_id` integer - `categories_id` integer - `name` string - `synopsis` string - `corporate_phone` string - `website` string - `linkedin` string - `linkedin_id_url` string - `linkedin_employees` string - `facebook` string - `twitter` string - `instagram` string - `twitch` string - `tiktok` string - `youtube` string - `exclude_from_social_scan` boolean - `exclude_from_transcribe` boolean - `feed_url` string - `statistics` string - `no_of_employees` string - `priority_markets` string - `parent_company` string - `ad_agency` string - `existing` string - `owned_by` string - `approved` boolean - `approved_by` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `organization` Organization[] - `id` integer - `name` string - `logo` string - `mfa_enabled` integer - `intercom_company_id` string - `intercom_company_company_id` string - `contract_status_id` integer - `contract_payment_type_id` integer - `contract_monthly_spend` integer - `contract_file_url` string - `contract_onboarding_date` string, date-time - `contract_start_date` string, date-time - `contract_end_date` string, date-time - `contract_auto_renew` integer - `product_id` integer - `sales_user_id` integer - `salesforce_id` string - `account_manager_id` integer - `default_user_subscription_plan_id` string - `default_user_subscription_product_name` string - `default_user_subscription_cancel_date` string, date-time - `user_email_domain` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `person_profile` object - `id` integer - `user_id` integer - `avatar_id` integer, nullable - `person_profile_job_role_id` integer, nullable - `market_id` integer, nullable - `name` string - `job_title` string, nullable - `location` string, nullable - `school` string, nullable - `info` string, nullable - `suggested` integer, nullable - `previous_suggested` integer, nullable - `approved` boolean - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `contact_details` PersonProfileContactDetail - `id` integer - `person_profile_id` integer - `primary_email` string - `secondary_email` string - `previous_primary_email_status` string - `previous_primary_email_status_updated_at` string, date-time - `primary_email_status` string - `primary_email_status_updated_at` string, date-time - `manual_primary_email_status` string - `manual_primary_email_status_updated_at` string, date-time - `mail_code` string - `phone` string - `phone_country` string - `phone_number` string - `phone_extension` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `social_details` PersonProfileSocialDetail - `id` integer - `person_profile_id` integer - `linkedin_profile_url` string - `facebook_profile_url` string - `twitter_profile_url` string - `instagram_profile_url` string - `created_at` string, date-time - `updated_at` string, date-time - `deleted_at` string, date-time - `user_permissions` unknown[] - unknown - `role_orientation` RoleOrientationResource - `id` integer - `name` string: Stable machine key - `label` string, nullable: Display text shown in the UI - `current_page` integer - `last_page` integer - `per_page` integer - `total` integer ## Other responses - `401`: Unauthenticated - `403`: Forbidden - Not authorized to view users --- [API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)