GET Current Company

Returns the currently accessible company for the given token. Please note, the returned fields depend on the scopes that are enabled for your access token or API key.

GET /platform/api/companies/current

GET Current Company

cURL

curl --request GET \
  --url https://api.rippling.com/platform/api/companies/current \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "string",
  "address": {
    "city": "string",
    "streetLine1": "string",
    "zip": "string",
    "country": "string",
    "state": "string",
    "streetLine2": "string"
  },
  "workLocations": [
    {
      "id": "string",
      "nickname": "string",
      "address": {
        "city": "string",
        "streetLine1": "string",
        "zip": "string",
        "country": "string",
        "state": "string",
        "streetLine2": "string"
      }
    }
  ],
  "primaryEmail": "string",
  "phone": "string",
  "name": "string"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

OK

A company object as represented within Rippling.

id · string

address · Address · object

An address object as stored within Rippling.

Show child attributes

workLocations · WorkLocation · object[]

Show child attributes

primaryEmail · string

phone · string

name · string

entities · Entities · object

This model represents the legal entities inside of a given company. Legal entities based in Canada (CA) are currently supported at this time.

Show child attributes