Quick Start

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

This guide demonstrates making your first authenticated request to the Zimark API.

Prerequisites

Before you begin, ensure you have:

• ✅ Access to a Zimark environment
• ✅ REST base URL: https://api.zimark.link/
• ✅ An API key (create one)

Make Your First Request

Test your API key by fetching the gates in your organization.

Test in Browser

Use the interactive API documentation:

1. Open Get gates

2. Click Try it

3. Select your environment

4. Add your API key to the X-AUTH-KEY header

5. Click Send

Request Examples

curl -X GET "https://api.zimark.link/integration/rest/api/v1/gate?pageSize=5" \
  -H "X-AUTH-KEY: ZIM.your-api-key-here" \
  -H "Content-Type: application/json"

Response

{
  "content": [
    {
      "name": "Dock 12A",
      "externalIdentifier": "GATE-12A",
      "status": "AVAILABLE",
      "gateType": "SINGLE_MANIFEST"
    }
  ],
  "totalElements": 1
}