Get workspace

Get the metadata of the currently authenticated workspace to which the provided API key has access.

HTTP request

GET https://api.wordfields.com/v1.0/workspace/{id}

Request headers

Response

If successful, this method returns a 200 OK response code and the workspace resource in the response body.

Example

The following example shows a request to retrieve a workspace.

Request

GET https://api.wordfields.com/v1.0/workspace/1a404b56-9b5c-4cdf-9c5b-9c9eb324d548

Response

Here is what the response to retrieve the workspace metadata will look like:

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8

{
  "id": "1a404b56-9b5c-4cdf-9c5b-9c9eb324d548",
  "displayName": "My Organization"
}

Error responses

For more information on error handling, refer to the Error Responses article.