Sketch

undefined

Detail	Value
Category	Design
Base URL	https://api.sketch.cloud/v1
Authentication	OAuth2
Endpoints	6
Connector key	sketch

Using Sketch in a workflow

1. Go to Connections and click New Connection.
2. Pick Sketch from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET	List Projects
GET	List Documents
GET	List Artboards
GET	List Versions
GET	List Libraries
GET	Get Workspace

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

List Projects

Detail	Value
Operation ID	list_projects_0
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select list_projects_0.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.

GET

List Documents

Detail	Value
Operation ID	list_documents_1
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select list_documents_1.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.

GET

List Artboards

Detail	Value
Operation ID	list_artboards_2
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select list_artboards_2.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.

GET

List Versions

Detail	Value
Operation ID	list_versions_3
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select list_versions_3.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.

GET

List Libraries

Detail	Value
Operation ID	list_libraries_4
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select list_libraries_4.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.

GET

Get Workspace

Detail	Value
Operation ID	get_workspace_5
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Sketch connection from the Connection dropdown.
3. In the Operation dropdown, select get_workspace_5.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Sketch API reference.