Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
action

/api/v1/action/fetch

GET
/api/v1/action/fetch
curl --request GET \
  --url 'https://dpg.example.com/api/v1/action/fetch?ownership_role=all&limit=20&offset=0&sort=recent' \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
action_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
action_type
Any of:
string
>= 1 characters
action_status
Any of:
string
>= 1 characters
item_id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
ownership_role
string
default: all
Allowed values: all initiated received
limit
integer
default: 20 >= 1 <= 100
offset
integer
0 <= 9007199254740991
sort
string
default: recent
Allowed values: recent oldest match_score distance
facets
Array<object>
object
field
required
string
>= 1 characters
values
required
Array<string>
>= 1 items

Header Parameters

Section titled “Header Parameters”
x-acting-org-id
string

Organization this request acts on behalf of. Optional: a non-admin actor can perform an action without acting for an org.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
meta
required
object
total
required
number
limit
required
number
offset
required
number
applied
required
object
sort
required
string
Allowed values: recent oldest match_score distance
statuses
required
Array<string>
types
required
Array<string>
facets
required
Array<object>
default:
object
field
required
string
>= 1 characters
values
required
Array<string>
>= 1 items
actions
required
Array<object>
object
action_type
required
string
partition_network
required
string
action_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
action_status
required
string
update_count
required
integer
>= -2147483648 <= 2147483647
source_item_network
required
string
source_item_domain
required
string
source_item_type
required
string
source_item_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
source_item_instance_url
required
string
source_item_owner
required
string
nullable
target_item_network
required
string
target_item_domain
required
string
target_item_type
required
string
target_item_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
target_item_instance_url
required
string
target_item_owner
required
string
nullable
performed_by_org_id
required
string
nullable
performed_by_service_user_id
required
string
nullable
requirements_snapshot
required
Any of:
Any of:
string
remarks
required
string
nullable
match_score
number
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time
ownership_roles
required
Array<string>
>= 1 items
Allowed values: initiated received
source_item_name
string
nullable
target_item_name
string
nullable
distance_m
number
nullable
Example
{
  "meta": {
    "applied": {
      "sort": "recent",
      "facets": []
    }
  },
  "actions": [
    {
      "requirements_snapshot": null,
      "ownership_roles": [
        "initiated"
      ]
    }
  ]
}