Get company teams

get/v1/public/teams

Request

Base URL
https://api.evolia.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/evolia/apis/public-evolia/docs/v1/public/teams/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

withDeletedboolean

if true, deleted teams are also returned

Response

uidstring required

unique team id

status'active' | 'deleted' required

Team status

namesobject required

Multilingual team name as a map indexed by locale ("en" or "fr")

codestring

The team code. The code is often used as a mapping value between Evolia and an external system

externalIdstring

The unique team externalId. The externalId is often used as a mapping value between Evolia and an external system

locationIdsstring[] required

Array of location UIDs linked to the team

skillIdsstring[] required

Array of skill UIDs linked to the team

customobject nullable

An optional object of custom properties. Current implementation only support string values

Example response

[
  {
    "names": {
      "en": "customer service",
      "fr": "service client"
    },
    "custom": {
      "key1": "value1",
      "key2": "value2"
    }
  }
]

Changes

No recorded changes to this operation across all 8 revisions of this API.