# Getting started guide

Use the **SureCloud External API** to retrieve metadata and record data from your tenant.

This API is designed for bulk access. It supports integrations, synchronisation, and external reporting.

With this API, you can:

* Retrieve the entities available in your tenant.
* Retrieve records in bulk, including attribute values, workflow state, stage, linked records, and question answers.
* Build integrations and reporting pipelines without querying each record individually.

***

{% stepper %}
{% step %}

### Request access credentials

Ask SureCloud to issue a JWT for your tenant and user.

Contact `success@surecloud.com` to request access.
{% endstep %}

{% step %}

### Import the Postman collection

Import the following collection into your Postman workspace.

{% file src="/files/vyKViWkEFgAXdUa1Xo4t" %}
{% endstep %}

{% step %}

### Set your collection variables

Set these variables before sending requests:

* `tenant` — your SureCloud tenant name from the URL.
* `apiKey` — the JWT provided by SureCloud.

{% hint style="info" %}
If you need more detail on tokens, see [Authentication](/surecloud-docs/integrations/surecloud-external-api/getting-started-guide/authentication.md).
{% endhint %}
{% endstep %}

{% step %}

### Send a request

Send `GET /workflows` to verify your setup.
{% endstep %}

{% step %}

### Retrieve records for a workflow

Use `GET /workflows/{workflowId}/records` to retrieve record data for a specific workflow.

Use the `workflowId` returned by `GET /workflows`.
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://surecloud.gitbook.io/surecloud-docs/integrations/surecloud-external-api/getting-started-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.