Actions V1

Actions operations

List all actions

Returns a list of actions. Results are paginated to improve retrieval peformance. The meta data indicates how many total records exist.

SecuritybasicAuth or bearerAuth

Request

query Parameters

category	string Type of action to filter on.
page[number]	number <double> Current page based on pagination settings.
page[size]	number <double> Number of results to return per page based on pagination settings.

Responses

200

Successful response

Response Schema: application/json

	Array of objects (Action)
	object (Metadata)

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

422

Invalid parameters supplied in request. See HTTP response body for details.

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

get/auth/actions

Request samples

Response samples

application/json

{"data": [{"id": "7e610e23-d1f2-4f90-b5b7-3ddd7b32ad7c",
"category": "SMS",
"description": "Send messages",
"record_type": "action",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"
}
],
"meta": {"total_pages": 13,
"total_results": 13,
"page_number": 3,
"page_size": 1
}
}

Retrieve an action

Retrieves the details of an action.

SecuritybasicAuth or bearerAuth

Request

path Parameters

required

string

The id of the Action

Responses

200

Successful response

Response Schema: application/json

object (Action)

id	string uuid.
category	string Conceptual grouping for related Actions.
description	string Human readable identifier.
record_type	string Record type.
created_at	string Timestamp of resource creation.
updated_at	string Timestamp of last resource update.

401

Authentication error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

404

Resource not found

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

422

Invalid parameters supplied in request. See HTTP response body for details.

Response Schema: application/json

Array of objects (Error Base)

Array

code	string an application-specific error code, expressed as a stringified integer.
title	string a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
detail	string a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
pointer	string JSON pointer to the field which is causing the error.

get/auth/actions/{id}

Request samples

Response samples

application/json

{"data": {"id": "7e610e23-d1f2-4f90-b5b7-3ddd7b32ad7c",
"category": "SMS",
"description": "Send messages",
"record_type": "action",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"
}
}