Get All Outlets

By using this method, you can view the information about your linked outlets. It returns the basic information about an outlet such as name, email ID, contact details, and so on.

GET /integrations/partner/v1/linked-outlets

Sample Request

Sample Request

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

Query Parameters

Name	Description	Type	Required
per	Number of outlets to be displayed per page.	Integer	Optional
page	The page number that displays the outlets.	Integer	Optional

Sample Response - 200 Success

Sample Response

{
  "success": true,
  "data": {
    "outlets": [
      {
        "id": "G000012345",
        "external_outlet_id": "sample-abc-12345",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

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 outlets.	Object
» outlets	Array of outlets object.	Array(Object)

note

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