---
title: "List Structure Links"
method: GET
path: "/api/v1/structure_links"
tags: ["Structure Links"]
---

# List Structure Links

`GET /api/v1/structure_links`

## Query parameters

- `extra_fields[structure_links]` StructureLinksExtraFields[] — Structure Link extra fields list
- `include` string[] — Structure Link relationships available for inclusion
- `fields[structure_links]` StructureLinksReadableAttribute[] — Structure Link readable attributes list
- `fields[locations]` LocationsReadableAttribute[] — Location readable attributes list
- `fields[departments]` DepartmentsReadableAttribute[] — Department readable attributes list
- `fields[divisions]` DivisionsReadableAttribute[] — Division readable attributes list
- `fields[structure_custom_group_ones]` StructureCustomGroupOnesReadableAttribute[] — Structure Custom Group One readable attributes list
- `filter[division_id]` string — Division id filter
- `filter[location_id]` string — Location id filter
- `filter[department_id]` string — Department id filter
- `filter[structure_custom_group_one_id]` string — Structure custom group one id filter
- `sort` string[] — Structure Link sortable attributes
- `page[number]` integer
- `page[size]` integer
- `stats[total]` 'count'

## Response `200`

OK: Structure Links collection

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/pinpointhq/apis/pinpoint-external-api-reference.md) · [All operations](https://skmtc.net/pinpointhq/apis/pinpoint-external-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pinpointhq/pinpoint-external-api-reference/versions/da26e9683289/schema)
