Getting started

1. Make your first call

Open a terminal and paste this. It uses the public sandbox key, so it works straight away.

curl https://api-demo.scoutworks.app/api/v1/me \
  -H "Authorization: Bearer sw_live_473adcc6c7236916021f0f24559db36576a53bab071d0f0c08a025adb510b6ab"

You get back the group, the key and where to go next:

{
  "data": {
    "group": { "id": "…", "name": "1st Demo Group" },
    "key": {
      "id": "30d82fa2-7e41-4d52-97ff-5be1a0b909a3",
      "name": "Public docs sandbox (read-only)",
      "last4": "b6ab",
      "scopes": ["members:read", "members.contacts:read", "events:read", "badges:read", "waiting-list:read", "waiting-list.contacts:read"],
      "expiresAt": null
    },
    "environment": "demo",
    "links": {
      "docs": "https://developers.scoutworks.app",
      "try": "/api/v1/members?limit=5"
    }
  }
}

expiresAt: null means the key never expires.
environment says which Scoutworks answered. demo holds only made-up people. Your own key says production.
links.try is a good second call. It is always a list that your key may read.

The answer arrives on one line. Add | jq to the end of the command to make it readable, if you have jq. No terminal? Open GET /me in the API reference, paste the sandbox key into the Authorization box, choose the Demo server and press Send.

2. Read a list

curl "https://api-demo.scoutworks.app/api/v1/members?limit=5" \
  -H "Authorization: Bearer sw_live_473adcc6c7236916021f0f24559db36576a53bab071d0f0c08a025adb510b6ab"

Every list comes back as { "data": [...], "nextCursor": "..." }. To get the next page, see Pagination.

3. Create your own key

Join the beta

The API is in beta. A group admin turns it on in Settings → Beta programme, or asks us to join.

Open the API keys page

In Scoutworks, go to Settings → Integrations → API keys. Only a group admin can see this page.

Create a key

Give the key a name that says what it is for, for example “Membership spreadsheet”. Choose only the scopes it needs. You can set an expiry date.

Copy the key

Scoutworks shows the key once. Copy it into your tool straight away. If you lose it, revoke it and create a new one.

Swap it in

In any recipe, replace the sandbox key with your key, and api-demo.scoutworks.app with api.scoutworks.app. The Test connection button on the key page checks that the key works.

Recipes

Google Sheets, Excel, n8n, Zapier, Python and curl.

Keys and scopes

What each scope unlocks, and when a key stops working.

Start here

Recipes

How the API works

Tools

1. Make your first call

2. Read a list

3. Create your own key

Next

Recipes

Keys and scopes

​1. Make your first call

​2. Read a list

​3. Create your own key

​Next

Recipes

Keys and scopes

1. Make your first call

2. Read a list

3. Create your own key

Next