List establishments

Lists the establishments of the Workspace the token acts on. Use their identifiers as establishmentId when you publish, list media or read insights.

GEThttps://api.sofia-post.com/api/v1/establishments

GET/v1/establishments

API key or access tokenKept in this tab only, and sent only to api.sofia-post.com.

curl -X GET 'https://api.sofia-post.com/api/v1/establishments' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

Authorizationstringrequired
Your personal key or OAuth access token, sent as Bearer <token>.

Response

200application/json

The establishments of the Workspace.

dataobject[]required
The establishments
Show child attributes
- idstringrequired
  Identifier of the establishment
- namestringrequired
  Name of the establishment

401

The token is missing, unknown, expired or revoked.

403

The token does not have the establishments:read scope.

4XXapplication/json

Any other error, in the error envelope.

List establishments

curl --request GET \
  --url 'https://api.sofia-post.com/api/v1/establishments' \
  --header "Authorization: Bearer $SOFIA_API_KEY"

{
  "data": [
    {
      "id": "string",
      "name": "Bistrot Lumière Lyon 2e"
    }
  ]
}