Skip to main content
GET
/
v1
/
org
/
organizational-units
Get Organizational Units
curl --request GET \
  --url https://api.twine.se/v1/org/organizational-units \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
      "org_id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
      "deleted_at": "2021-06-01T12:00:00Z",
      "description": "The engineering team",
      "email": "[email protected]",
      "inserted_at": "2021-06-01T12:00:00Z",
      "name": "Engineering",
      "parent_id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
      "phone": "+46701234567",
      "properties": {
        "custom_properties": {},
        "description": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "email": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "phone": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "source_external_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "source_external_parent_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "tier": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ]
      },
      "tier": "team",
      "updated_at": "2021-06-01T12:00:00Z"
    }
  ],
  "pagination": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer token for authentication

Query Parameters

pagination
CursorPagination · object

Cursor pagination

filters
OrganizationalUnitFilter · object

Filter parameters for OrganizationalUnit Parameters for OrganizationalUnit filtering

select
enum<string>[]

Select fields for OrganizationalUnit Parameters for OrganizationalUnit field selection. Note: id is always returned.

Available options:
id,
org_id,
parent_id,
updated_at,
inserted_at,
tier,
name,
description,
properties
order
OrganizationalUnitOrder · object

Parameters for OrganizationalUnit ordering

Response

Response

A paginated list of OrganizationalUnits

data
OrganizationalUnit · object[]
required
pagination
CursorPaginationResult · object
required

Cursor pagination result