Get an ambassador (platform)

GET /platform/ambassadors/{id}
Bearer token

Path parameters

  • id integer Required

    The ambassador id

Responses

  • 200 application/json

    Returns the ambassador

    Hide response attributes Show response attributes object
    • id_ambassador integer(int32)
    • id_brand integer(int32)
    • date_insert string
    • customer_id string
    • image string
    • gender string
    • firstname string
    • lastname string
    • username string
    • full_name string
    • gamification_score integer(int32)
    • active integer(int32)
    • status integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

  • 404

    Not found - The ambassador does not exist

GET /platform/ambassadors/{id} 
curl \
 --request GET 'https://domain.tld/api/v2/platform/ambassadors/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "id_ambassador": 42,
  "id_brand": 42,
  "date_insert": "string",
  "customer_id": "string",
  "image": "string",
  "gender": "string",
  "firstname": "string",
  "lastname": "string",
  "username": "string",
  "full_name": "string",
  "gamification_score": 42,
  "active": 42,
  "status": 42,
  "online": true
}
Response examples (401) 
{
  "message": "Unauthorized."
}