List contacts

GET/v1/organization/{orgId}/crm/contacts

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Search, filter, sort and page the organization's contacts. facets counts each type, tag and source for the current search. Reads only. Requires read:crm. Refused for a key restricted to particular events. Also at GET /v1/org/{orgId}/crm/contacts, and at GET /v1/crm/contacts with the organization taken from the token.

Request example

cURL

curl --request GET \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts' \
  --header 'x-access-token: <api-token>'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts', {
  method: 'GET',
  headers: {
    "x-access-token": "<api-token>"
  },
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts", nil)
  req.Header.Add("x-access-token", "<api-token>")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/crm/contacts"))
    .header("x-access-token", "<api-token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

Query parameters

q

type

tag

source

stage_id

event_id

active—truefalse

sort—name-namecompany-companylast_activity-last_activityevents-eventscreated-created

page

per_page

GET

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

Query parameters

• qstringquery

  Search name, email and company.

  Max length

  200

• typestringquery

  Only contacts of this type.

  Allowed values

  "speaker", "sme", "influencer", "exhibitor", "sponsor"

• tagstringquery

  Only contacts with this tag id.

• sourcestringquery

  Only contacts from this source (a key from facets.sources).

• stage_idstringquery

  Only contacts in this pipeline stage (an id from GET …/crm/pipeline/stages).

• event_idstringquery

  Only contacts on this event.

  Pattern

  ^[0-9]+$

• activestringquery

  true: active contacts only; false: stored only.

  Allowed values

  "true", "false"

• sortstringquery

  A leading - sorts descending. Default name.

  Allowed values

  "name", "-name", "company", "-company", "last_activity", "-last_activity", "events", "-events", "created", "-created"

• pagestringquery

  Page, from 1.

  Default

  "1"

  Pattern

  ^[0-9]+$

• per_pagestringquery

  Contacts per page, up to 100.

  Default

  "50"

  Pattern

  ^[0-9]+$

Responses

200application/json

OK

• successboolean
• payloadCrmContactList
  Show child attributes

  • contactsCrmContact[]
    Show child attributes

    • idstring
    • first_namestring
    • last_namestring | null
    • namestring
    • emailstring<email>
    • companystring | null
    • titlestring | null

      Job title.

    • avatar_urlstring | null
    • typesstring[]

      Allowed values

      "speaker", "sme", "influencer", "exhibitor", "sponsor"

    • tagsCrmTag[]
      Show child attributes

      • idstring
      • namestring
    • events_countinteger
    • sessions_countinteger
    • last_activity_atstring<date-time> | null
    • activeboolean

      An active contact in the last 365 days.

    • sourcestring | null

      Where the contact came from.

    • created_atstring<date-time>
    • hrefstring

      The contact in Sessionboard CRM.

    • stageobject | null

      The contact's pipeline stage; null when not in the pipeline.

      Show child attributes

      • idstring
      • labelstring
  • totalinteger
  • pageinteger
  • per_pageinteger
  • facetsobject
    Show child attributes

    • typesobject
    • tagsCrmTagWithCount[]
      Show child attributes

      • idstring
      • namestring
      • countinteger
    • sourcesobject[]
      Show child attributes

      • keystring
      • labelstring
      • countinteger

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED: the token lacks read:crm.
• ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events; use a key without an event restriction.
• FORBIDDEN: the token's user cannot read the organization's contacts.

• successboolean
• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• codestring

  A more specific reason: exists, read_only, platform_customer.

• messagestringrequired
• contactCrmContact

  With code: exists: the contact that has the email.

  Show child attributes

  • idstring
  • first_namestring
  • last_namestring | null
  • namestring
  • emailstring<email>
  • companystring | null
  • titlestring | null

    Job title.

  • avatar_urlstring | null
  • typesstring[]

    Allowed values

    "speaker", "sme", "influencer", "exhibitor", "sponsor"

  • tagsCrmTag[]
    Show child attributes

    • idstring
    • namestring
  • events_countinteger
  • sessions_countinteger
  • last_activity_atstring<date-time> | null
  • activeboolean

    An active contact in the last 365 days.

  • sourcestring | null

    Where the contact came from.

  • created_atstring<date-time>
  • hrefstring

    The contact in Sessionboard CRM.

  • stageobject | null

    The contact's pipeline stage; null when not in the pipeline.

    Show child attributes

    • idstring
    • labelstring

404application/json

NOT_FOUND: orgId is not the token's organization, or the contact, tag or app is not in it.

• successboolean
• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• codestring

  A more specific reason: exists, read_only, platform_customer.

• messagestringrequired
• contactCrmContact

  With code: exists: the contact that has the email.

  Show child attributes

  • idstring
  • first_namestring
  • last_namestring | null
  • namestring
  • emailstring<email>
  • companystring | null
  • titlestring | null

    Job title.

  • avatar_urlstring | null
  • typesstring[]

    Allowed values

    "speaker", "sme", "influencer", "exhibitor", "sponsor"

  • tagsCrmTag[]
    Show child attributes

    • idstring
    • namestring
  • events_countinteger
  • sessions_countinteger
  • last_activity_atstring<date-time> | null
  • activeboolean

    An active contact in the last 365 days.

  • sourcestring | null

    Where the contact came from.

  • created_atstring<date-time>
  • hrefstring

    The contact in Sessionboard CRM.

  • stageobject | null

    The contact's pipeline stage; null when not in the pipeline.

    Show child attributes

    • idstring
    • labelstring

429

The token's request limit (100 requests per 15 minutes by default) or, for writes, its daily write quota. Wait Retry-After seconds.

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "success": true,
  "payload": {
    "contacts": [
      {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "name": "<string>",
        "email": "jane@example.com",
        "company": "<string>",
        "title": "<string>",
        "avatar_url": "<string>",
        "types": [
          "speaker"
        ],
        "tags": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ],
        "events_count": 123,
        "sessions_count": 123,
        "last_activity_at": "2026-01-15T09:30:00Z",
        "active": true,
        "source": "<string>",
        "created_at": "2026-01-15T09:30:00Z",
        "href": "<string>",
        "stage": {
          "id": "<string>",
          "label": "<string>"
        }
      }
    ],
    "total": 123,
    "page": 123,
    "per_page": 123,
    "facets": {
      "types": {
        "key": 123
      },
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "count": 123
        }
      ],
      "sources": [
        {
          "key": "<string>",
          "label": "<string>",
          "count": 123
        }
      ]
    }
  }
}

403

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "code": "<string>",
  "message": "<string>",
  "contact": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "email": "jane@example.com",
    "company": "<string>",
    "title": "<string>",
    "avatar_url": "<string>",
    "types": [
      "speaker"
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "events_count": 123,
    "sessions_count": 123,
    "last_activity_at": "2026-01-15T09:30:00Z",
    "active": true,
    "source": "<string>",
    "created_at": "2026-01-15T09:30:00Z",
    "href": "<string>",
    "stage": {
      "id": "<string>",
      "label": "<string>"
    }
  }
}

404

{
  "success": false,
  "error": "VALIDATION_ERROR",
  "code": "<string>",
  "message": "<string>",
  "contact": {
    "id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "name": "<string>",
    "email": "jane@example.com",
    "company": "<string>",
    "title": "<string>",
    "avatar_url": "<string>",
    "types": [
      "speaker"
    ],
    "tags": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "events_count": 123,
    "sessions_count": 123,
    "last_activity_at": "2026-01-15T09:30:00Z",
    "active": true,
    "source": "<string>",
    "created_at": "2026-01-15T09:30:00Z",
    "href": "<string>",
    "stage": {
      "id": "<string>",
      "label": "<string>"
    }
  }
}