List workspace

Retrieve a list of workspaces. The collection contains exactly one workspace resource, which is the one associated with the API key used for the request.

HTTP request

GET https://api.wordfields.com/v1.0/workspace

Request headers

Response

If successful, this method returns a 200 OK response code and the collection of the workspace resources in the response body. Only one workspace resource is returned in the collection.

Example

The following example shows a request.

Request

GET https://api.wordfields.com/v1.0/workspace

Response

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

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

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

Note: An API key currently permits operations exclusively within the specific workspace where it was generated, ensuring that this method consistently returns only one workspace resource.

Error responses

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