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>"
  ],
  "connectionStatus": "CONNECTED",
  "identitiesCount": 4503599627370495,
  "identities": [
    {
      "id": "<string>",
      "employeeId": "<string>",
      "email": "<string>",
      "groups": [
        "<string>"
      ],
      "roles": [
        "<string>"
      ],
      "licenses": [
        "<string>"
      ]
    }
  ],
  "recentEvents": [
    {
      "id": "<string>",
      "name": "USER_PROVISIONED",
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "employeeId": "<string>",
      "contextType": "ONBOARDING",
      "errorMessage": "<string>"
    }
  ],
  "contract": {
    "pricingMode": "per_licence",
    "currency": "EUR",
    "billingFrequency": "monthly",
    "flatRatePrice": 123,
    "unlicensedPricePerSeat": 123,
    "unlicensedMinimumSeatsBilled": 4503599627370495,
    "licenses": [
      {
        "remoteId": "<string>",
        "name": "<string>",
        "pricePerSeat": 123,
        "minimumSeatsBilled": 4503599627370495
      }
    ]
  },
  "finance": {
    "yearlyCost": 123,
    "unusedYearlyCost": 123,
    "unusedSeatsCount": 4503599627370495
  },
  "licenses": [
    {
      "remoteId": "<string>",
      "name": "<string>"
    }
  ]
}
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 used to map contract pricing lines with the SaaS licenses.