API quickstart

This quickstart queries up to ten contacts without changing workspace data.

1. Create an API key

Open Micro Settings → Developers. Under API Keys, choose New API Key. Copy the key when it is shown and store it as a secret.

The same Developers page shows Workspace ID. It is the teamId in API paths and is not secret.

export MICRO_API_KEY="replace-with-your-api-key"
export MICRO_TEAM_ID="replace-with-your-workspace-id"

2. Query contacts

curl --request POST \
  "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/contact/query" \
  --header "content-type: application/json" \
  --header "x-api-key: ${MICRO_API_KEY}" \
  --data '{"query":{"select":["full_name","email"],"limit":10}}'

{
  "data": [{
    "id": "11111111-1111-4111-8111-111111111111",
    "properties": {"full_name": "Sarah Chen", "email": "sarah@example.com"},
    "is_user_object": false
  }],
  "has_more": false,
  "next_cursor": null
}

The sample above is illustrative. Expect HTTP 200; a new or empty workspace can validly return "data": []. For returned records, id is at the top level and selected workspace fields are under properties.

3. Choose an integration path

• Continue with HTTP in Query records.
• Get typed methods with an official SDK.
• Use structured terminal output with the CLI.
• Set up a safe agent workflow.

If the request fails, see Errors and retries.