> ## Documentation Index > Fetch the complete documentation index at: https://growi.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Ambassadors > Retrieves all ambassadors from ambassador program campaigns for the organization. Returns ambassador profile information including their social accounts, custom field answers from their application, and contact details. Retrieves all ambassadors from ambassador program campaigns for the organization. Returns ambassador profile information including their social accounts, custom field answers from their application, and contact details. ## Request Parameters | Parameter | Type | Description | Required | | --------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | | `require_application` | String | Filter to only ambassadors who submitted an application. Pass `false` to include all ambassadors. Default is `true`. | No | | `page` | Integer | Page number for pagination. Default is 1. | No | | `per_page` | Integer | Number of results per page. Default is 20. Maximum is 100. | No | | `email` | String | Filter by email (comma-separated for multiple) | No | | `first_name` | String | Filter by first name (partial match) | No | | `last_name` | String | Filter by last name (partial match) | No | | `search` | String | Search by email or name | No | | `approved_at_from` | String | Filter ambassadors approved on or after this date (YYYY-MM-DD format) | No | | `approved_at_to` | String | Filter ambassadors approved on or before this date (YYYY-MM-DD format) | No | | `campaign_id` | Integer or Array | Filter by campaign ID. Pass a single ID or array of IDs (e.g., `campaign_id[]=123&campaign_id[]=456`) | No | ## Request Example ```bash theme={null} curl -X GET "https://api.growi.io/api/public/v1/stats/ambassadors?page=1&per_page=20" \ -H "Authorization: Bearer YOUR_PUBLIC_API_KEY" ``` ## Response Example ```json theme={null} { "data": [ { "campaign_affiliate_id": 3490313, "user_id": 2628998, "email": "creator@example.com", "first_name": "Natalie", "last_name": "Garay", "name": "Natalie Garay", "joined_at": "2026-01-16T20:15:36Z", "social_accounts": [ { "username": "nataliemgaray", "platform": "Instagram", "profile_share_url": "https://www.instagram.com/nataliemgaray/" }, { "username": "dancingnatnat", "platform": "Tik Tok", "profile_share_url": "https://www.tiktok.com/@dancingnatnat" } ], "custom_field_answers": [ { "question": "What college do you attend?", "answer": "UCLA", "field_type": "text" }, { "question": "Upload your best photo", "answer": "https://imagedelivery.net/...", "field_type": "image" } ], "user_location": "Temecula, CA 92591, US", "user_phone_number": "+15551234567", "approved_at": "2026-01-16T20:15:36Z", "campaign_id": 123, "campaign_name": "Ambassador Program" } ], "meta": { "total_ambassadors": 150, "current_page": 1, "per_page": 20, "total_pages": 8 } } ``` ## Response Fields | Field | Type | Description | | -------------------------------------------- | ------- | --------------------------------------------------------------- | | `data` | Array | Array of ambassador objects | | `data[].campaign_affiliate_id` | Integer | Unique identifier for the campaign affiliate | | `data[].user_id` | Integer | Unique identifier for the user | | `data[].email` | String | Ambassador's email address | | `data[].first_name` | String | Ambassador's first name | | `data[].last_name` | String | Ambassador's last name | | `data[].name` | String | Ambassador's full name | | `data[].joined_at` | String | ISO 8601 timestamp when the ambassador joined | | `data[].social_accounts` | Array | Array of connected social media accounts | | `data[].social_accounts[].username` | String | Username on the platform | | `data[].social_accounts[].platform` | String | Platform name (e.g., "Instagram", "Tik Tok", "Youtube") | | `data[].social_accounts[].profile_share_url` | String | Direct URL to the profile | | `data[].custom_field_answers` | Array | Array of application custom field responses | | `data[].custom_field_answers[].question` | String | The custom field question | | `data[].custom_field_answers[].answer` | String | The ambassador's answer (can be text or image URL) | | `data[].custom_field_answers[].field_type` | String | Type of field: "text", "image", "number", etc. | | `data[].user_location` | String | Ambassador's location | | `data[].user_phone_number` | String | Ambassador's phone number (may be null) | | `data[].approved_at` | String | ISO 8601 timestamp when the ambassador application was approved | | `data[].campaign_id` | Integer | ID of the ambassador program campaign | | `data[].campaign_name` | String | Name of the ambassador program campaign | | `meta` | Object | Pagination metadata | | `meta.total_ambassadors` | Integer | Total number of ambassadors matching the query | | `meta.current_page` | Integer | Current page number | | `meta.per_page` | Integer | Number of results per page | | `meta.total_pages` | Integer | Total number of pages available | ## Use Cases This endpoint is useful for: * **Ambassador Directory**: Build a roster/directory page of all your ambassadors * **CRM Integration**: Sync ambassador data to external CRM systems * **Profile Pages**: Populate individual ambassador profile pages with their info and social links * **Application Data**: Access custom field answers from applications (including uploaded images) * **Contact Management**: Retrieve ambassador contact details including phone numbers and locations ## OpenAPI ````yaml GET /stats/ambassadors openapi: 3.0.1 info: title: Growi API description: >- API documentation for Growi platform, showcasing the public tracking event endpoint license: name: MIT version: 1.0.0 servers: - url: https://api.growi.io/api/public/v1 security: - bearerAuth: [] paths: /stats/ambassadors: get: description: >- Retrieves all ambassadors from ambassador program campaigns for the organization. Returns ambassador profile information including their social accounts, custom field answers from their application, and contact details. parameters: - name: require_application in: query required: false example: 'true' schema: type: string default: 'true' description: >- Filter to only ambassadors who submitted an application. Pass false to include all ambassadors. - name: page in: query required: false example: 1 schema: type: integer default: 1 description: Page number for pagination. Default is 1. - name: per_page in: query required: false example: 20 schema: type: integer default: 20 maximum: 100 description: Number of results per page. Default is 20. Maximum is 100. - name: email in: query required: false example: creator@example.com schema: type: string description: Filter by email (comma-separated for multiple) - name: first_name in: query required: false example: Natalie schema: type: string description: Filter by first name (partial match) - name: last_name in: query required: false example: Garay schema: type: string description: Filter by last name (partial match) - name: search in: query required: false example: natalie schema: type: string description: Search by email or name - name: approved_at_from in: query required: false example: '2024-01-01' schema: type: string format: date description: >- Filter ambassadors approved on or after this date (YYYY-MM-DD format) - name: approved_at_to in: query required: false example: '2024-12-31' schema: type: string format: date description: >- Filter ambassadors approved on or before this date (YYYY-MM-DD format) - name: campaign_id in: query required: false example: 123 schema: type: integer description: >- Filter by campaign ID. Pass a single ID or array of IDs (e.g., campaign_id[]=123&campaign_id[]=456) responses: '200': description: Ambassadors retrieved successfully content: application/json: schema: type: object properties: data: type: array items: type: object properties: campaign_affiliate_id: type: integer example: 3490313 description: Unique identifier for the campaign affiliate user_id: type: integer example: 2628998 description: Unique identifier for the user email: type: string example: creator@example.com description: Ambassador's email address first_name: type: string example: Natalie description: Ambassador's first name last_name: type: string example: Garay description: Ambassador's last name name: type: string example: Natalie Garay description: Ambassador's full name joined_at: type: string example: '2026-01-16T20:15:36Z' description: ISO 8601 timestamp when the ambassador joined social_accounts: type: array items: type: object properties: username: type: string example: nataliemgaray description: Username on the platform platform: type: string example: Instagram description: >- Platform name (e.g., Instagram, Tik Tok, Youtube) profile_share_url: type: string example: https://www.instagram.com/nataliemgaray/ description: Direct URL to the profile description: Array of connected social media accounts custom_field_answers: type: array items: type: object properties: question: type: string example: What college do you attend? description: The custom field question answer: type: string example: UCLA description: >- The ambassador's answer (can be text or image URL) field_type: type: string example: text description: 'Type of field: text, image, number, etc.' description: Array of application custom field responses user_location: type: string example: Temecula, CA 92591, US description: Ambassador's location user_phone_number: type: string nullable: true example: '+15551234567' description: Ambassador's phone number (may be null) approved_at: type: string format: date-time example: '2026-01-16T20:15:36Z' description: >- ISO 8601 timestamp when the ambassador application was approved campaign_id: type: integer example: 123 description: ID of the ambassador program campaign campaign_name: type: string example: Ambassador Program description: Name of the ambassador program campaign meta: type: object properties: total_ambassadors: type: integer example: 150 description: Total number of ambassadors matching the query current_page: type: integer example: 1 description: Current page number per_page: type: integer example: 20 description: Number of results per page total_pages: type: integer example: 8 description: Total number of pages available '400': description: Bad Request - Invalid parameters content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: Error: required: - error - message type: object properties: error: type: string message: type: string securitySchemes: bearerAuth: type: http scheme: bearer ````