Approval Groups | Hitchhikers

ApprovalGroups: List

Lists all Approval Groups in the account.

path Parameters

accountId

required

string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"nextPageToken": "string",
"approvalGroups": [{"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}
]
}
}

Approval Groups: Create

Creates an Approval Group.

path Parameters

accountId

required

string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

name required	string Approval Group Name
users	Array of integers <int32> Array of user ids associated with the Approval Group
isDefault	boolean True if Approval Group is default for assignment of new tasks. Defaults to false.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"users": [0
],
"isDefault": true
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

ApprovalGroups: Get

Gets a single Approval Group.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}
}

ApprovalGroups: Update

Updates a single Approval Group.

NOTE: Despite using the PUT method, Approval Groups: Update only updates supplied fields. Omitted fields are not modified. However, the users list will be overwritten with what the user provides.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

id	string Approval Group ID
name	string Approval Group Name
users	Array of strings Array of user IDs associated with the Approval Group
isDefault	boolean true if Approval Group is default for assignment of new tasks. Defaults to false.

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"users": ["string"
],
"isDefault": true
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}

ApprovalGroups: Delete

Deletes an Approval Group.

path Parameters

accountId required	string
approvalGroupId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": { }
}