Find user

Find a user by their ID

GET

/v1/users/{id}

GET

/users/{id}

curl -X GET "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required

Response

application/json200

id
string
required
type
enum<string>
required
One of:
employee
external
service_account
agent
email
string
required
personalEmail
string | null
required
name
string
required
idpStatus
enum<string> | null
required
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
required
One of:
active
terminated
pending
jobKey
string | null
required
countryCode
string | null
required
departmentKey
string | null
required
startDate
string<date-time> | null
required
terminationDate
string<date-time> | null
required
emails
UserEmail[]
required
job
HrJobEmbed | null
required
country
HrCountry | null
required
department
TeamEmbed | null
required
sources
UserSource[]
required
connectorId
string | null
required
The connector this user belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
customFields
map of any of
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/users/{id}

curl -X GET "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Find user - Corma Help Center | Productlane

API referenceUsers

Find user

Find a user by their ID

GET

/v1/users/{id}

GET

/users/{id}

curl -X GET "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
string
path
required

Response

application/json200

id
string
required
type
enum<string>
required
One of:
employee
external
service_account
agent
email
string
required
personalEmail
string | null
required
name
string
required
idpStatus
enum<string> | null
required
One of:
active
suspended
archived
deprovisioned
hrStatus
enum<string> | null
required
One of:
active
terminated
pending
jobKey
string | null
required
countryCode
string | null
required
departmentKey
string | null
required
startDate
string<date-time> | null
required
terminationDate
string<date-time> | null
required
emails
UserEmail[]
required
job
HrJobEmbed | null
required
country
HrCountry | null
required
department
TeamEmbed | null
required
sources
UserSource[]
required
connectorId
string | null
required
The connector this user belongs to: the id of its connection, which every connector route accepts. Null when no connector holds it.
customFields
map of any of
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/users/{id}

curl -X GET "https://api.corma.io/v1/users/{id}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "id": "string",
  "type": "employee",
  "email": "string",
  "personalEmail": "string",
  "name": "string",
  "idpStatus": "active",
  "hrStatus": "active",
  "jobKey": "string",
  "countryCode": "string",
  "departmentKey": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "terminationDate": "2026-01-15T09:30:00Z",
  "emails": [
    {
      "email": "string",
      "isPrimary": true,
      "sources": [
        {
          "type": "integration_sync_unit",
          "kind": "google",
          "method": "api",
          "syncUnitId": "string",
          "label": "string",
          "author": "string",
          "isOriginating": true,
          "createdAt": "2026-01-15T09:30:00Z",
          "lastUpdatedAt": "2026-01-15T09:30:00Z"
        }
      ],
      "sourceKind": "manual"
    }
  ],
  "job": {
    "key": "string",
    "display_name": "string"
  },
  "country": {
    "country_code": "string",
    "sources": [
      {
        "type": "integration_sync_unit",
        "kind": "google",
        "method": "api",
        "syncUnitId": "string",
        "label": "string",
        "author": "string",
        "isOriginating": true,
        "createdAt": "2026-01-15T09:30:00Z",
        "lastUpdatedAt": "2026-01-15T09:30:00Z"
      }
    ]
  },
  "department": {
    "key": "string",
    "displayName": "string"
  },
  "sources": [
    {
      "type": "corma",
      "kind": "extension",
      "author": "string",
      "isOriginating": true,
      "createdAt": "2026-01-15T09:30:00Z",
      "lastUpdatedAt": "2026-01-15T09:30:00Z"
    }
  ],
  "connectorId": "string",
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}