Get Authenticated Outlet Information

By using this method, you can view the basic information about an outlet based on the token.

GET /integrations/partner/v1/token-info

Sample Request

Sample Request

curl -X GET https://api.partner-sandbox.gobiz.co.id/integrations/partner/v1/token-info \
  -H 'Authorization: Bearer {access-token}'

Sample Response - 200 Success

Sample Response

{
  "success": true,
  "data": {
    "user": {
      "roles": [
        "manager"
      ]
    },
    "outlets": [
      {
        "id": "string",
        "name": "string",
        "address": "string",
        "email": "",
        "phone": ""
      }
    ]
  }
}

note

• The first item in the list is the user's primary outlet.
• Email and Phone number fields are deprecated. It returns empty string to maintain backward compatibility.

Response Parameter - 200 Success

JSON Attribute	Description	Type
success	Status of the request. Value true indicates successful submission of the request.	Boolean
data	Details of the authenticated outlets.	Object
» outlets	Array of outlets object.	Array(Object)

Sample Response - 404 Outlet Not Found

Sample Response

{
  "success": false,
  "errors": [
    {
      "message_title": "Not found",
      "message": "Outlet with id: de829e5b-72a5-49bc-a5f3-f0d83edb9daf is not found"
    }
  ]
}

Response Parameter - 404 Outlet Not Found

JSON Attribute	Description	Type
success	Status of the request. Value false indicates an error.	Boolean
errors	Details of the error.	Array(Object)

note

• To perform this operation, you must be authenticated using go_auth_authorization_code(partner:outlet:read).
• Possible error responses are 401, 404, 406, and 415. Please refer Error Glossary.