Get Contract Actions

Get a list of contract actions of an express account.

👍

Access and Registration

Authentication

🚧

If you're a reseller, please check how to get entitled to this API here.

Scope

express-accounts-contracts-actions:write

Body Response - Schema

200 OK

ParameterTypeDescription
countintegerThe number of results on the current page.
Example: 50
pageintegerThe number of the current page.
Example: 2
per_pageintegerThe number of results per page.
Example: 50
totalintegerThe total number of results for all pages.
Example: 425
total_pagesintegerThe total number of pages.
Example: 9
_embeddedobject"_embedded" subdivides into:

1 - "contract_actions" (array[object]).
1.1 - "id" (string) - The contract action ID. Example: 123245132132. Required.
1.2 - "action_type"(string) - The action type. Required.
NEWTDE: New subscription.
AMENDTDE: Amendment of the current subscription.
CANCELTDE: Cancellation of the subscription.
Allowed values: NEWTDE, AMENDTDE, CANCELTDE
Example: NEWTDE
1.3 - "quantity""(integer) - The number of licenses.
Example: 10
1.4 - "status" string)- The status of the contract action. Required.
Allowed values:
CREATED
IN_PROGRESS
COMPLETED
FAILED
Example:
CREATED
Example: ACTIVE

1.5 - "status_message"(string) - The contract action status message. Required.
Example: Contract action created successfully.

1.6 - "created_at"(string) - Creation timestamp. Required.
Example: 2022-03-10T16:15:50Z

1.7. - "updated_at"(string) -Update timestamp. Required.
Example: 2022-03-10T16:15:50Z
_linksobject"_links" subdivides into:

1 - "first" (object)
1.1 - "href" (string) - The link to the first page.

2. - "last" (object)
2.1 - "href" (string) - The link to the last page.

3. - "next" (object)
3.1 - "href" (string) - The link to the next page.

4. - "prev" (object)
4.1 - "href" (string) - The link to the previous page.

5. - "self" (object)
5.1 - "href" (string) - The link to the current page.

400 (bad request), 401 (unauthorized), 403 (forbidden)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fields array[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

👍

API Availability

The Talkdesk Express API is in GA since the 5th of July, 2024.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!