Dark
Get help in the API Community

Overview

Wrike API v4

This document covers the methods and techniques required to access and modify user content in Wrike through the API.

Authorization

Wrike’s API uses the OAuth 2.0 protocol for authorization. Every API request must contain the Authorization header (preferred option) or the access_token parameter with the OAuth 2.0 access token. Access scopes may be requested during the authorization process. See the OAuth 2.0 authorization description for details.

Overview

The API methods are organized in the RESTful way and support GET, POST, PUT and DELETE requests. If a client is not able to execute all kinds of requests, then only GET requests can be used with an additional method parameter, which is set to the required request type (e.g., ...&method=POST).

To access a specific API method, the request token should have at least one of the scopes required by this method. Supported scopes: Default, wsReadOnly, wsReadWrite, amReadOnlyWorkflow, amReadWriteWorkflow, amReadOnlyInvitation, amReadWriteInvitation, amReadOnlyGroup, amReadWriteGroup, amReadOnlyUser, amReadWriteUser.

Each API method operates on a certain type of resource with a defined model (for details, see the Methods section below) and produces a JSON response that contains the entity type in the kind field and an array of entities in the data field. Client can pass an additional state parameter in the request, which also will be included in the response.

Response example:

{
    "kind": "accounts",
    "state": "client_defined_state",
    "data": [...]
}

Postman Collection

To make it easier for developers to test and use our API, we have created a Postman collection of API requests. This collection includes most of the API endpoints and sample requests. To access the Postman collection and setup guide, please follow the links provided below:

  • Wrike API collection: this is a collection of examples for most of the Wrike API calls.

  • Wrike environment: this is a definition file you load into Postman containing your authentication token and API URL.

  • A guide on how to set up Postman for use with the Wrike API.


    By using the Postman collection, you can quickly and easily test our API, and ensure that your integration is working correctly. We hope this makes the process of integrating with our API more seamless and efficient for you.