Get the current workspace

GEThttps://api.paygoro.com/v1/workspace

Returns the workspace your API key belongs to and the scopes it carries. Useful as a connectivity check — it needs no scope.

Authorization

Requires a bearer API key; no scope needed. See Authentication.

Response

200 · application/json

Field	Type	Description
`id`	string	Opaque resource id.
`name`	string
`apiKey`	object	The key that authenticated this request.
`id`	string	Opaque resource id.
`name`	string	The label given to the key when created.
`scopes`	array of string	Scopes granted to this key.

Errors

400	`BAD_REQUEST`	The request was malformed or failed validation.
401	`UNAUTHORIZED`	Missing, malformed, expired or revoked API key.
403	`FORBIDDEN`	The API key does not have the scope this operation requires.
404	`NOT_FOUND`	No resource with this id exists in your workspace, or a `companyId` filter does not match one of your companies.
429	`TOO_MANY_REQUESTS`	Rate limit exceeded. Retry after the `Retry-After` header.

All errors share one envelope — see Errors.

Request · curl

curl "https://api.paygoro.com/v1/workspace" \
  -H "Authorization: Bearer $PAYGORO_API_KEY"

Response · 200

{
  "id": "acc_3f9c2a7e",
  "name": "Main account",
  "apiKey": {
    "id": "acc_3f9c2a7e",
    "name": "Main account",
    "scopes": [
      "transactions:read",
      "accounts:read"
    ]
  }
}