Departments

List all departments for your company.

get/v1/departments

Query parameters

limitstring

a number less than or equal to 100

a number less than or equal to 100

afterIdstring

The unique public id of the department

Example:dpt_1234

The unique public id of the department

beforeIdstring

The unique public id of the department

Example:dpt_1234

The unique public id of the department

Response

Success

hasMoreboolean required
countinteger required

an integer

Example response

{
  "data": [
    {
      "id": "dpt_1234",
      "name": "Engineering"
    }
  ]
}

Changes

Changed in 4 of the 20 revisions of this API.615

  • a896c17cf98841See the full diff
    • the response's body type/format changed from object/ to / for status 403

      response-body-type-changed

    • removed the required property _tag from the response with the 403 status

      response-required-property-removed

    • removed the required property message from the response with the 403 status

      response-required-property-removed

    • removed the required property requiredPermissions from the response with the 403 status

      response-required-property-removed

    • added MissingRequiredPermissions ApiNotEnabled to the response body anyOf list for the response status 403

      response-body-any-of-added

    • added the new company:workplaces enum value to the requiredPermissions/items/scope response property for the response status 403

      response-property-enum-value-added

    • the requiredPermissions/items/ response property's minItems was decreased from 2 to 0 for the response status 403

      response-property-min-items-decreased

    • the requiredPermissions/items/ response's property type/format changed from array/ to object/ for status 403

      response-property-type-changed

    • removed subschema #1 subschema #2 from the requiredPermissions/items/ response property 'prefixItems' list for the response status 403

      response-property-prefix-items-removed

    • added the required property requiredPermissions/items/level to the response with the 403 status

      response-required-property-added

    • added the required property requiredPermissions/items/scope to the response with the 403 status

      response-required-property-added

    • endpoint added

      endpoint-added