Skip to main content
GET
/
saas
/
{saasId}
Get a SaaS by ID
curl --request GET \
  --url https://api.getprimo.com/saas/{saasId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "tags": [
    "<string>"
  ],
  "identitiesCount": 4503599627370495,
  "identities": [
    {
      "id": "<string>",
      "employeeId": "<string>",
      "email": "<string>",
      "groups": [
        "<string>"
      ],
      "roles": [
        "<string>"
      ],
      "licenses": [
        "<string>"
      ],
      "issues": [
        {
          "id": "<string>",
          "groupId": "<string>",
          "roleId": "<string>",
          "licenseId": "<string>",
          "organizationUnitId": "<string>",
          "reason": "<string>",
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "recentEvents": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "employeeId": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "contract": {
    "flatRatePrice": 123,
    "unlicensedPricePerSeat": 123,
    "unlicensedMinimumSeatsBilled": 4503599627370495,
    "licenses": [
      {
        "id": "<string>",
        "pricePerSeat": 123,
        "minimumSeatsBilled": 4503599627370495
      }
    ]
  },
  "finance": {
    "yearlyCost": 123,
    "unusedYearlyCost": 123,
    "unusedSeatsCount": 4503599627370495
  },
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "rule": {
    "prompt": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getprimo.com/llms.txt

Use this file to discover all available pages before exploring further.

Key: Read Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

saasId
string
required

Response

default - application/json
id
string
required
name
string
required
tags
string[]
required
connectionStatus
enum<string>
required
Available options:
CONNECTED,
DISCONNECTED,
PENDING,
NOT_CONNECTED,
NOT_CONNECTABLE
identitiesCount
integer
required
Required range: 0 <= x <= 9007199254740991
identities
object[]
required
recentEvents
object[]
required

The 20 most synchronization-related recent events for this SaaS integration.

contract
object
required

Billing contract currently configured for this SaaS.

finance
object
required

Derived financial metrics computed from the configured contract.

licenses
object[]
required

SaaS license catalog — all available licenses for this SaaS application.

groups
object[]
required

All groups available in this SaaS application. Use id when provisioning.

roles
object[]
required

All roles available in this SaaS application. Use id when provisioning.

organizationUnits
object[]
required

All organization units available in this SaaS application. Use id when provisioning.

rule
object
required

Provisioning rule configured for this SaaS, or null if no rule has been authored yet.