---
title: "List social accounts"
method: GET
path: "/v1/social-accounts"
tags: ["social-accounts"]
---

# List social accounts

`GET /v1/social-accounts`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/social-accounts`
- Auth: HTTP bearer

List the social accounts connected to your workspace. Use the provider query parameter, for example provider=youtube, to filter by provider. Each result includes the display name and connection status for the account, but never the stored credentials.

**Notes.**
- Only accounts at locations the caller can see. Credentials are never returned.

## Query parameters

- `provider` string

## Response `200`

Success.

- object
  - `data` object[], required
    - `id` string, required
    - `provider` string, required: `instagram`, `facebook`, `youtube`, `google-calendar`, `google-sheets`, …
    - `externalId` string, required: The account's id at the provider.
    - `displayName` string, required
    - `nodeId` string, nullable, required
    - `expiresAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `needsReconnectAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)
