# Rippling data models

> Explore Rippling’s core data models and how they relate to one another when using the REST API.

Explore Rippling’s core data models and how they relate to one another when using the REST API.

## Overview

A data model in Rippling represents a core business entity (such as an employee, worker, company, or department) and defines how that entity’s attributes are structured.

Rippling’s data models interact to establish organizational relationships and hierarchies beyond basic reporting chains. Understanding how these entities connect helps you query endpoints and build efficient API integrations.

* * *

## Requirements

-   The Rippling API SKU
-   An API token

* * *

## Core models

### User

A user is the authenticated persona for an employee at any given company. When the user is **active**, they will have one [worker](https://developer.rippling.com/documentation/rest-api/essentials/data-models#worker) record that has a status of `HIRED`, `ACTIVE`, or `ACCEPTED`.

There may be instances, however, when one user has multiple [worker](https://developer.rippling.com/documentation/rest-api/essentials/data-models#worker) records if they have been **re-hired into the same company**:

[React Flow](https://reactflow.dev/)

Press enter or space to select a node.You can then use the arrow keys to move the node around. Press delete to remove it and escape to cancel.

Press enter or space to select an edge. You can then press delete to remove it or escape to cancel.

The [user](https://developer.rippling.com/documentation/rest-api/reference/list-users) resource is modeled on the [SCIM core user](https://datatracker.ietf.org/doc/html/rfc7643#section-4.1) for standardization purposes.

#### User

# User

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**active** boolean

Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.

**username** string

The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.

**name** object

**formatted** string

The user's full name.

**given\_name** string

The given legal name of the user, or first name in most Western languages.

**middle\_name** string

The middle name(s) of the user.

**family\_name** string

The legal family name of the user, or last name in most Western languages.

**preferred\_given\_name** string

The preferred given name, or first name in most Western languages, by the user.

**preferred\_family\_name** string

The preferred family name, or last name in most Western languages, by the user.

**display\_name** string

The display name of the user using either the concatenated preferred given and family name or username depending on availability.

**emails** object\[\]

The user's email addresses.

-   Array \[
    

**value** string

A valid email address.

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the email.

**display** string

The display value of the email address.

-   \]
    

**phone\_numbers** object\[\]

The user's phone numbers.

-   Array \[
    

**value** string

The canonical global phone number pursuant to RFC3966.

**type** string

**Possible values:** \[`HOME`, `WORK`, `MOBILE`, `FAX`, `OTHER`\]

The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.

**display** string

The display value of the phone number.

-   \]
    

**addresses** object\[\]

The user's addresses.

-   Array \[
    

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the address.

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The country component, pursuant to SCIM RFC 7643 4.1.2.

-   \]
    

**photos** object\[\]

The user's photos.

-   Array \[
    

**value** string

The URL of the photo.

**type** string

**Possible values:** \[`PHOTO`, `THUMBNAIL`\]

The classification of the photo.

-   \]
    

**preferred\_language** string

The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.

**locale** string

The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.

**timezone** string

The User's current time zone in IANA database Olson format

**number** string

The permanent profile number of the user.

### Worker

A worker is a user who currently or has previously worked at the company. The worker represents the **period of work for a [user](https://developer.rippling.com/documentation/rest-api/essentials/data-models#user)**. On the worker object, you'll find references to other resources like `Department`, `Employment Type`, `Legal Entity`, and more.

#### Worker

# Worker

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**user\_id** string

The worker's associated user.

**user** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**active** boolean

Whether the user is able to access company resources, typically when they are in actively engaged with the company and not after off-boarding.

**username** string

The unique identifier across Rippling used by the User for direct authentication into their associated company. Globally unique.

**name** object

The user's name.

**formatted** string

The user's full name.

**given\_name** string

The given legal name of the user, or first name in most Western languages.

**middle\_name** string

The middle name(s) of the user.

**family\_name** string

The legal family name of the user, or last name in most Western languages.

**preferred\_given\_name** string

The preferred given name, or first name in most Western languages, by the user.

**preferred\_family\_name** string

The preferred family name, or last name in most Western languages, by the user.

**display\_name** string

The display name of the user using either the concatenated preferred given and family name or username depending on availability.

**emails** object\[\]

The user's email addresses.

-   Array \[
    

**value** string

A valid email address.

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the email.

**display** string

The display value of the email address.

-   \]
    

**phone\_numbers** object\[\]

The user's phone numbers.

-   Array \[
    

**value** string

The canonical global phone number pursuant to RFC3966.

**type** string

**Possible values:** \[`HOME`, `WORK`, `MOBILE`, `FAX`, `OTHER`\]

The classification of the phone number, pursuant to SCIM RFC 7643 4.1.2.

**display** string

The display value of the phone number.

-   \]
    

**addresses** object\[\]

The user's addresses.

-   Array \[
    

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the address.

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The country component, pursuant to SCIM RFC 7643 4.1.2.

-   \]
    

**photos** object\[\]

The user's photos.

-   Array \[
    

**value** string

The URL of the photo.

**type** string

**Possible values:** \[`PHOTO`, `THUMBNAIL`\]

The classification of the photo.

-   \]
    

**preferred\_language** string

The User's preferred written or spoken language in the same format of the HTTP Accept-Language header, pursuant to Section 5.3.5 of RFC7231.

**locale** string

The User's default location for purposes of localization of currency, date time format, or numerical representations pursuant to RFC5646.

**timezone** string

The User's current time zone in IANA database Olson format

**number** string

The permanent profile number of the user.

**is\_manager** boolean

Whether the worker is a manager

**manager\_id** string

The worker's manager.

**manager** circular(Worker)

**legal\_entity\_id** string

The worker's associated legal entity.

**legal\_entity** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**tax\_identifier** string

The tax identifier for the legal entity.

**country** object

The country the legal entity is based in.

**code** string required

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The code of the country.

**legal\_name** string

The legal name of the legal entity.

**entity\_level** string

**Possible values:** \[`PARENT`, `SUBSIDIARY`, `BRANCH`\]

The legal entity's level in a hierarchy. \* `PARENT`: The legal entity is considered the ultimate holding entity. \* `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. \* `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity.

**registration\_date** string

The registration date of the entity.

**mailing\_address** object

The mailing address of the legal entity.

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the address.

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The country component, pursuant to SCIM RFC 7643 4.1.2.

**physical\_address** object

The physical address of the legal entity, if it differs from the mailing address.

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the address.

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The country component, pursuant to SCIM RFC 7643 4.1.2.

**parent\_id** string

The parent legal entity.

**parent** object

The parent legal entity.

Expandable field

**management\_type** string

**Possible values:** \[`PEO`, `EOR`, `COR`\]

The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). \* `PEO`: The legal entity is considered a Professional Employment Organization (PEO). \* `EOR`: The legal entity is considered an Employer of Record (EOR).

**company\_id** string

The company or organization associated with the legal entity

**company** object

The company or organization associated with the legal entity

Expandable field

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**parent\_legal\_entity\_id** string

The company's ultimate holding entity.

**parent\_legal\_entity** object

The company's ultimate holding entity.

Expandable field

**legal\_entities\_id** string\[\] required

A list of the company's entities.

**legal\_entities** array required

A list of the company's entities.

Expandable field

**physical\_address** object

The physical address of the holding entity.

**type** string

**Possible values:** \[`HOME`, `WORK`, `OTHER`\]

The classification of the address.

**formatted** string

The formatted mailing address.

**street\_address** string

The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2..

**locality** string

The city or locality component.

**region** string

The state or region component, pursuant to SCIM RFC 7643 4.1.2.

**postal\_code** string

The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The country component, pursuant to SCIM RFC 7643 4.1.2.

**primary\_email** string

The email address used when registering this company.

**legal\_name** string

The legal name of the company.

**doing\_business\_as\_name** string

The doing business as name for the company.

**phone** string

The phone number for the company.

**name** string required

The name of the company.

**country** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The worker's country.

**start\_date** string

The start date of the worker.

**end\_date** string

The end date of the worker.

**number** integer

The worker's number within the organization.

**work\_email** string

The worker's associated work email address.

**personal\_email** string

The worker's associated personal email address.

**status** string

**Possible values:** \[`INIT`, `HIRED`, `ACCEPTED`, `ACTIVE`, `TERMINATED`\]

The worker's status within the organization.

**location** object

**type** string required

**Possible values:** \[`REMOTE`, `WORK`\]

The type of location.

**work\_location\_id** string required

The work location, if the worker isn't remote.

**employment\_type\_id** string

The worker's employment type.

**employment\_type** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**label** string required

The display label of the employment type.

**name** string

The name of the employment type for non-custom employment types.

**type** string

**Possible values:** \[`CONTRACTOR`, `EMPLOYEE`\]

The classification of the worker by the company. \* `CONTRACTOR`: Contractors are self-employed workers who provide services on a short-term or per-project basis and are not eligible for tax-withholding or benefits. \* `EMPLOYEE`: Employees are hired and managed by an employer, work under the employer's direct supervision and control, and are protected by law for wages and employment rights.

**compensation\_time\_period** string

**Possible values:** \[`HOURLY`, `SALARIED`\]

The compensation period for the employment type. \* `SALARIED`: Employees that are paid a fixed amount per year. \* `HOURLY`: Employees that are paid a wage per hour worked.

**amount\_worked** string

**Possible values:** \[`PART-TIME`, `FULL-TIME`, `TEMPORARY`\]

The amount worked for the employment type. \* `FULL-TIME`: Full-time is at least 30 hours per week. Full-time workers will typically be eligible for benefits. \* `PART-TIME`: Part-time is less than 30 hours per week. These workers may be eligible for benefits, depending on company settings and hours worked. \* `TEMPORARY`: These workers are hired on a temporary basis. You can specify how each worker with this employment type will be paid individually.

**gender** string

**Possible values:** \[`MALE`, `FEMALE`, `NONBINARY`, `UNDETERMINED`, `DIVERSE`, `DOES_NOT_APPLY`, `PREFER_NOT_TO_SAY`\]

The gender of the worker, if specified.

**date\_of\_birth** string

The worker's date of birth.

**race** string

**Possible values:** \[`BLACK`, `BROWN`, `CHINESE`, `EURASIAN`, `INDIAN`, `INDIGENOUS`, `MALAY`, `WHITE`, `YELLOW`, `NOT_INFORMED`, `OTHER`\]

The identified race of the worker, if specified.

**ethnicity** string

**Possible values:** \[`HISPANIC_OR_LATINO`, `WHITE`, `BLACK_OR_AFRICAN_AMERICAN`, `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER`, `ASIAN`, `AMERICAN_INDIAN_OR_ALASKA_NATIVE`, `TWO_OR_MORE_RACES`, `MIDDLE_EASTERN_OR_NORTH_AFRICAN`, `DECLINE_TO_SELF_IDENTIFY`, `AFRICAN`, `COLOURED`, `INDIAN`, `OTHER`, `PREFER_NOT_TO_SAY`\]

The identified ethnicity of the worker, if specified.

**citizenship** string

**Possible values:** \[`AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IQ`, `IR`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KR`, `XK`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `AN`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SY`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `US`, `UM`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`\]

The countries that the worker has citizenship in.

**compensation\_id** string

The compensation package for the worker.

**compensation** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**worker\_id** string

The worker's ID.

**worker** object

The worker's details.

Expandable field

**annual\_compensation** object

The worker's annual compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**annual\_salary\_equivalent** object

The worker's annual salary equivalent, for insurance purposes. It will be equal to the worker's annual compensation, except for owners that are receiving no cashcompensation.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**hourly\_wage** object

The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**monthly\_compensation** object

The worker's monthly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**on\_target\_commission** object

The worker's on-target commission.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**relocation\_reimbursement** object

The worker's hourly wage. This calculation assumes 40-hour work weeks for workers with fixed compensation.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**signing\_bonus** object

The worker's signing bonus.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**target\_annual\_bonus** object

The worker's target annual bonus amount.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**weekly\_compensation** object

The worker's weekly compensation. This calculation assumes 40-hour work weeks for workers with an hourly wage.

**currency\_type** string

The currency type, ex: USD, EUR, etc.

**value** number

The decimal amount for the currency.

**target\_annual\_bonus\_percent** number

The worker's target annual bonus as a percent of annual compensation.

**bonus\_schedule** string

The worker's bonus schedule.

**payment\_type** string

The payment type for an worker's compensation.

**payment\_terms** string

The payment terms for an worker's compensation.

**salary\_effective\_date** string

Salary effective date

**overtime\_exemption** string

**Possible values:** \[`EXEMPT`, `NON_EXEMPT`\]

The worker's overtime exemption status.

**department\_id** string

The worker's assigned department.

**department** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the department.

**parent\_id** string

The parent department.

**parent** object

The parent department.

Expandable field

**reference\_code** string

Reference code of the department.

**department\_hierarchy\_id** string\[\]

The identifier of departments in the department hierarchy ordered from parent department to child department.

**department\_hierarchy** array

List of departments in the department hierarchy. Refer department\_hierarchy\_ids for department hierarchy order.

Expandable field

**teams\_id** string\[\]

The worker's assigned teams.

**teams** object\[\]

The worker's assigned teams.

Expandable field

-   Array \[
    

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**parent\_id** string

The parent team

**parent** circular(Team)

**name** string required

The name of the team.

-   \]
    

**title** string

The worker's title.

**title\_effective\_date** string

Title effective date

**level\_id** string

The level of the worker.

**level** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the level. Must be unique within the company or organization.

**parent\_id** string

The parent level.

**parent** object

The parent level.

Expandable field

**global\_level** integer

Global level is used to track the seniority of levels. The higher up a level is placed on the page, the more senior and higher-ranked the level. Global level is used in workflows, policies, and reports that use the level attribute (e.g., you can use Level Lookup to set up a workflow that notifies the nearest person in an worker's management chain at or above the specified level).

**description** string

The description of the level.

**scope\_of\_responsibilities** string

The scope of responsibilities for the level.

**experience\_requirements** string

The experience requirements for the level.

**rank** integer

The rank of the level within its track.

**track\_id** string

The track associated with the level. Required during creation. Include global\_level when changing it.

**track** object

The track associated with the level, if it's not a global level.

Expandable field

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

The name of the track. Must be unique within the company or organization.

**is\_default** boolean

Whether this is the company's default track.

**order** integer

The one-based horizontal display order of the track.

**start\_global\_level** integer

The highest global level occupied by this track. Empty tracks return null.

**job\_function\_id** string

ID of the worker's job function.

**job\_function** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string

Displayed name of the job function

**termination\_details** object

**type** string

**Possible values:** \[`VOLUNTARY`, `INVOLUNTARY`, `RETIREMENT`, `DEATH`, `ABANDONMENT`, `OFFER_DECLINED`, `RESCIND`, `RENEGE`\]

The termination type indicates whether the termination was voluntary or involuntary.

**reason** string

This is a description that will be custom to each Rippling company.

**pay\_schedule\_id** string

The ID of the pay schedule currently associated with the worker.

**work\_schedule** object

The worker's scheduled working hours for each day of the week.

**property name\*** WorkScheduleDay

The scheduled working hours for a day of the week.

**hours** number

The number of scheduled working hours for the day.

**compensation\_grade** object

The compensation grade assigned to a worker.

**id** string

The compensation grade's unique identifier.

**label** string

The compensation grade's label.

**original\_start\_date** string

The worker's earliest start date across their employment history, excluding INIT roles.

**custom\_fields** undefined\[\]

Custom field values defined on the Employee object for this worker

Expandable field

**country\_fields** object

**us** object

Country-wise regional fields for USA

**ssn** string

Social Security Number (SSN) for US employees.

**ca** object

Country-wise regional fields for Canada

**sin** string

Social Insurance Number (SIN) for Canada employees.

**nz** object

Country-wise regional fields for New Zealand

**ird\_number** string

Inland Revenue Department (IRD) number for New Zealand employees.

**business\_partners\_id** string\[\]

Worker's assigned business partners unique identifiers. Returns an empty list (\[\]) if the worker has no business partners.

**business\_partners** object\[\]

Worker's assigned business partners. This field is only populated when explicitly requested via the expand parameter (e.g., ?expand=business\_partners). When expanded, returns an empty list (\[\]) if the worker has no business partners.

Expandable field

-   Array \[
    

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**business\_partner\_group\_id** string required

Identifier of business partner group the business parter is a part of

**business\_partner\_group** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**name** string required

Name used to identify business partner group

**domain** string

**Possible values:** \[`HR`, `IT`, `FINANCE`, `RECRUITING`, `OTHER`\]

Type of business partner group

**default\_business\_partner\_id** string

Id of Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

**default\_business\_partner** object

Optional default business partner worker to whom all employees will be mapped if not explicitly mapped to a business partner in the group.

Expandable field

**worker\_id** string required

Identifier of worker who is the business partner

**worker** circular(Worker)

**client\_group\_id** string

Identifier of group of workers associated with the business partner

**client\_group** object

**id** string required

Identifier field

**created\_at** string required

Record creation date

**updated\_at** string required

Record update date

**display\_name** string

The group's display name.

**name** string

The group's name.

**app\_owner\_id** string

The id of the group's app owner.

**group\_type** string

The group type

**sub\_group\_type** string

The sub group type

**read\_only** boolean

Whether the group is read only.

**description** string

The group's description.

**parent** string

The group's parent.

**mutually\_exclusive\_key** string

The group's mutually exclusive key

**cumulatively\_exhaustive\_default** boolean

Whether the group is the cumulatively exhaustive default

**include\_terminated** boolean

Whether the group include terminated roles

**allow\_non\_employees** boolean

Whether the group allows non employees

**can\_override\_role\_states** boolean

Whether the group can override role states

**priority** integer

The group's priority when calculating mutual exclusivity

**is\_invisible** boolean

Whether the group is invisible

**ignore\_prov\_group\_matching** boolean

Whether to ignore provisioning group matching when determining group membership

**client\_group\_member\_count** integer

Number of workers associated with the business partner

-   \]
    

* * *

## See also

-   [API tokens and permissions](https://developer.rippling.com/documentation/rest-api/essentials/api-tokens)

Source: https://developer.rippling.com/documentation/rest-api/essentials/data-models

> For the complete documentation index, see [llms.txt](https://developer.rippling.com/llms.txt). Public pages have a Markdown version at the same URL with .md added.