The workspace

GEThttps://api.norreach.app/v1/workspace

The workspace this key belongs to: its name, time zone, the countries it texts and calls, and whether all outreach is paused (when, and by whom).

workspace:readOperation id: get_workspace

GET/workspace

curl -X GET "https://api.norreach.app/v1/workspace" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The workspace

{
  "id": "5c3e2a10-9b8d-4f6e-a1c2-3d4e5f6a7b8c",
  "object": "workspace",
  "name": "Acme Staffing",
  "timezone": "Europe/Stockholm",
  "countries": {
    "texts": [
      "SE"
    ],
    "calls": [
      "NO",
      "SE"
    ]
  },
  "outreach": {
    "paused": false,
    "paused_at": null,
    "paused_by": null
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope workspace:read. API keys and scopes

Response

200application/json— The workspace

idstring (uuid)required

An id (UUID).

object"workspace"required

namestring | nullrequired

timezonestring | nullrequired

The booking page's time zone, when one is set up.

countriesobjectrequired

Show child attributes

countries.textsstring[]required

Countries the workspace texts (ISO 3166-1 alpha-2).

countries.callsstring[]required

Countries the workspace calls.

outreachobjectrequired

Show child attributes

outreach.pausedbooleanrequired

outreach.paused_atstring | nullrequired

outreach.paused_bystring | nullrequired

The name of who paused it.

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/workspace

curl -X GET "https://api.norreach.app/v1/workspace" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

The workspace

{
  "id": "5c3e2a10-9b8d-4f6e-a1c2-3d4e5f6a7b8c",
  "object": "workspace",
  "name": "Acme Staffing",
  "timezone": "Europe/Stockholm",
  "countries": {
    "texts": [
      "SE"
    ],
    "calls": [
      "NO",
      "SE"
    ]
  },
  "outreach": {
    "paused": false,
    "paused_at": null,
    "paused_by": null
  }
}