WorkspaceGet the workspace

Get the workspace

Returns the workspace the key belongs to, its brand profile and the account's plan.

Required scope: v2:org. Takes no query parameters.

  • brand is null when the workspace has no brand profile. brand.site can be null.
  • plan is null when the account has no subscription.
curl -X GET "https://api.opttab.com/v1/external/workspace" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "11111111-1111-4111-8111-111111111111",
  "name": "North brand",
  "brand": {
    "site": "https://north.example",
    "description": "Running shoes",
    "industry": "Retail"
  },
  "plan": {
    "slug": "growth",
    "status": "active"
  }
}
GET
/v1/external/workspace
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

Responses

idstring
Required

The workspace id.

namestring
Required

The workspace name.

brandobject
Required

The brand profile. null when the workspace has none.

planobject
Required

The account's plan. null when there is no subscription.