Making your first request

This guide walks you through making your first API request to retrieve data from a linked account.

Prerequisites

API Key created in StackOne Dashboard and copied to a secure location
Basic Authentication Setup - Learn how to properly authenticate with StackOne API using your API key
Required provider integration enabled
Account linked successfully
(Optional) Use an SDK

Getting Account ID

Authentication: When using curl -u "$API_KEY:", encoding is handled automatically. When setting the Authorization header manually, base64 encode {api_key}:, your key followed by a colon. See Authentication for details.

List your linked accounts to find the account ID:

curl --request GET \
     --url https://api.stackone.com/accounts \
     --header 'accept: application/json' \
     --header 'authorization: Basic {base64_encoded_api_key}'

From the response, copy the id value for your desired provider account.

Filter by provider using the providers query parameter:

curl --request GET \
     --url 'https://api.stackone.com/accounts?providers={provider_name}' \
     --header 'accept: application/json' \
     --header 'authorization: Basic {base64_encoded_api_key}'

Now you’re ready to make your first CRM API call. Let’s list contacts from the connected CRM system:

cURL
TypeScript
Python

curl --request GET \
  --url 'https://api.stackone.com/unified/crm/contacts' \
  --header 'accept: application/json' \
  --header 'authorization: Basic {base64_encoded_api_key}' \
  --header 'x-account-id: {account_id}'

import { StackOne } from "@stackone/stackone-client-ts";

const client = new StackOne({ apiKey: "YOUR_API_KEY" });

const response = await client.crm.listContacts({
  xAccountId: "your-account-id"
});

console.log(response.contacts);

from stackone_client import StackOne

client = StackOne(api_key="YOUR_API_KEY")

response = client.crm.list_contacts(
    x_account_id="your-account-id"
)

print(response.contacts)

Example Response

{
  "data": [
    {
      "id": "contact_123",
      "remote_id": "abc123",
      "first_name": "Sarah",
      "last_name": "Mitchell",
      "emails": [
        {
          "type": "work",
          "value": "sarah.mitchell@company.com"
        }
      ],
      "phone_numbers": [
        {
          "type": "work",
          "value": "+1-555-0456"
        }
      ],
      "company_name": "Acme Corp",
      "created_at": "2024-01-10T08:00:00Z"
    }
  ]
}

API Reference

Making your first request

Prerequisites

Getting Account ID

Making Your First Request

Example Response

Next Steps

Get Contact

List Accounts

Pagination

Get All Lists

References

​Prerequisites

​Getting Account ID

​Making Your First Request

​Example Response

​Next Steps

Get Contact

List Accounts

Pagination

Get All Lists

​References

Prerequisites

Getting Account ID

Making Your First Request

Example Response

Next Steps

References