Sign in

v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
placeholder resources

Fetch placeholder resource

Retrieves a single placeholder resource by its ID.

get/placeholder_resources/{placeholder_resource_id}

Path parameters

placeholder_resource_idinteger required

The ID of the placeholder resource.

Query parameters

fields'assignments' | 'custom_field_values'

A comma-separated list of additional fields to include in the response.

Response

The requested placeholder resource.

idinteger required

Unique identifier for the placeholder resource.

titlestring required

The name/title of the placeholder.

user_type_idinteger required

The numeric code that specifies the user/resource type.

guidstring uuid required

The globally unique identifier (GUID) for the resource.

rolestring nullable

The placeholder's role in the organization.

disciplinestring nullable

The placeholder's discipline.

locationstring nullable

The organizational location the placeholder belongs to.

displayNamestring required

The displayed name of the placeholder.

typestring required

The object type.

thumbnailstring uri nullable

A URL to the placeholder's image thumbnail.

abbreviationstring nullable

A short abbreviation for the placeholder.

colorstring nullable

The color associated with the placeholder in the UI.

created_atstring date-time required

The time of creation.

updated_atstring date-time required

The time of the last update.

billratenumber required

The user's billable rate. A value of -1 indicates the default rate.

Example response

{
  "id": 1543853,
  "title": "IT Admin",
  "guid": "337e802d-30b8-4abe-a021-0c66e64ba326",
  "displayName": "IT Admin",
  "type": "PlaceholderResource",
  "thumbnail": "https://assets.rm.smartsheet.com/images/it_admin.png",
  "abbreviation": "IT",
  "color": "Fuchsia",
  "created_at": "2022-03-22T18:56:10Z",
  "updated_at": "2022-04-05T19:47:27Z",
  "billrate": -1
}