Departments

Get departments

get

Authorizations

Query parameters

eidsstring[]Optional

External ids

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/departments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 1,
    "Children": [
      {
        "Id": 1,
        "Name": "text",
        "ExternalId": "text",
        "ParentId": 1,
        "Children": [
          {
            "Id": 1,
            "Name": "text",
            "ExternalId": "text",
            "ParentId": 1,
            "Children": "[Circular Reference]",
            "IsTranslated": true,
            "Translation": {
              "TranslationProperties": [
                "text"
              ],
              "TranslationRequiredProperties": [
                "text"
              ],
              "Translations": [
                {
                  "Language": "text",
                  "Property": "text",
                  "TranslateValue": "text"
                }
              ]
            }
          }
        ],
        "IsTranslated": true,
        "Translation": {
          "TranslationProperties": [
            "text"
          ],
          "TranslationRequiredProperties": [
            "text"
          ],
          "Translations": [
            {
              "Language": "text",
              "Property": "text",
              "TranslateValue": "text"
            }
          ]
        }
      }
    ],
    "IsTranslated": true,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  }
]

Create department

post

Authorizations

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Idinteger · int32Optional

Namestring | nullableOptional

ExternalIdstring | nullableOptional

ParentIdinteger · int32 | nullableOptional

IsTranslatedbooleanOptional

Responses

201

Created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Client Error

application/json

500

Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v2/departments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 244

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": [
        {
          "Id": 1,
          "Name": "text",
          "ExternalId": "text",
          "ParentId": 1,
          "Children": [
            "[Circular Reference]"
          ],
          "IsTranslated": true,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          }
        }
      ],
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Get department

get

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/departments/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": [
        {
          "Id": 1,
          "Name": "text",
          "ExternalId": "text",
          "ParentId": 1,
          "Children": [
            "[Circular Reference]"
          ],
          "IsTranslated": true,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          }
        }
      ],
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Update department

put

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Idinteger · int32Optional

Namestring | nullableOptional

ExternalIdstring | nullableOptional

ParentIdinteger · int32 | nullableOptional

IsTranslatedbooleanOptional

Responses

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Client Error

application/json

500

Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/departments/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 244

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Delete department

delete

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v2/departments/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get department by external ID

get

Authorizations

Path parameters

idstringRequired

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/departments/{id}/external HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": [
        {
          "Id": 1,
          "Name": "text",
          "ExternalId": "text",
          "ParentId": 1,
          "Children": [
            "[Circular Reference]"
          ],
          "IsTranslated": true,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          }
        }
      ],
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}