Get CRM Home

GET/v1/organization/{orgId}/crm

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

The organization, contacts by type, tags and accounts; active contacts used against the plan (a rolling 365 days); the setup steps; the five most recent contacts; and what the Sessionboard platform adds. Reads only. Requires read:crm. Refused for a key restricted to particular events. Also at GET /v1/org/{orgId}/crm, and at GET /v1/crm with the organization taken from the token.

Request example

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

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

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

import requests

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

print(response.json())

<?php

$curl = curl_init();

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

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

echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://public-api.sessionboard.com/v1/organization/{orgId}/crm", 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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/crm"))
    .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

Response headers

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.

Responses

200`application/json`

successboolean
payloadCrmHome
Show child attributes
- orgobject
  Show child attributes
  - idstring
  - namestring
- countsobject
  Show child attributes
  - contactsinteger
  - by_typeobject
  - tagsinteger
  - accountsinteger
- active_contactsobject
  Show child attributes
  - usedinteger
  - limitinteger | null
  - window_daysinteger
    Example
    365
- setupobject
  Show child attributes
  - doneinteger
  - totalinteger
  - stepsobject[]
    Show child attributes
    keystring
    labelstring
    doneboolean
    hrefstring
- recentCrmContact[]
  Max items
  5
  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
- platformobject[]
  What the Sessionboard platform adds.
  Show child attributes
  - keystring
  - labelstring
  - detailstring

401

Missing, invalid or expired token.

403`application/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

404`application/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

{
  "success": true,
  "payload": {
    "org": {
      "id": "<string>",
      "name": "<string>"
    },
    "counts": {
      "contacts": 123,
      "by_type": {
        "key": 123
      },
      "tags": 123,
      "accounts": 123
    },
    "active_contacts": {
      "used": 123,
      "limit": 123,
      "window_days": 365
    },
    "setup": {
      "done": 123,
      "total": 123,
      "steps": [
        {
          "key": "<string>",
          "label": "<string>",
          "done": true,
          "href": "<string>"
        }
      ]
    },
    "recent": [
      {
        "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>"
        }
      }
    ],
    "platform": [
      {
        "key": "<string>",
        "label": "<string>",
        "detail": "<string>"
      }
    ]
  }
}

{
  "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>"
    }
  }
}

{
  "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>"
    }
  }
}