HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

Retrieve Specific Account Activities

Retrieves an Array of Activies by type

If {activity_type} is provided as part of the URL, category cannot be provided as query parameter. They are mutually exclusive.

Notes:

  • Pagination is handled using the page_token and page_size parameters.

  • page_token represents the ID of the end of your current page of results.
    for example if in your first response the id of the last Activiy item returned in the array was 20220203000000000::045b3b8d-c566-4bef-b741-2bf598dd6ae7, you'd pass that value as page_token to get the next page of results

  • If specified with a direction of desc, for example, the results will end before the activity with the specified ID.

  • If specified with a direction of asc, results will begin with the activity immediately after the one specified.

  • page_size is the maximum number of entries to return in the response.

  • If date is not specified, the default and maximum value is 100.

  • If date is specified, the default behavior is to return all results, and there is no maximum page size.

Path Params
string
enum
required

see ActivityType model for details about what the different types mean

Query Params
uuid

id of a single account to filter by

date-time

Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.

date-time

Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.

date-time

Both formats YYYY-MM-DD and YYYY-MM-DDTHH:MM:SSZ supported.

string
enum

The chronological order of response based on the submission time. asc or desc. Defaults to desc.

Allowed:
integer
1 to 100
Defaults to 100

The maximum number of entries to return in the response

string

The ID of the end of your current page of results

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible