Skip to main content

List all actions

GET 

/auth/actions

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

Request

Query Parameters

    category string

    Type of action to filter on.

    page[number] double

    Current page based on pagination settings.

    page[size] double

    Number of results to return per page based on pagination settings.

Responses

200: Successful response

Schema

    data

    object[]

  • Array [

  • 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.

  • ]

  • meta

    object

    total_pages double

    Total number of pages based on pagination settings

    total_results double

    Total number of results

    page_number double

    Current Page based on pagination settings (included when defaults are used.)

    page_size double

    Number of results to return per page based on pagination settings (included when defaults are used.)

401: Authentication error

Schema

    errors

    object[]

  • 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

Schema

    errors

    object[]

  • 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.

Schema

    errors

    object[]

  • 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.

  • ]

Loading...