Skip to content

Quickstart

This page takes you from zero to your first API response in a few minutes.

  1. Make an API key.

    In Shypr, open Settings → API keys and click Create API Key. Give it a name, a scope and an expiry date. Copy the key: Shypr shows it only once. A key starts with sh_.

    You need the manager or admin role in the workspace to make a key.

  2. Read your customers with GraphQL.

    Terminal window
    curl https://api.shypr.app/graphql \
    -H "X-API-KEY: $SHYPR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"query":"{ customers(itemsPerPage: 5) { collection { uid name reference } paginationInfo { totalCount } } }"}'
  3. Read the answer.

    {
    "data": {
    "customers": {
    "collection": [
    { "uid": "01936f6e-2b1c-7a4e-9c1d-3f5e8a2b7c90", "name": "Acme B.V.", "reference": "C-0001" }
    ],
    "paginationInfo": { "totalCount": 1 }
    }
    }
    }