SynqDocs
Management APIProvider scopes

List the extra scopes a brand may ask the providers for

Every scope beyond Synq’s own minimum that a brand may ask an upstream sign-in provider for, provider by provider in Synq’s order, from each provider’s reviewed list: what it shares in plain words, whether it needs your own app there, how what it grants reaches you, and whether it can be asked for today. Anything not listed is refused (`scope_not_allowed`). Public: it needs no credential.

GET/v1/provider-scopes

Every scope beyond Synq’s own minimum that a brand may ask an upstream sign-in provider for, provider by provider in Synq’s order, from each provider’s reviewed list: what it shares in plain words, whether it needs your own app there, how what it grants reaches you, and whether it can be asked for today. Anything not listed is refused (scope_not_allowed). Public: it needs no credential.

Query Parameters

limit?integer

At most this many items, 200 at the most.

Range1 <= value <= 200
Default50
cursor?string

The previous page's next_cursor, for the page after it.

provider?string

Only this provider’s scopes

Value in

  • "google"
  • "github"
  • "microsoft"
  • "apple"
  • "facebook"
  • "x"
  • "discord"
  • "telegram"
  • "matrica"

Response Body

application/json

application/problem+json

application/problem+json

curl -X GET "https://api.synq.build/v1/provider-scopes" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "data": [    {      "provider": "telegram",      "scope": "telegram:bot_access",      "description": "Let {brand}’s Telegram bot send you messages",      "needs_own_app": true,      "delivery": "grant",      "status": "available",      "account_types": null,      "source_url": "https://core.telegram.org/bots/telegram-login"    }  ],  "next_cursor": "string"}