Global resources (v1)

Get a resource

get/api/v1/global_resources/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/global_resources/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The ID of the live resource to retrieve

Query parameters

include_referencing_action_idsboolean

Defaults to true. When false, referencing_action_ids is excluded from the response

typed_valueboolean

Defaults to false. When true, returns properly typed values (boolean, number, array, object) instead of strings

Response

Successful response

idinteger

Resource ID

namestring

Name of the resource

valuestring

Value of the resource. By default a string representation; use typed_value=true for properly typed values

team_idinteger

ID of team to which the resource belongs

folder_idinteger nullable

ID of folder to which the resource belongs

user_idinteger

ID of user associated with the resource

read_accessstring

Where this resource can be used (TEAM, GLOBAL, SPECIFIC_TEAMS)

shared_team_slugsstring[]

Teams' slugs where this resource can be used when read_access is SPECIFIC_TEAMS, otherwise empty

slugstring

An underscored representation of the resource name

created_atstring

When the resource was created

updated_atstring

When the resource was last updated

descriptionstring

Description of the resource

test_resource_enabledboolean

Whether the resource is enabled for using a test resource

test_resourceobject nullable

The test resource (value, created_at, updated_at), present only when test_resource_enabled is true

referencing_action_idsinteger[]

IDs of actions that reference the resource. Excluded when include_referencing_action_ids is false

Changes

No recorded changes to this operation across all 1 revision of this API.