ContactType

What a Contact is, such as architect or site manager, and the slots an assignment's contacts fill. Deactivate a type instead of removing it.

Operations

GET/v2/contact-types/specGET/v2/contact-typesPOST/v2/contact-typesGET/v2/contact-types/{contactTypeUuid}PATCH/v2/contact-types/{contactTypeUuid}

---

OpenAPI Spec

GET

/v2/contact-types/spec

Get OpenAPI 3.1.0 spec for ContactType API

Responses

Returns OpenAPI 3.1.0 spec for ContactType API

Content-Type

application/json

{

}

GET

/v2/contact-types/spec

Playground

Samples

---

List ContactTypes

GET

/v2/contact-types

List ContactTypes

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

name

isSystem

deactivatedAt

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"isSystem": true,

  

  

  

"order": 0,

  

  

  

"deactivatedAt": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/contact-types

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

name

isSystem

deactivatedAt

createdAt

updatedAt

Samples

---

Create a new ContactType

POST

/v2/contact-types

Create a new ContactType

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"order": 0,

  

"deactivatedAt": "string"

}

Responses

ContactType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"isSystem": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string"

}

POST

/v2/contact-types

Playground

Server

Authorization

apiKey

Body

Samples

---

Get a ContactType

GET

/v2/contact-types/{contactTypeUuid}

Get a ContactType by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

contactTypeUuid*

Type

string

Required

Format

"uuid"

Responses

ContactType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"isSystem": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/contact-types/{contactTypeUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

contactTypeUuid*

Samples

---

Update a ContactType

PATCH

/v2/contact-types/{contactTypeUuid}

Update a ContactType by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

contactTypeUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"order": 0,

  

"deactivatedAt": "string"

}

Responses

ContactType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"isSystem": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"createdAt": "string",

  

"updatedAt": "string"

}

PATCH

/v2/contact-types/{contactTypeUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

contactTypeUuid*

Body

Samples

---