Structure Links

Fetch Structure Link

get/api/v1/structure_links/{id}

Request

  • Base URL
    https://your-subdomain.pinpointhq.com
  • URL
    https://your-subdomain.pinpointhq.com/api/v1/structure_links/{id}
  • Auth
    API key in header X-API-KEY

Query parameters

extra_fields[structure_links]StructureLinksExtraFields[]

Structure Link extra fields list

Include fields that are not always needed, or perhaps computationally expensive

includestring[]

Structure Link relationships available for inclusion

Include related resources

fields[structure_links]StructureLinksReadableAttribute[]

Structure Link readable attributes list

Include only specified fields of Structure Link in response

fields[locations]LocationsReadableAttribute[]

Location readable attributes list

Include only specified fields of Location in response

fields[departments]DepartmentsReadableAttribute[]

Department readable attributes list

Include only specified fields of Department in response

fields[divisions]DivisionsReadableAttribute[]

Division readable attributes list

Include only specified fields of Division in response

fields[structure_custom_group_ones]StructureCustomGroupOnesReadableAttribute[]

Structure Custom Group One readable attributes list

Include only specified fields of Structure Custom Group One in response

Response

OK: Structure Link resource

Changes

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