Retrieve a specific site

GET

/sites/{api_name}/

Retrieve a specific site.

Required Scopes

• sites.read

Request

Path Parameters

api_name stringrequired
The unique api_name of the site.
Example: employee_portal

Responses

200

Successful response

application/json

Schema

Schema

__meta object
redacted_fields object[]
Array [
name string
The name for the redacted field
reason string
The reason for the redaction
]
id string
Identifier field
name string
The display name of the custom site
description string
The optional description of the custom site
api_name string
The unique api name of the custom site
logo string
A Rippling-owned logo URL for the custom site
current_bundle_id string
The active bundle id for the custom site
admin_group_id string
The admin group id for the custom site
viewer_group_id string
The viewer group id for the custom site
created_by string
The ID of the role that created the custom site
created_at string
Record creation date

Example (from schema)

{
  "__meta": {
    "redacted_fields": [
      {
        "name": "date_of_birth",
        "reason": "Insufficient entitlements"
      }
    ]
  },
  "id": "string",
  "name": "string",
  "description": "string",
  "api_name": "string",
  "logo": "string",
  "current_bundle_id": "string",
  "admin_group_id": "string",
  "viewer_group_id": "string",
  "created_by": "string",
  "created_at": "string"
}

Loading...